Symbols

Get info about available symbols and product configuration

Rate limits

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

See more details in API Rate limits

Request

Websocket

Connect

WEBSOCKET [GATEWAY_WEBSOCKET_ENDPOINT]

Message

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

REST (GET)

GET [GATEWAY_REST_ENDPOINT]/query?type=symbols&product_type=spot

REST (POST)

POST [GATEWAY_REST_ENDPOINT]/query

Message

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

Request Parameters

Parameter	Type	Required	Description
product_ids	number[]	No	An array of product ids. Only available for POST and WS requests.
product_type	string	No	Type of products to return, must be: "spot" | "perp".

Response

Note:

• All products have are quoted against USDC, except for product 0.

{
  "status": "success",
  "data": {
    "symbols": {
      "WETH": {
        "type": "spot",
        "product_id": 3,
        "symbol": "WETH",
        "price_increment_x18": "100000000000000000",
        "size_increment": "10000000000000000",
        "min_size": "100000000000000000",
        "min_depth_x18": "5000000000000000000000",
        "max_spread_rate_x18": "2000000000000000",
        "maker_fee_rate_x18": "0",
        "taker_fee_rate_x18": "300000000000000",
        "long_weight_initial_x18": "900000000000000000",
        "long_weight_maintenance_x18": "950000000000000000"
      },
      "WBTC": {
        "type": "spot",
        "product_id": 1,
        "symbol": "WBTC",
        "price_increment_x18": "1000000000000000000",
        "size_increment": "1000000000000000",
        "min_size": "10000000000000000",
        "min_depth_x18": "5000000000000000000000",
        "max_spread_rate_x18": "2000000000000000",
        "maker_fee_rate_x18": "0",
        "taker_fee_rate_x18": "300000000000000",
        "long_weight_initial_x18": "900000000000000000",
        "long_weight_maintenance_x18": "950000000000000000"
      }
    }
  },
  "request_type": "query_symbols"
}

Response fields

Symbols

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

Field name	Description
type	Product type, "spot" or "perp"
product_id	Product id
symbol	Product symbol
price_increment_x18	Price increment, a.k.a tick size
size_increment	Size increment, in base units
min_size	Minimum order size, in base units
min_depth_x18	Minimum depth to qualify for the Vertex Maker Program
max_spread_rate_x18	Maximum spread rate to qualify for the Vertex Maker Program, given as decimal rate
long_weight_initial_x18	Long initial margin weight, given as decimal
long_weight_maintenance_x18	Long maintenance margin weight, given as decimal

Learn more about the Vertex Maker Program here