HomeDocumentationAPI Reference
Log In
API Reference

Get Tickers

Method Name

public/get_tickers

Get tickers information (best bid / ask, stats, etc.) for a multiple instruments.

For options: currency is required and expiry_date is required.
For perps: currency is optional, expiry_date will throw an error.
For erc20s: currency is optional, expiry_date will throw an error.

For most up to date stream of tickers, use the ticker.<instrument_name>.<interval> channels.

Parameters

instrument_typestringrequired
erc20, option, or perp
enum erc20optionperp
currencystring
Underlying currency of asset (ETH, BTC, etc). Required for options.
expiry_datestring or integer
Expiry date in the form YYYYMMDD. Required for options.

Response

idstring or integerrequired
resultobjectrequired
result.tickersobjectrequired
Dictionary of tickers by channel

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}