> ## Documentation Index
> Fetch the complete documentation index at: https://docs.idax.exchange/llms.txt
> Use this file to discover all available pages before exploring further.

# CMC

# \[Section A] Spot trading data

## 24h summary

<Note type="info">
  **`GET`** `https://openapi.idax.exchange/v2/pub/summary`
</Note>

**Query parameters:** None

### Response parameters:

| Name               | Type    | Example | Description                     |
| ------------------ | ------- | ------- | ------------------------------- |
| code               | string  |         |                                 |
| msg                | string  |         |                                 |
| data               | object  |         |                                 |
| data.symbol        | object  |         |                                 |
|   ├─ id            | integer | `46`    | Token ID                        |
|   ├─ isFrozen      | string  | `0`     | Whether frozen                  |
|   ├─ last          | string  | `98000` | Latest price                    |
|   ├─ high24hr      | string  | `98000` | 24h high                        |
|   ├─ low24hr       | string  | `98000` | 24h lowest price                |
|   ├─ quoteVolume   | string  | `0`     | 24h volume                      |
|   ├─ baseVolume    | string  | `0`     | 24h transactions                |
|   ├─ percentChange | string  | `0`     | Percent change                  |
|   ├─ lowestAsk     | string  | `0`     | 24h seller's lowest price       |
|   ├─ highestBid    | string  | `0`     | 24h buyer's highest price       |
| coins              | object  |         |                                 |
|   ├─ name          | string  | `USDT`  | Currency name                   |
|   ├─ withdrew      | string  | `ON`    | Whether withdrawals are enabled |
|   ├─ deposit       | string  | `ON`    | Whether deposits are enabled    |

<Tabs>
  <Tab title="200">
    ```json theme={"system"}
    {
        "msg": "success",
        "code": "200",
        "data": {
            "ETH_USDT": {
                "high24hr": "238.2",
                "percentChange": "0",
                "last": "238.2",
                "highestBid": "0",
                "id": 47,
                "quoteVolume": "0",
                "isFrozen": "0",
                "baseVolume": "0",
                "lowestAsk": "0",
                "low24hr": "238.2"
            },
            "BCH_USDT": {
                "high24hr": "1",
                "percentChange": "0",
                "last": "1",
                "highestBid": "0",
                "id": 49,
                "quoteVolume": "0",
                "isFrozen": "0",
                "baseVolume": "0",
                "lowestAsk": "0",
                "low24hr": "1"
            }
        },
        "coins": {
            "MATIC": {
                "withdrew": "ON",
                "name": "MATIC",
                "deposit": "ON"
            },
            "FAIR": {
                "withdrew": "ON",
                "name": "FAIR",
                "deposit": "ON"
            }
        }
    }
    ```
  </Tab>
</Tabs>

***

## List of currencies

<Note type="info">
  **`GET`** `https://openapi.idax.exchange/v2/pub/asset`
</Note>

**Query parameters:** None

### Response parameters:

| Name                     | Type    | Example                                      | Description                          |
| ------------------------ | ------- | -------------------------------------------- | ------------------------------------ |
| name                     | string  | `Bitcoin`                                    | Currency name                        |
| unified\_cryptoasset\_id | integer | `1`                                          | Currency ID                          |
| can\_withdraw            | integer | `1`                                          | Whether withdrawal is enabled        |
| can\_deposit             | integer | `1`                                          | Whether deposit is enabled           |
| min\_withdraw            | number  | `0.2000000000000000`                         | Minimum value of a single withdrawal |
| max\_withdraw            | number  | `120.0000000000000000`                       | Maximum value of a single withdrawal |
| maker\_fee               | number  | `0.00100000`                                 | Maker fee                            |
| taker\_fee               | number  | `0.00100000`                                 | Taker fee                            |
| contractAddress          | string? | `0xA64455a4553C9034236734FadDAddbb64aCE4Cc7` | Contract address of token            |

