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

method

string

required

Value: subscribe

params

object

required

Hide properties

channel

string

required

Value: instrument

execution_venue

string

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

include_tokenized_assets

boolean

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

snapshot

boolean

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

req_id

integer

Optional client originated request identifier sent as acknowledgment in the 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, falseFlag if asset is borrowable.

collateral_value

float

Valuation as margin collateral (if applicable).

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, workinprogressStatus 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 onlyInitial margin requirement (in percent).

marginable

boolean

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

position_limit_long

integer

Condition: On marginable pairs onlyLimit for long positions.

position_limit_short

integer

Condition: On marginable pairs onlyLimit 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_progressStatus of pair.

symbol

string

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

tick_size

float

deprecated

Deprecated: Use price_incrementMinimum price increment for new orders.

Unsubscribe

Request
Response

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.

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.

Trades Orders (Level 3)

⌘I

Public Channels

Trading

Account

System

Snapshot / Update

Unsubscribe

​Subscribe

​Snapshot / Update

​Unsubscribe

Subscribe

Snapshot / Update

Unsubscribe