Resolve asset objects

Resolve a name or ticker into a canonical asset.

POST/api/v1/assets/resolve
Domain
Asset & Entity
Level
Asset
MCP tool
assets_resolve (task=auto)

Available data

Returns
Resolve a name or ticker into a canonical asset
Market coverage
Crypto and US and Hong Kong equities
Query granularity
Each query resolves one input; when there are multiple matches, all are listed

Authentication

Send Authorization: Bearer YOUR_API_KEY or X-API-KEY on every request.

Query Parameters

Asset positioning

Provide at least one of query, asset_id, instrument_id, or listing_id.

querystringbodyExampleAAPLconditional

Ticker, name, or free text.

asset_idstringbodyExampleasset_btcconditional

Canonical asset id.

instrument_idstringbodyExampleinstrument_aapl_common_stockconditional

Instrument id.

listing_idstringbodyExamplelisting_aapl_xnasconditional

Listing id.

Resolution options

All optional.

marketMarketbodyExampleus_equityoptional

us_equity | hk_equity | kr_equity | uk_equity | jp_equity | crypto

chainstringbodyExampleethereumoptional

Chain disambiguation for crypto.

limitintegerbodyExample20optional

Candidate cap, 1–1000, default 20.

Response

data[]object[]

Matches: asset_id, display_symbol, listing_id, market, match_confidence, …

asset_idstringExampleasset_aapl_common_stock

Matched asset id

display_namestringExampleApple Inc.

Display name

display_symbolstringExampleAAPL

Display symbol / ticker

entity_idstringExampleentity_sec_cik_0000320193

Linked entity id

instrument_idstringExampleinstrument_aapl_common_stock

Linked instrument id

listing_idstringExamplelisting_aapl_xnas

Linked listing id

venue_idstringExamplevenue_xnas

Linked venue id

marketMarketExampleus_equity

Standard market

match_confidencenumberExample1

Match confidence (0–1)

matched_fieldstringExampleticker

Field that matched (e.g. ticker)

matched_valuestringExampleAAPL

Value that matched

disambiguation_hintstring | null

Hint when several matches are close; null when unambiguous

data_statusDataStatusExampleok

ok / no_data / …

empty_reasonstring | null

Empty-result reason code

errorobject | null

Error object; null on success

lineage_refs[]object[]

Lineage refs (usually [] on the public body)

metadataobject

Response status and resolution information

actual_taskstringExampleresolve

listings / profile / resolve / search / …

object_refs_validation_statusstringExamplenot_provided

not_provided when the client did not send object_refs

route_reasonstringExamplegate_tradable_mapping

Resolver route (e.g. gate_tradable_mapping, rest_profile, explicit_task)

domain_bindingsobject

Hints: market_data / onchain / events_news / fundamentals / news as maps ({ listing_id | entity_id | asset_id | deployment_id })

newsobject

News binding: { asset_id } when mapped

asset_idstringExampleasset_aapl_common_stock

Asset id for news binding

events_newsobject

Events/news binding when mapped

entity_idstringExampleentity_sec_cik_0000320193

Entity id for events/news

fundamentalsobject

Fundamentals binding when mapped

entity_idstringExampleentity_sec_cik_0000320193

Entity id for fundamentals

market_dataobject

Market-data binding when mapped

listing_idstringExamplelisting_aapl_xnas

Listing id for market data

object_refs[]object[]

Unified object references

typeObjectRefTypeExamplelisting

Object reference type

idstringExamplelisting_aapl_xnas

Canonical object identifier

resolution_statusResolutionStatusExampleresolved

resolved / ambiguous / … (HTTP 200; not a transport failure)

source_refs[]object[]

Upstream source refs

Errors & fallback

200
assets_resolve name multi-match; confirm from data[] candidates.
200
The object resolved but no data is available; empty_reason may be not_covered_by_source, unsupported_metric, or limited_depth.
400
Invalid parameters or an ambiguous market listing; ambiguity responses include required_params + candidates.
401
The API key is missing or invalid.
403
The current key scope or plan cannot access this data domain.
404
The requested resource does not exist; source coverage gaps are not 404 responses.
402
Credits or monthly quota exhausted.
429
Request rate exceeded; retry_after is returned in the body and Retry-After in the response headers.