> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kraken.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Instruments
> Subscribe to reference data for all active assets and tradeable pairs
WSS
ws.kraken.com/v2
instrument
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
Value: `subscribe`
Value: `instrument`
One of: `international`, `bitnomial-exchange`
Default: `international`
The execution venue for the instrument channel. If not included, defaults to `international`.
One of: `false`, `true`
Default: `false`
If `true`, include xStocks in the response, otherwise include crypto spot pairs only.
One of: `true`, `false`
Default: `true`
Request a snapshot after subscribing.
Optional client originated request identifier sent as acknowledgment in the response.
Value: `subscribe`
Value: `instrument`
Indicates if a snapshot is requested.
An advisory message, highlighting deprecated fields or upcoming changes to the channel.
Indicates if the request was successfully processed by the engine. One of: `true`, `false`
Error message. Condition: if `success` is `false`.
The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example: `2022-12-25T09:30:59.123456Z`
The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: `2022-12-25T09:30:59.123456Z`
Optional client originated request identifier sent as acknowledgment in the response.
## Snapshot / Update
The snapshot and update responses share the same schema.
Value: `instrument`
One of: `snapshot`, `update`
A list of assets.
One of: `true`, `false`
Flag if asset is borrowable.
Valuation as margin collateral (if applicable).
Asset identifier.
Interest rate to borrow the asset.
Maximum precision for asset ledger, balances.
Recommended display precision.
Multiplier of the tokenised asset. Fixed conversion rate of the token.
Asset class (e.g. `currency`).
One of: `depositonly`, `disabled`, `enabled`, `fundingtemporarilydisabled`, `withdrawalonly`, `workinprogress`
Status of asset.
A list of pairs.
Asset identifier of the base currency.
Asset identifier of the quote currency.
Minimum cost (price \* qty) for new orders.
Maximum precision used for cost prices.
Whether the pair has an index available for example stop-loss triggers.
Condition: On marginable pairs only
Initial margin requirement (in percent).
One of: `true`, `false`
Whether the pair can be traded on margin.
Condition: On marginable pairs only
Limit for long positions.
Condition: On marginable pairs only
Limit for short positions.
Minimum price increment for new orders.
Maximum precision used for order prices.
Minimum quantity increment for new orders.
Minimum quantity (in base currency) for new orders.
Maximum precision used for order quantities.
Recommended display precision for prices in WebSocket feeds.
One of: `cancel_only`, `delisted`, `limit_only`, `maintenance`, `online`, `post_only`, `reduce_only`, `work_in_progress`
Status of pair.
Example: `"BTC/USD"`
The symbol of the currency pair.
Deprecated: Use `price_increment`
Minimum price increment for new orders.
## Unsubscribe
Value: `unsubscribe`
Value: `instrument`
Optional client originated request identifier sent as acknowledgment in the response.
Value: `unsubscribe`
Value: `instrument`
Indicates if the request was successfully processed by the engine. One of: `true`, `false`
Error message. Condition: if `success` is `false`.
The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example: `2022-12-25T09:30:59.123456Z`
The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: `2022-12-25T09:30:59.123456Z`
Optional client originated request identifier sent as acknowledgment in the response.
```json Subscribe Request theme={null}
{
"method": "subscribe",
"params": {
"channel": "instrument"
},
"req_id": 79
}
```
```json Subscribe Response theme={null}
{
"method": "subscribe",
"req_id": 79,
"result": {
"channel": "instrument",
"snapshot": true,
"warnings": [
"tick_size is deprecated, use price_increment"
]
},
"success": true,
"time_in": "2023-09-26T16:49:20.962586Z",
"time_out": "2023-09-26T16:49:20.962630Z"
}
```
```json Snapshot theme={null}
{
"channel": "instrument",
"type": "snapshot",
"data": {
"assets": [
{
"id": "USD",
"status": "enabled",
"precision": 4,
"precision_display": 2,
"borrowable": true,
"collateral_value": 1.0,
"margin_rate": 0.015
},
{
"id": "BTC",
"status": "enabled",
"precision": 10,
"precision_display": 5,
"borrowable": true,
"collateral_value": 1.0,
"margin_rate": 0.01
},
{
"id": "XRP",
"status": "enabled",
"precision": 8,
"precision_display": 5,
"borrowable": true,
"collateral_value": 0.0,
"margin_rate": 0.02
}
],
"pairs": [
{
"symbol": "BTC/USD",
"base": "BTC",
"quote": "USD",
"status": "online",
"qty_precision": 8,
"qty_increment": 1e-08,
"price_precision": 1,
"cost_precision": 5,
"marginable": true,
"has_index": true,
"cost_min": 0.5,
"margin_initial": 0.2,
"position_limit_long": 250,
"position_limit_short": 200,
"tick_size": 0.1,
"price_increment": 0.1,
"qty_min": 0.0001
},
{
"symbol": "MATIC/GBP",
"base": "MATIC",
"quote": "GBP",
"status": "online",
"qty_precision": 8,
"qty_increment": 1e-08,
"price_precision": 4,
"cost_precision": 6,
"marginable": false,
"has_index": true,
"cost_min": 0.43,
"tick_size": 0.0001,
"price_increment": 0.0001,
"qty_min": 4.0
}
]
}
}
```
```json Update theme={null}
{
"channel": "instrument",
"type": "update",
"data": {
"assets": [
{
"id": "BTC",
"status": "enabled",
"precision": 10,
"precision_display": 5,
"borrowable": true,
"collateral_value": 1.0,
"margin_rate": 0.01
}
],
"pairs": []
}
}
```
```json Unsubscribe Request theme={null}
{
"method": "unsubscribe",
"params": {
"channel": "instrument"
},
"req_id": 79
}
```
```json Unsubscribe Response theme={null}
{
"method": "unsubscribe",
"req_id": 79,
"result": {
"channel": "instrument"
},
"success": true,
"time_in": "2023-09-26T16:49:20.962586Z",
"time_out": "2023-09-26T16:49:20.962630Z"
}
```