Instruments

Subscribe to reference data for all active assets and tradeable pairs

WSSws.kraken.com/v2instrument

The instrument channel provides a stream of reference data of all active assets and tradeable pairs.

It provides the symbol identifiers, precisions, trading parameters and rules.

Subscribe

Request

method · string · required

Value: subscribe

params · object · required

Hide properties

channel · string · required

Value: instrument

execution_venue · string

One of: international, bitnomial-exchange
Default: international

The execution venue for the instrument channel. If not included, defaults to international.

include_tokenized_assets · boolean

One of: false, true
Default: false

If true, include xStocks in the response, otherwise include crypto spot pairs only.

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: instrument

snapshot · boolean

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.

channel · string

Value: instrument

type · string

One of: snapshot, update

data · object

Hide properties

assets · object[]

A list of assets.

Hide properties

borrowable · boolean

One of: true, false

Flag if asset is borrowable.

collateral_value · float

Valuation as margin collateral (if applicable).

id · string

Asset identifier.

margin_rate · float

Interest rate to borrow the asset.

precision · integer

Maximum precision for asset ledger, balances.

precision_display · integer

Recommended display precision.

multiplier · float

Multiplier of the tokenised asset. Fixed conversion rate of the token.

class · string

Asset class (e.g. currency).

status · string

One of: depositonly, disabled, enabled, fundingtemporarilydisabled, withdrawalonly, workinprogress

Status of asset.

pairs · object[]

A list of pairs.

Hide properties

base · string

Asset identifier of the base currency.

quote · string

Asset identifier of the quote currency.

cost_min · float

Minimum cost (price * qty) for new orders.

cost_precision · integer

Maximum precision used for cost prices.

has_index · boolean

Whether the pair has an index available for example stop-loss triggers.

margin_initial · float

Condition: On marginable pairs only

Initial margin requirement (in percent).

marginable · boolean

One of: true, false

Whether the pair can be traded on margin.

position_limit_long · integer

Condition: On marginable pairs only

Limit for long positions.

position_limit_short · integer

Condition: On marginable pairs only

Limit for short positions.

price_increment · float

Minimum price increment for new orders.

price_precision · integer

Maximum precision used for order prices.

qty_increment · float

Minimum quantity increment for new orders.

qty_min · float

Minimum quantity (in base currency) for new orders.

qty_precision · integer

Maximum precision used for order quantities.

ws_display_price_precision · integer

Recommended display precision for prices in WebSocket feeds.

status · string

One of: cancel_only, delisted, limit_only, maintenance, online, post_only, reduce_only, work_in_progress

Status of pair.

symbol · string

Example: "BTC/USD"

The symbol of the currency pair.

tick_size · float · deprecated

Deprecated: Use price_increment

Minimum price increment for new orders.

Unsubscribe

Request

method · string · required

Value: unsubscribe

params · object · required

Hide properties

channel · string · required

Value: instrument

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: instrument

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.