Asset & entity search
Search assets, entities, and contract information.
Available data
- Returns
- Assets, entities, and contract information
- Market coverage
- Crypto and US and Hong Kong equities
- Query granularity
- Each query returns matching assets; when a name hits more than one, all matches are listed
Authentication
Query Parameters
query is required.
querystringqueryExampleAAPLrequiredSearch text.
All optional.
us_equity | hk_equity | kr_equity | uk_equity | jp_equity | crypto
limitintegerqueryExample5optionalResult cap; minimum 1, default 20, maximum 1000.
Response
Matches: asset_id, display_symbol, listing_id, market, match_confidence, …
asset_idstringExampleasset_aapl_common_stockMatched asset id
display_namestringExampleApple Inc.Display name
display_symbolstringExampleAAPLDisplay symbol / ticker
entity_idstringExampleentity_sec_cik_0000320193Linked entity id
instrument_idstringExampleinstrument_aapl_common_stockLinked instrument id
listing_idstringExamplelisting_aapl_xnasLinked listing id
venue_idstringExamplevenue_xnasLinked venue id
Standard market
match_confidencenumberExample1Match confidence (0–1)
matched_fieldstringExampletickerField that matched (e.g. ticker)
matched_valuestringExampleAAPLValue that matched
disambiguation_hintstring | nullHint when several matches are close; null when unambiguous
ok / no_data / …
empty_reasonstring | nullEmpty-result reason code
errorobject | nullError object; null on success
lineage_refs[]object[]Lineage refs (usually [] on the public body)
Response status and resolution information
actual_taskstringExamplesearchlistings / profile / resolve / search / …
route_reasonstringExampleexplicit_taskResolver route (e.g. gate_tradable_mapping, rest_profile, explicit_task)
Hints: market_data / onchain / events_news / fundamentals / news as maps ({ listing_id | entity_id | asset_id | deployment_id })
News binding: { asset_id } when mapped
asset_idstringExampleasset_aapl_common_stockAsset id for news binding
Events/news binding when mapped
entity_idstringExampleentity_sec_cik_0000320193Entity id for events/news
Fundamentals binding when mapped
entity_idstringExampleentity_sec_cik_0000320193Entity id for fundamentals
Market-data binding when mapped
listing_idstringExamplelisting_aapl_xnasListing id for market data
Unified object references
Object reference type
idstringExamplelisting_aapl_xnasCanonical object identifier
resolved / ambiguous / … (HTTP 200; not a transport failure)
source_refs[]object[]Upstream source refs