Files

3.8 KiB

Symbols

Rate limits

  • 1200 requests/min or 20 requests/sec per IP address. (weight = 2)

{% hint style="info" %} See more details in API Rate limits {% endhint %}

Request

{% tabs %} {% tab title="Websocket" %} Connect

WEBSOCKET [GATEWAY_WEBSOCKET_ENDPOINT]

Message

{
  "type": "symbols",
  "product_ids": [1, 2]
}

{% endtab %}

{% tab title="REST (GET)" %} GET [GATEWAY_REST_ENDPOINT]/query?type=symbols&product_type=spot {% endtab %}

{% tab title="REST (POST)" %} POST [GATEWAY_REST_ENDPOINT]/query

Message

{
  "type": "symbols",
  "product_ids": [1, 2, 3, 4],
  "product_type": "spot"
}

{% endtab %} {% endtabs %}

Request Parameters

ParameterTypeRequiredDescription
product_idsnumber[]NoAn array of product ids. Only available for POST and WS requests.
product_typestringNoType of products to return, must be:
"spot" | "perp".

Response

{% hint style="info" %} Note:

  • All products have are quoted against USDT0, except for product 0. {% endhint %}
{
    "status": "success",
    "data": {
        "symbols": {
            "WBTC": {
                "type": "spot",
                "product_id": 1,
                "symbol": "WBTC",
                "price_increment_x18": "1000000000000000000",
                "size_increment": "1000000000000000",
                "min_size": "4000000000000000",
                "maker_fee_rate_x18": "0",
                "taker_fee_rate_x18": "200000000000000",
                "long_weight_initial_x18": "900000000000000000",
                "long_weight_maintenance_x18": "950000000000000000",
                "max_open_interest_x18": null
            },
            "BTC-PERP": {
                "type": "perp",
                "product_id": 2,
                "symbol": "BTC-PERP",
                "price_increment_x18": "1000000000000000000",
                "size_increment": "1000000000000000",
                "min_size": "4000000000000000",
                "maker_fee_rate_x18": "0",
                "taker_fee_rate_x18": "200000000000000",
                "long_weight_initial_x18": "950000000000000000",
                "long_weight_maintenance_x18": "970000000000000000",
                "max_open_interest_x18": null
            }
        }
    },
    "request_type": "query_symbols"
}

Response fields

Symbols

All numerical values are returned as strings and scaled by 1e18.

Field nameDescription
typeProduct type, "spot" or "perp"
product_idProduct id
symbolProduct symbol
price_increment_x18Price increment, a.k.a tick size
size_incrementSize increment, in base units
min_sizeMinimum order size, in base units
maker_fee_rate_x18Maker fee rate, given as decimal rate
taker_fee_rate_x18Taker fee rate, given as decimal rate
long_weight_initial_x18Long initial margin weight, given as decimal
long_weight_maintenance_x18Long maintenance margin weight, given as decimal
max_open_interest_x18Maximum open interest, null if no limit