For the complete documentation index, see llms.txt. This page is also available as Markdown.

SUBSCRIBE Book Ticker

UPDATE TIME

Real Time

Request

Field
Type
Required
Description

data

array of strings

Yes

Channel name in the format book-ticker:ASSET:INSTRUMENT_TYPE or book-ticker:INSTRUMENT_NAME. Example: book-ticker:ETH:OPTION or book-ticker:ETH-31MAR23-1350-C.

op

string

Yes

Operation code allowed values: subscribe unsubscribe

  • ASSET allowed values: ETH & BTC

  • INSTRUMENT_TYPE allowed values : OPTION PERPETUAL

Example

{
	"op":"subscribe", 
	"data": ["book-ticker:ETH-31MAR23-1350-C"]
}
{
	"op":"subscribe", 
	"data": ["book-ticker:ETH:OPTION"]
}

Response

Field
Type
Required
Description

data.timestamp

string

Yes

Update timestamp in UNIX timestamp in nanoseconds. Example: 1680249600000000000

data.tickers

array of objects

Yes

Ticker information.

data.tickers[].instrument_id

string

Yes

Instrument ID number. Example: 12

data.tickers[].instrument_name

string

Yes

Instrument name. Example: ETH-24DEC22-1250-C

data.tickers[].instrument_type

string

Yes

Type of instrument. Allowed values: OPTION PERPETUAL

data.tickers[].bid

object

Yes

Top bid details in ticker object format.

data.tickers[].ask

object

Yes

Top ask details in ticker object format.

channel

string

Yes

Channel name in the format ticker:ASSET:INSTRUMENT_TYPE or ticker:INSTRUMENT_NAME. Example: ticker:ETH:OPTION or ticker:ETH-31MAR23-1350-C.

Last updated

Was this helpful?