Entities and Rules

Entities and Rules

GET /v1/api/exchangeInfo

This endpoint returns 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

This is a public endpoint, authentication is not required.

Entities and Rules Response Message

Name	Type	Comments
server_utc_timestamp	integer	Time at which the message was generated by the API
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

Example

{
  "entities_and_rules_response": {
    "server_utc_timestamp": "1670245612022724",
    "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"]
      }
    ]
  }
}

Deliverable Info

GET /v1/api/deliverableInfo

This endpoint will return an array of all exchange deliverables.

An optional deliverable_id parameter can be added to the query string to request a single deliverable.

This is a public endpoint, authentication is not required.

Parameters

Name	Type	Comments
deliverable_id	integer	Optional - use to request a single deliverable

Deliverables Response Message

Name	Type	Comments
server_utc_timestamp	integer	Time at which the message was generated by the API
deliverables	Deliverable[]	see below

Deliverable Message

Name	Type	Comments
symbol	string	Instrument name e.g BTC-USD
deliverable_id	integer	unique deliverable id

Example

{
  "deliverables_response": {
    "server_utc_timestamp": "1670245694668667",
    "deliverables": [
      {
        "symbol": "ETH-20221216",
        "deliverable_id": "4837"
      },
      {
        "symbol": "BTC-20221216",
        "deliverable_id": "4836"
      },
      {
        "symbol": "ETH-20221223-2400C",
        "deliverable_id": "4834"
      }
    ]
  }
}