<Tabs>
  <Tab title="200">
    ```json theme={"system"}
    {
        "BTC": {
            "max_withdraw": 120.0000000000000000,
            "maker_fee": 0.00100000,
            "name": "Bitcoin",
            "taker_fee": 0.00100000,
            "can_withdraw": 1,
            "can_deposit": 1,
            "unified_cryptoasset_id": 1,
            "min_withdraw": 0.2000000000000000
        },
        "ATC": {
            "max_withdraw": 100000.0000000000000000,
            "maker_fee": 0.00100000,
            "name": "ATC",
            "taker_fee": 0.00100000,
            "can_withdraw": 1,
            "can_deposit": 1,
            "unified_cryptoasset_id": 1465,
            "min_withdraw": 50.0000000000000000
        }
    }
    ```
  </Tab>
</Tabs>

***

## Coin quotes

<Note type="info">
  **`GET`** `https://openapi.idax.exchange/v2/pub/ticker`
</Note>

**Query parameters:** None

### Response parameters:

| Name              | Type    | Example                  | Description            |
| ----------------- | ------- | ------------------------ | ---------------------- |
| base\_id          | integer | `50`                     | Base currency ID       |
| quote\_id         | integer | `49`                     | Quote currency ID      |
| last\_price       | number  | `98000.0000000000000000` | Last transaction price |
| base\_volume      | number  | `0.1020408100000000`     | Last volume            |
| quote\_volume     | number  | `0.0000010412327551`     | Last turnover          |
| 24\_base\_volume  | string  | `0.000000`               | 24h volume             |
| 24\_quote\_volume | string  | `0.0000000000`           | 24h turnover           |

<Tabs>
  <Tab title="200">
    ```json theme={"system"}
    {
        "ETH_BTC": {
            "24_base_volume": "0.0000",
            "base_id": 51,
            "quote_volume": 46.6795548917722849,
            "quote_id": 50,
            "base_volume": 2.0000000000000000,
            "24_quote_volume": "0.0000",
            "last_price": 0.0428453100000000
        },
        "BTC_USDT": {
            "24_base_volume": "0.000000",
            "base_id": 50,
            "quote_volume": 0.0000010412327551,
            "quote_id": 49,
            "base_volume": 0.1020408100000000,
            "24_quote_volume": "0.0000000000",
            "last_price": 98000.0000000000000000
        }
    }
    ```
  </Tab>
</Tabs>

***

## Disc data

<Note type="info">
  **`GET`** `https://openapi.idax.exchange/v2/pub/orderbook`
</Note>

### Query parameters:

| Name   | Type    | Description                                                                      |
| ------ | ------- | -------------------------------------------------------------------------------- |
| base   | string  | Base currency                                                                    |
| quote  | string  | Quote currency                                                                   |
| symbol | string  | Token name (not required if `base` and `quote` are provided, otherwise required) |
| depth  | integer | Precision: `0` = 0.01, `1` = 0.1, `2` = 0. Default is `0`                        |
| bids   | integer | Number of buy orders to return. Default is `100`                                 |
| asks   | integer | Number of sell orders to return. Default is `100`                                |

### Response parameters:

| Name | Type           | Example                    | Description                                            |
| ---- | -------------- | -------------------------- | ------------------------------------------------------ |
| date | integer(int64) | `1766991308472`            | Unix timestamp (ms) of the last update                 |
| bids | array          | `[[1000,0.1], [2000,0.2]]` | Array of `[price, quantity]` pairs for each buy order  |
| asks | array          | `[[2000,0.2], [3000,0.3]]` | Array of `[price, quantity]` pairs for each sell order |

<Tabs>
  <Tab title="200">
    ```json theme={"system"}
    {
        "date": 1766991308472,
        "asks": [
            [196000, 0.46938777],
            [197001.86, 0.1]
        ],
        "bids": [
            [196000, 0.46938777],
            [197001.86, 0.1]
        ]
    }
    ```
  </Tab>
</Tabs>

***

## List of deals

<Note type="info">
  **`GET`** `https://openapi.idax.exchange/v2/pub/trades`
</Note>

### Query parameters:

