v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Market Data

Search for Instruments

Rate limit: 120 requests per 60 seconds. This is a shared quota — the same budget is consumed by a group of related endpoints, so calling any of them reduces what is left for the others (you cannot call each at the full rate independently). Endpoints sharing this quota:

  • GET /api/v1/market-data/exchanges
  • GET /api/v1/market-data/instrument-types
  • GET /api/v1/market-data/instruments
  • GET /api/v1/market-data/instruments/history/closing-price
  • GET /api/v1/market-data/instruments/rates
  • GET /api/v1/market-data/instruments/{instrumentId}/history/candles/{direction}/{interval}/{candlesCount}
  • GET /api/v1/market-data/stocks-industries

Retrieve a paginated list of instruments. Any field in the Instrument response schema can be projected via the required fields parameter and/or used as a query-string filter (e.g. fields=instrumentId,displayname&displayname=Bitcoin). Use pageSize/pageNumber to paginate and sort to order. Filters that do not match an indexed instrument field are ignored.

get/api/v1/market-data/search

Query parameters

pageSizeinteger

The number of results to return per page.

pageNumberinteger

The page number to retrieve for pagination.

fieldsstring required

A comma-separated list of fields to include in the response. Example: pop=popularityUniques7Day,displayname

sortstring

The field to sort by, with direction (asc/desc). Example: popularityUniques7Day desc

Headers

x-request-idstring uuid required
Example:31f04868-560d-454a-86f7-8135f7eba4bd

A unique request identifier.

x-api-keystring password required
Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required
Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Response

Successful response containing the list of instruments.

pageinteger

The current page number.

pageSizeinteger

The number of items per page.

totalItemsinteger

The total number of instruments matching the search criteria.