Instruments

{
    "method": "subscribe",
    "params": {
        "channel": "instrument"
    },
    "req_id": 79
}

{
    "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"
}

{
    "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
            }
        ]
    }
}

{
    "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": []
    }
}

{
    "method": "unsubscribe",
    "params": {
        "channel": "instrument"
    },
    "req_id": 79
}

{
    "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"
}

{
    "method": "subscribe",
    "params": {
        "channel": "instrument"
    },
    "req_id": 79
}

{
    "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"
}

{
    "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
            }
        ]
    }
}

{
    "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": []
    }
}

{
    "method": "unsubscribe",
    "params": {
        "channel": "instrument"
    },
    "req_id": 79
}

{
    "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"
}

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.

Request
Response

string

required

Value: subscribe

object

required

Hide properties

string

required

Value: instrument

string

One of: international, bitnomial-exchange
Default: internationalThe execution venue for the instrument channel. If not included, defaults to international.

boolean

One of: false, true
Default: falseIf true, include xStocks in the response, otherwise include crypto spot pairs only.

boolean

One of: true, false
Default: trueRequest a snapshot after subscribing.

integer

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

string

required

Value: subscribe

object

Hide properties

string

required

Value: instrument

boolean

Indicates if a snapshot is requested.

string[]

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

boolean

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

string

Error message. Condition: if success is false.

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

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

integer

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

Snapshot / Update

The snapshot and update responses share the same schema.

string

Value: instrument

string

One of: snapshot, update

object

Hide properties

object[]

A list of assets.

Hide properties

boolean

One of: true, falseFlag if asset is borrowable.

float

Valuation as margin collateral (if applicable).

string

Asset identifier.

float

Interest rate to borrow the asset.

integer

Maximum precision for asset ledger, balances.

integer

Recommended display precision.

float

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

string

Asset class (e.g. currency).

string

One of: depositonly, disabled, enabled, fundingtemporarilydisabled, withdrawalonly, workinprogressStatus of asset.

object[]

A list of pairs.

Hide properties

string

Asset identifier of the base currency.

string

Asset identifier of the quote currency.

float

Minimum cost (price * qty) for new orders.

integer

Maximum precision used for cost prices.

boolean

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

float

Condition: On marginable pairs onlyInitial margin requirement (in percent).

boolean

One of: true, falseWhether the pair can be traded on margin.

integer

Condition: On marginable pairs onlyLimit for long positions.

integer

Condition: On marginable pairs onlyLimit for short positions.

float

Minimum price increment for new orders.

integer

Maximum precision used for order prices.

float

Minimum quantity increment for new orders.

float

Minimum quantity (in base currency) for new orders.

integer

Maximum precision used for order quantities.

integer

Recommended display precision for prices in WebSocket feeds.

string

One of: cancel_only, delisted, limit_only, maintenance, online, post_only, reduce_only, work_in_progressStatus of pair.

string

Example: "BTC/USD"The symbol of the currency pair.

float

deprecated

Deprecated: Use price_incrementMinimum price increment for new orders.

Unsubscribe

Request
Response

string

required

Value: unsubscribe

object

required

Hide properties

string

required

Value: instrument

integer

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

string

required

Value: unsubscribe

object

Hide properties

string

required

Value: instrument

boolean

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

string

Error message. Condition: if success is false.

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

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

integer

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

⌘I

Public Channels

Trading

Account

System

Snapshot / Update

Unsubscribe

​Subscribe

​Snapshot / Update

​Unsubscribe

Subscribe

Snapshot / Update

Unsubscribe