| Name   | Type    | Description                                                                      |
| ------ | ------- | -------------------------------------------------------------------------------- |
| base   | string  | Base currency                                                                    |
| quote  | string  | Quote currency                                                                   |
| symbol | string  | Token name (not required if `base` and `quote` are provided, otherwise required) |
| trades | integer | Number of trades to return. Default is `100`                                     |

### Response parameters:

| Name          | Type           | Example                  | Description           |
| ------------- | -------------- | ------------------------ | --------------------- |
| trade\_id     | integer(int64) | `52594124`               | Transaction ID        |
| price         | number         | `98000.0000000000000000` | Transaction price     |
| type          | string         | `BUY`                    | Order direction       |
| timestamp     | integer(int64) | `1762965571597`          | Transaction timestamp |
| base\_volume  | number         | `0.1020408100000000`     | Volume                |
| quote\_volume | number         | `0.0000010412327551`     | Turnover              |

<Tabs>
  <Tab title="200">
    ```json theme={"system"}
    [
        {
            "trade_id": 52594124,
            "price": 98000.0000000000000000,
            "quote_volume": 0.0000010412327551,
            "base_volume": 0.1020408100000000,
            "type": "BUY",
            "timestamp": 1762965571597
        },
        {
            "trade_id": 52594123,
            "price": 35000.0000000000000000,
            "quote_volume": 7000.00000000000000,
            "base_volume": 0.2000000000000000,
            "type": "SELL",
            "timestamp": 1762965519813
        }
    ]
    ```
  </Tab>
</Tabs>

# \[Section B] Futures trading data

## Contracts

<Note type="info">
  **`GET`** `https://futuresopenapi.idax.exchange/pub/contracts`
</Note>

### Query parameters:

| Name       | Type    | Example        | Description                                                  |
| ---------- | ------- | -------------- | ------------------------------------------------------------ |
| ticker\_id | string? | "BTC-PERPUSDT" | Ticker ID of a futures pair (Will return all pairs if empty) |

### Response parameters:

| Name | Type                           | Example   | Description             |
| ---- | ------------------------------ | --------- | ----------------------- |
| code | string                         | `0`       | Response status code    |
| msg  | string                         | `success` | Response status message |
| data | object (Check the table below) | `{}`      | Response data           |

