Kraken · Schema
InstrumentEnvelope
InstrumentEnvelope schema from Kraken Spot WebSocket API v2
CryptocurrencyExchangeTradingMarket DataSpot TradingFuturesDerivativesStakingEarnNFTWebSocketFIXCustodyOTCPrime BrokerageEmbedOAuthPublic APIs
Properties
| Name | Type | Description |
|---|---|---|
| channel | string | |
| type | string | |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/kraken/refs/heads/main/json-schema/kraken-instrument-envelope-schema.json",
"title": "InstrumentEnvelope",
"description": "InstrumentEnvelope schema from Kraken Spot WebSocket API v2",
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"instrument"
],
"example": "instrument"
},
"type": {
"type": "string",
"enum": [
"snapshot",
"update"
],
"example": "snapshot"
},
"data": {
"type": "object",
"properties": {
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "OQCLML-BW3P3-BUCMWZ"
},
"status": {
"type": "string",
"example": "string"
},
"precision": {
"type": "integer",
"example": 1
},
"precision_display": {
"type": "integer",
"example": 1
},
"borrowable": {
"type": "boolean",
"example": true
},
"collateral_value": {
"type": "number",
"format": "double",
"example": 0.01
},
"margin_rate": {
"type": "number",
"format": "double",
"example": "0.01"
},
"multiplier": {
"type": "number",
"format": "double",
"example": 0.01
}
}
},
"example": []
},
"pairs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"example": "PI_XBTUSD"
},
"base": {
"type": "string",
"example": "string"
},
"quote": {
"type": "string",
"example": "string"
},
"status": {
"type": "string",
"example": "string"
},
"marginable": {
"type": "boolean",
"example": "0.01"
},
"has_index": {
"type": "boolean",
"example": true
},
"qty_min": {
"type": "string",
"example": "string"
},
"qty_increment": {
"type": "string",
"example": "string"
},
"qty_precision": {
"type": "integer",
"example": 1
},
"price_increment": {
"type": "string",
"example": "0.01"
},
"price_precision": {
"type": "integer",
"example": "0.01"
},
"cost_precision": {
"type": "integer",
"example": 1
},
"cost_min": {
"type": "string",
"example": "string"
},
"margin_initial": {
"type": "number",
"format": "double",
"example": "0.01"
},
"position_limit_long": {
"type": "integer",
"example": 1
},
"position_limit_short": {
"type": "integer",
"example": 1
}
}
},
"example": "XBTUSD"
}
},
"example": {}
}
},
"required": [
"channel",
"type",
"data"
]
}