GateData.AI

Instrument detailsComing soon

Get instrument details and identifiers.

This data domain is coming soon. Documentation is available now for reading and integration planning. REST and MCP try-it are disabled until this domain launches — paths and parameters will not change at GA.
GET/api/v1/instruments/{instrument_id}
Domain
Asset & Entity
Level
Instrument
MCP tool

Available data

Returns
Instrument details and identifiers
Market coverage
Crypto and US and Hong Kong equities
Query granularity
One instrument per query; other contracts on the same asset are queried separately

Authentication

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

Query Parameters

Instrument positioning

Required.

instrument_idstringpathExampleinstrument_aapl_common_stockrequired

Canonical instrument identifier.

Response

metadataobject

Response status and resolution information

data_statusDataStatusExamplenot_ready

ready / ok / partial / no_data / not_ready (surface-specific)

limitations[]string[]Exampledata_not_ready

Known data limitations

object_refs[]object[]

Unified object references

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.