Wealthnow
Sign up

API ReferenceAlt-Data

Status

Identifier crosswalk

GET/api/v3/reference/crosswalk/{symbol}
Plan
Pro and up
Price
3 credits per call
MCP tool
reference_crosswalk

IDENTITY CROSSWALK for one symbol — every identifier the security and its issuer carry, which rung matched, and how confident that match is. Returns SECURITY-grain identifiers (CUSIP9, CUSIP8, ISIN, SEDOL, ticker, estimate-vendor ticker) kept deliberately SEPARATE from the ISSUER-grain keys (gvkey, CUSIP6, regulator filer number, entity id), because those identify a company and not a share line; plus the issuer's other listed securities, the dated timeline of every identifier this security has ever been bound to, and the bridge into the private-company graph with that link's confidence grade. Call it to join two data sets that key on different identifiers, to translate a CUSIP-keyed holdings file into tickers, or to find out what a symbol used to be. as_of=YYYY-MM-DD resolves the symbol on the bindings IN FORCE on that date and returns the identifiers in force then, not today's — FB resolves today to an ETF, FB as_of=2020-01-01 to Meta, and as_of_resolution names both holders. A symbol shared by more than one current security is REFUSED with its candidate list rather than guessed; pass prefer_country to choose. A symbol the security master has never held is a 404 unknown_ticker. Coverage is a number in every response: what THIS answer contains, and the corpus census (securities, issuers, identifier bindings and issuers linked to the private graph, measured for the response). Identifier-history depth is uneven by construction — about half of the securities carry a prior ticker — and every source block states its own as-of, its age in days and whether that age is past its expected refresh cadence.

Parameters

Path

symbolstringRequired

Query

as_ofstringOptional

YYYY-MM-DD. Return the identifiers that were in force on that date instead of today's.

prefer_countrystringOptional

Disambiguation policy for a symbol shared by more than one current security, e.g. USA. Without it a shared symbol is REFUSED with its candidates.

include_historybooleanOptional

Include the dated identifier timeline.

Defaulttrue
include_share_classesbooleanOptional

Include the issuer's other securities.

Defaulttrue
include_private_graphbooleanOptional

Include the private-company-graph link.

Defaulttrue

Response

A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Reference Data). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.

A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.

Errors

No error is billed. The body is { "ok": false, "error", "detail", "request_id" }; read the code from error.

ErrorMeaning
400 invalid_tickerThe request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed.
401 unauthorizedMissing or invalid API key.
402 plan_requiredYour plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed.
403 scope_deniedThis API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed.
404 not_foundNo such resource. Not billed.
422 validationA parameter is missing, out of range or the wrong type; param names it. Not billed.
429 rate_limitedYour plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed.
503 paid_data_unavailableThe data could not be served completely right now; retry later. Not billed.
504 request_timeoutThe request ran past the server's time budget; retry. Not billed.

This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.

Guides

Read the Reference Data guide for this endpoint's fields and examples.