Skip to main content

Ticker

Real-time ticker updates for specific symbols.

tip

Use the ticker channel for tracking a single trading pair. To monitor all pairs at once, use the allTickers channel instead.

Subscribe Request:

{
"id": "12345",
"method": "subscribe",
"params": {
"channel": "ticker",
"symbol": "BTC-USDT",
"interval": "1day"
}
}

Request parameters

ParameterDescription
symbol (required)Trading pair symbol. Specify trading pair to get updates. See Get /api/v1/symbols for all currently available trading pairs.
interval (required)Specify time interval to get updates. Available values: 1min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 8hour, 12hour, 1day, 1week, 1month.

Response

Subscribe Response:

{
"id": "12345",
"result": {
"success": true
}
}

Subscription Push Example:

{
"method": "subscription",
"params": {
"channel": "ticker",
"interval": "1day",
"symbol": "BTC-USDT",
"data": {
"ticker": {
"symbol": "BTC-USDT",
"startTime": "2024-12-19T10:44:17.347Z",
"endTime": "2024-12-20T10:44:17.347Z",
"open": "50000.00",
"close": "51200.00",
"high": "51500.00",
"low": "49800.00",
"changeRate": "0.024",
"changePrice": "1200.00",
"baseVolume": "1234.56789",
"quoteVolume": "62500000.00",
"last": "51200.00"
}
}
}
}

Response Parameters

ParameterDescription
symbol (required)Trading pair. Type: string.
startTime (required)The start of the statistics window for this ticker update. Type: string.
endTime (required)The end of the statistics window for this ticker update. Type: string.
open (required)The opening price of the trading pair at the beginning of the specified time period. Type: string.
close (required)The closing price of the trading pair at the end of the specified time period. Type: string.
high (required)The highest price the trading pair reached within the specified time period. Type: string.
low (required)The lowest price the trading pair reached within the specified time period. Type: string.
changeRate (required)The change rate of the trading pair's price over the specified time period, expressed as a decimal fraction (e.g., "0.024" means +2.4%). Type: string.
changePrice (required)The price change of the trading pair over the specified time period. Type: string.
baseVolume (required)The total volume of the base currency traded within the specified time period. Type: string.
quoteVolume (required)The total volume of the quote currency traded within the specified time period. Type: string.
last (required)The last traded price of the trading pair. Type: string.