Ticker

Subscribe to level 1 market data (top of book and recent trades)

WSSws.kraken.com/v2ticker

The ticker channel streams level 1 market data, i.e. top of the book (best bid/offer) and recent trade data.

The feed accepts a list of symbols for subscription and the updates are generated on trade events.

Subscribe

Request

method · string · required

Value: subscribe

params · object · required

Hide properties

channel · string · required

Value: ticker

symbol · string[] · required

Example: ["BTC/USD", "MATIC/GBP"]

A list of currency pairs.

event_trigger · string

One of: bbo, trades
Default: trades

The book event that causes a new ticker update to be published on the channel.

• bbo: on a change in the best-bid-offer price levels.
• trades: on every trade.

snapshot · boolean

One of: true, false
Default: true

Request a snapshot after subscribing.

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.

Response

method · string · required

Value: subscribe

result · object

Hide properties

channel · string · required

Value: ticker

symbol · string · required

Example: "BTC/USD"

The currency pair associated with this subscription.

snapshot · boolean

One of: true, false

Indicates if a snapshot is requested.

warnings · string[]

An advisory message, highlighting deprecated fields or upcoming changes to the channel.

success · boolean

Indicates if the request was successfully processed by the engine. One of: true, false

error · string

Error message. Condition: if success is false.

time_in · string

The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

time_out · string

The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.

Snapshot / Update

The snapshot and update responses share the same schema. An update message is streamed on a trade event.

channel · string

Value: ticker

type · string

One of: snapshot, update

data · object[]

Hide properties

ask · float

Best ask price.

ask_qty · float

Best ask quantity.

bid · float

Best bid price.

bid_qty · float

Best bid quantity.

change · float

24-hour price change (in quote currency).

change_pct · float

24-hour price change (in percentage points).

high · float

24-hour highest trade price.

last · float

Last traded price (only guaranteed if traded within the past 24 hours).

low · float

24-hour lowest trade price.

symbol · string

Example: "BTC/USD"

The symbol of the currency pair.

timestamp · string

Format: RFC3339
Example: 2022-12-25T09:30:59.123456Z

The ticker data timestamp.

volume · float

24-hour traded volume (in base currency terms).

vwap · float

24-hour volume weighted average price.

Unsubscribe

Request

method · string · required

Value: unsubscribe

params · object · required

Hide properties

channel · string · required

Value: ticker

symbol · string[] · required

Example: ["BTC/USD", "MATIC/GBP"]

A list of currency pairs.

event_trigger · string

One of: bbo, trades
Default: trades

The book event that causes a new ticker update to be published on the channel.

• bbo: on a change in the best-bid-offer price levels.
• trades: on every trade.

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.

Response

method · string · required

Value: unsubscribe

result · object

Hide properties

channel · string · required

Value: ticker

symbol · string · required

Example: "BTC/USD"

The currency pair associated with this subscription.

event_trigger · string

One of: bbo, trades
Default: trades

The book event that causes a new ticker update to be published on the channel.

• bbo: on a change in the best-bid-offer price levels.
• trades: on every trade.

success · boolean

Indicates if the request was successfully processed by the engine. One of: true, false

error · string

Error message. Condition: if success is false.

time_in · string

The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

time_out · string

The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.