| Name                           | Type   | Example          | Description                                                                |
| ------------------------------ | ------ | ---------------- | -------------------------------------------------------------------------- |
| ticker\_id                     | string | `CFX-PERPUSDT`   | Contract ticker ID                                                         |
| base\_currency                 | string | `CFX`            | Base asset                                                                 |
| quote\_currency                | string | `USDT`           | Quote asset                                                                |
| last\_price                    | string | `0.04806`        | Latest price                                                               |
| base\_volume                   | string | `3453464`        | 24 hour trading volume in base currency                                    |
| quote\_volume                  | string | `3634654575`     | 24 hour trading volume in quote currency                                   |
| volume\_usd                    | string | `354364456.3454` | 24 hour trading volume in USD                                              |
| bid                            | string | `3543`           | Current highest bid price                                                  |
| ask                            | string | `3546`           | Current lowest ask price                                                   |
| high                           | string | `3454`           | Highest price in 24 hours                                                  |
| low                            | string | `453`            | Lowest price in 24 hours                                                   |
| product\_type                  | string | `Perpetual`      | Futures, Perpetual, Options                                                |
| open\_interest                 | string | `2324`           | The number of outstanding derivatives that have not been settled           |
| open\_interest\_usd            | string | `345.25435`      | The sum of the Open Positions (long or short) in USD Value of the contract |
| index\_price                   | string | `23.42`          | Last calculated index price                                                |
| creation\_timestamp            | int    | `1771920000000`  | Start date of derivative (Perpetual contracts will default to 0)           |
| expiry\_timestamp              | int    | `1771920000000`  | End date of derivative (Perpetual contracts will default to 0              |
| funding\_rate                  | string | `0.0001`         | Current funding rate                                                       |
| next\_funding\_rate            | string | `0.001`          | Next funding rate                                                          |
| next\_funding\_rate\_timestamp | int    | `1771920000000`  | Timestamp of next funding rate                                             |
| open\_maker\_fee               | string | `0.0005`         | Fee for creating a maker order                                             |
| open\_taker\_fee               | string | `0.0001`         | Fee for creating a taker order                                             |
| close\_maker\_fee              | string | `0.0005`         | Fee for closing a maker order                                              |
| close\_taker\_fee              | string | `0.0001`         | Fee for closing a taker order                                              |
| contract\_type                 | string | `Vanilla`        | Contract type                                                              |
| contract\_price                | string | `0.048345`       | Price per contract                                                         |
| contract\_price\_currency      | string | `USDT`           | Contract price currency                                                    |
| timestamp                      | int    | `1771908254327`  | Request timestamp                                                          |

<Tabs>
  <Tab title="200">
    ```json theme={"system"}
      {
         "code":"0",
         "msg":"success",
         "data":{
            "contracts":[
               {
                   "ticker_id":"CFX-PERPUSDT",
                   "base_currency":"CFX",
                   "quote_currency":"USDT",
                   "last_price":"0.04806",
                   "base_volume":"72770670",
                   "quote_volume":"3570090",
                   "volume_usd":"3568269.2541",
                   "bid":"0.04802",
                   "ask":"0.04811",
                   "high":"0.05071",
                   "low":"0.04772",
                   "product_type":"Perpetual",
                   "open_interest":"1393",
                   "open_interest_usd":"67.071229552133147694724",
                   "index_price":"0.0481733333333332",
                   "creation_timestamp":0,
                   "expiry_timestamp":0,
                   "funding_rate":"0.0001",
                   "next_funding_rate":"0.0001",
                   "next_funding_rate_timestamp":1771920000000,
                   "open_maker_fee":"0.0005",
                   "open_taker_fee":"0.001",
                   "close_maker_fee":"0.0005",
                   "close_taker_fee":"0.001",
                   "contract_type":"Vanilla",
                   "contract_price":"0.0481733333333332",
                   "contract_price_currency":"USDT",
                   "timestamp":1771908254327
              }
            ]
         }
      }
    ```
  </Tab>
</Tabs>

***

## Orderbook

<Note type="info">
  **`GET`** `https://futuresopenapi.idax.exchange/pub/orderbook`
</Note>

### Query parameters

| Name       | Type    | Example        | Description                 |
| ---------- | ------- | -------------- | --------------------------- |
| ticker\_id | string? | `CFX-PERPUSDT` | Ticker ID of a futures pair |

### Response parameters

| Name       | Type                           | Example         | Description                   |
| ---------- | ------------------------------ | --------------- | ----------------------------- |
| code       | string                         | `0`             | Response status code          |
| msg        | string                         | `success`       | Response status message       |
| data       | object (Check the table below) | `{}`            | Response data                 |
| ticker\_id | string                         | `BTC_PERPUSDT`  | Ticker id of requested symbol |
| timestamp  | int                            | `1771913262174` | Timestamp of request time     |

| Name          | Type   | Example  | Description                    |
| ------------- | ------ | -------- | ------------------------------ |
| orderbook     | object |          |                                |
|   ├─ bids     | array  |          | Array of bid orders            |
|     ├─ price  | string | `3454`   | Bid order price                |
|     ├─ amount | string | `1.3251` | Bid order amount in base asset |
|   ├─ asks     | array  |          | Array of ask orders            |
|     ├─ price  | string | `3454`   | Ask order price                |
|     ├─ amount | string | `1.3251` | Ask order amount in base asset |

<Tabs>
  <Tab title="200">
    ```json theme={"system"}
    {
       "code":"0",
       "msg":"success",
       "data":{
          "orderbook":{
             "bids":[
                {
                   "price":"62991.7",
                   "size":"1.082"
                },
                {
                   "price":"62991.4",
                   "size":"2.0058"
                }
             ],
             "asks":[
                {
                   "price":"62992",
                   "size":"0.6158"
                },
                {
                   "price":"63001.5",
                   "size":"10"
                }
             ]
          },
          "ticker_id":"BTC-PERPUSDT",
          "timestamp":1771913262174
       }
    }   
    ```
  </Tab>
</Tabs>