Entities and Rules

Entities and Rules Request

Message sent to fetch the list of all entities available for trading on the exchange.

tip

The response can be quite large and we advise API clients to cache it on their end

Entities and Rules Request Message

Name	Type	Comments
user_tag	string	Client defined tag used to identify the request

Example

{
  "entities_and_rules_request": {
    "user_tag": "unique_request_id"
  }
}

Entities and Rules Response

This message is sent in response to the entities and rules request message.

Entities and Rules Response Message

Name	Type	Comments
server_utc_timestamp	integer	Time at which the message was generated by the API
user_tag	string	Client defined tag used to identify the request
symbols	Symbol[]	see below

Symbol Message

Name	Type	Comments
symbol	string	Instrument name e.g BTC-USD
tradeable_entity_id	integer	unique instrument id
status	string	active / suspended
base_asset	string
quote_asset	string
minimum_quantity	float
maximum_quantity	float
minimum_value	float
maximum_value	float
quantity_step	float
price_step	float
tags	string[]	An array of tags used to classify the type of data

Examples

Spot

{
  "entities_and_rules_response": {
    "server_utc_timestamp": "1637577603616450",
    "user_tag": "unique_request_id",
    "symbols": [
      {
        "symbol": "BTC-USD",
        "tradeable_entity_id": "4",
        "status": "active",
        "base_asset": "BTC",
        "quote_asset": "USD",
        "minimum_quantity": "0.0001",
        "maximum_quantity": "100.0",
        "minimum_value": "0.00001",
        "maximum_value": "100000000.0",
        "quantity_step": "0.0001",
        "price_step": "0.1",
        "tags": ["spot"]
      }
    ]
  }
}

Option

{
  "entities_and_rules_response": {
    "server_utc_timestamp": "1637577603616450",
    "user_tag": "unique_request_id",
    "symbols": [
      {
        "symbol": "BTC-20230929-16000C",
        "tradeable_entity_id": "3637",
        "status": "active",
        "base_asset": "BTC-20230929-16000C",
        "quote_asset": "USD",
        "minimum_quantity": "0.0001",
        "maximum_quantity": "100.0",
        "minimum_value": "0.0005",
        "maximum_value": "100000000.0",
        "quantity_step": "0.0001",
        "price_step": "5.0",
        "tags": ["BTC", "option", "month"]
      }
    ]
  }
}

Future

{
  "entities_and_rules_response": {
    "server_utc_timestamp": "1637577603616450",
    "user_tag": "unique_request_id",
    "symbols": [
      {
        "symbol": "ETH-20221216",
        "tradeable_entity_id": "4826",
        "status": "active",
        "base_asset": "ETH-20221216",
        "quote_asset": "USD",
        "minimum_quantity": "0.001",
        "maximum_quantity": "1000.0",
        "minimum_value": "0.00005",
        "maximum_value": "100000000.0",
        "quantity_step": "0.001",
        "price_step": "0.05",
        "tags": ["ETH", "future", "week"]
      }
    ]
  }
}

Perpetual

{
  "entities_and_rules_response": {
    "server_utc_timestamp": "1637577603616450",
    "user_tag": "unique_request_id",
    "symbols": [
      {
        "symbol": "BTC-USD-PERPETUAL",
        "tradeable_entity_id": "13",
        "status": "active",
        "base_asset": "BTC-USD-PERPETUAL",
        "quote_asset": "USD",
        "minimum_quantity": "0.0001",
        "maximum_quantity": "100.0",
        "minimum_value": "0.00001",
        "maximum_value": "100000000.0",
        "quantity_step": "0.0001",
        "price_step": "0.1",
        "tags": ["BTC", "perpetual_future", "perpetual"]
      }
    ]
  }
}