API ReferenceAlt-Data
Crosswalk (batch)
/api/v3/reference/batch- Plan
- Pro and up
- Price
- 3 credits per call
- MCP tool
reference_batch
BATCH CROSSWALK — up to 100 symbols resolved in ONE pass, each returning its current identifiers (CUSIP9, CUSIP8, ISIN, SEDOL, ticker, estimate-vendor ticker), its issuer keys (gvkey, CUSIP6, regulator filer number), which rung matched and its status. This is the endpoint for mapping a whole portfolio or watchlist in a single call rather than N of them. Every symbol comes back with an explicit status — resolved, historical (renamed or delisted; the security and what it trades as now are both returned), ambiguous (shared by more than one current security: the candidates are listed and NO identity is guessed) or unknown (not carried). Symbols beyond the 100 limit come back as explicit over_limit entries, never silently dropped, and the response reports how many of the requested symbols resolved as a number and a percentage (measured 2026-08-02 on a 102-symbol large-cap list: 100 looked up, 99 resolved, 1 historical, 2 over_limit).
Parameters
Query
symbolsstringRequiredComma-separated symbols, up to 100.
prefer_countrystringOptionalDisambiguation policy for shared symbols, e.g. USA.
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_; read the code from error.
| Error | Meaning |
|---|---|
400 invalid_ticker | The 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 unauthorized | Missing or invalid API key. |
402 plan_required | Your 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_denied | This 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_found | No such resource. Not billed. |
422 validation | A parameter is missing, out of range or the wrong type; param names it. Not billed. |
429 rate_limited | Your plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed. |
503 paid_ | The data could not be served completely right now; retry later. Not billed. |
504 request_timeout | The 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.