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

# Market data

> Futures API: market data.

## Get client ip

`GET` `/future/public/client`

Note：This method does not require a signature.

```json Response theme={null}
{
  "returnCode": 0,
  "msgInfo": "success",
  "error": null
  "result": {
    "ip": 192.168.1.1  
  }
}
```

## Get Trading Pair Currency

`GET` `/future/market/v1/public/symbol/coins`

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [],
  "returnCode": 0
}
```

## Get Configuration Information for Single Trading Pair

`GET` `/future/market/v1/public/symbol/detail`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
         "baseCoin": "",      //Target Assets
         "baseCoinDisplayPrecision": 0,  //Displayed target currency precision
         "baseCoinPrecision": 0,  //Target currency precision
         "cnDesc": "",  //Chinese description of the contract
         "cnName": "",  //Contract Chinese name
         "cnRemark": "",  //Contract Remarks (Chinese)
         "contractSize": 0,  //Contract multiplier(face value)
         "contractType": "",  //Contract type, perpetual, delivery
         "deliveryCompletion": false, //Whether the delivery is completed
         "deliveryDate": 0,  //delivery time
         "deliveryPrice": 0,  //delivery price
         "depthPrecisionMerge": 0,  //Handicap Precision Consolidation
         "enDesc": "",      //English description of the contract
         "enName": "",      //Contract English name
         "enRemark": "",    //Contract Remarks (English)
         "initLeverage": 0,  //Initial leverage
         "initPositionType": "",  //Initial position type
         "isDisplay": false,      //whether to display
         "isOpenApi": false,      //Whether to support OpenApi
         "labels": [],            //Label
         "liquidationFee": 0,     //Forced liquidation fee
         "makerFee": 0,           //Maker fee
         "marketTakeBound": 0,    //Market order maximum price deviation
         "maxEntrusts": 0,        //Maximum active orders
         "maxNotional": 0,        //Maximum Notional Value
         "maxOpenOrders": 0,      //Maximum open orders
         "maxPrice": 0,           //Maximum price
         "minNotional": 0,        //Minimum notional value
         "minPrice": 0,           //Minimum price
         "minQty": 0,             //Minimum quantity
         "minStepPrice": 0,       //Smallest tick
         "multiplierDown": 0,     //Floor percentage of sell limit order
         "multiplierUp": 0,       //Cap percentage of buy limit order
         "onboardDate": 0,        //List time
         "pair": "",              //Target trading pair
         "plates": [],
         "predictEventParam": "",   //Event Correlation Parameters
         "predictEventSort": "",    //Event Correlation Sorting: WIN wins, FLAT draws, NEGATIVE loses
         "predictEventType": "",    //Forecast event type: PERPETUAL perpetual event, ONCE single event
         "pricePrecision": 0,       //Price precision
         "productType": "",         //Contract type, perpetual, futures, regardless of delivery interval
         "quantityPrecision": 0,     //Quantity precision
         "quoteCoin": "",            //Quote currency
         "quoteCoinDisplayPrecision": 0,  //Displayed quote currency precision
         "quoteCoinPrecision": 0,         //Quote currency precision
         "state": 0,                    //Status
         "supportEntrustType": "",      //Trigger order type supported
         "supportOrderType": "",        //Order type supported
         "supportPositionType": "",     //Support position type
         "supportTimeInForce": "",      //Valid ways supported
         "symbol": "",                  //Trading pair
         "symbolGroupId": 0,
         "takerFee": 0,                  //Taker fee
         "tradeSwitch": false,           //Trading pair switch
         "underlyingType": ""            //Target type, Coin-M,USDT-M
      },
  "returnCode": 0
}
```

## Get Configuration Information for Listed And Tradeable Symbols

`GET` `/future/market/v3/public/symbol/list`

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
      {
         "baseCoin": "",      //Target Assets
         "baseCoinDisplayPrecision": 0,  //Displayed target currency precision
         "cnDesc": "",  //Chinese description of the contract
         "cnName": "",  //Contract Chinese name
         "cnRemark": "",  //Contract Remarks (Chinese)
         "contractSize": 0,  //Contract multiplier(face value)
         "contractType": "",  //Contract type, perpetual, delivery
         "deliveryCompletion": false, //Whether the delivery is completed
         "deliveryDate": 0,  //delivery time
         "deliveryPrice": 0,  //delivery price
         "depthPrecisionMerge": 0,  //Handicap Precision Consolidation
         "enDesc": "",      //English description of the contract
         "enName": "",      //Contract English name
         "enRemark": "",    //Contract Remarks (English)
         "initLeverage": 0,  //Initial leverage
         "initPositionType": "",  //Initial position type
         "isDisplay": false,      //whether to display
         "isOpenApi": false,      //Whether to support OpenApi
         "labels": [],            //Label
         "liquidationFee": 0,     //Forced liquidation fee
         "makerFee": 0,           //Maker fee
         "marketTakeBound": 0,    //Market order maximum price deviation
         "maxEntrusts": 0,        //Maximum active orders
         "maxNotional": 0,        //Maximum Notional Value
         "maxOpenOrders": 0,      //Maximum open orders
         "maxPrice": 0,           //Maximum price
         "minNotional": 0,        //Minimum notional value
         "minPrice": 0,           //Minimum price
         "minQty": 0,             //Minimum quantity
         "minStepPrice": 0,       //Smallest tick
         "multiplierDown": 0,     //Floor percentage of sell limit order
         "multiplierUp": 0,       //Cap percentage of buy limit order
         "onboardDate": 0,        //List time
         "pair": "",              //Target trading pair
         "plates": [],
         "predictEventParam": "",   //Event Correlation Parameters
         "predictEventSort": "",    //Event Correlation Sorting: WIN wins, FLAT draws, NEGATIVE loses
         "predictEventType": "",    //Forecast event type: PERPETUAL perpetual event, ONCE single event
         "pricePrecision": 0,       //Price precision
         "productType": "",         //Contract type, perpetual, futures, regardless of delivery interval
         "quantityPrecision": 0,     //Quantity precision (Deprecated)
         "quoteCoin": "",            //Quote currency
         "quoteCoinDisplayPrecision": 0,  //Displayed quote currency precision
         "quoteCoinPrecision": 0,         //Quote currency precision
         "baseCoinPrecision": 0,          //Target currency precision
         "state": 0,                    //Status
         "supportEntrustType": "",      //Trigger order type supported
         "supportOrderType": "",        //Order type supported
         "supportPositionType": "",     //Support position type
         "supportTimeInForce": "",      //Valid ways supported
         "symbol": "",                  //Trading pair
         "symbolGroupId": 0,
         "takerFee": 0,                  //Taker fee
         "tradeSwitch": false,           //Trading pair switch
         "underlyingType": ""            //Target type, Coin-M,USDT-M
   }
  ],
  "returnCode": 0
}
```

## See Leverage Stratification of Single Trading Pair

`GET` `/future/market/v1/public/leverage/bracket/detail`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "leverageBrackets": [
      {
        "bracket": 0, //Level
        "maintMarginRate": 0, //Maintain margin rate
        "maxLeverage": 0, //Maximum leverage
        "maxNominalValue": 0, //Maximum notional value
        "maxStartMarginRate": 0, //Maximum initial margin rate
        "minLeverage": 0, //Minimum leverage
        "startMarginRate": 0, //Initial margin rate
        "symbol": "" //Trading pair
      }
    ],
    "symbol": ""
  },
  "returnCode": 0
}
```

## See Leverage Stratification of All Trading Pairs

`GET` `/future/market/v1/public/leverage/bracket/list`

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "leverageBrackets": [
        {
          "bracket": 0, //Level
          "maintMarginRate": 0, //Maintain margin rate
          "maxLeverage": 0, //Maximum leverage
          "maxNominalValue": 0, //Maximum notional value
          "maxStartMarginRate": 0, //Maximum initial margin rate
          "minLeverage": 0, //Minimum leverage
          "startMarginRate": 0, //Initial margin rate
          "symbol": "" //Trading pair
        }
      ],
      "symbol": ""
    }
  ],
  "returnCode": 0
}
```

## Get Market Information for Specific Trading Pair

`GET` `/future/market/v1/public/q/ticker`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "a": "", //24h volume
    "c": "", //Latest price
    "h": "", //Highest price in 24 hours
    "l": "", //Lowest price in 24 hours
    "o": "", //The first transaction price 24 hours ago
    "r": "", //24h Price Fluctuation Limit
    "s": "", //Trading pair
    "t": 0, //Time
    "v": "" //24h turnover
  },
  "returnCode": 0
}
```

## Get Market Information for All Trading Pairs

`GET` `/future/market/v1/public/q/tickers`

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "a": "", //24h volume
      "c": "", //Latest price
      "h": "", //Highest price in 24 hours
      "l": "", //Lowest price in 24 hours
      "o": "", //The first transaction price 24 hours ago
      "r": "", //24h Price Fluctuation Limit
      "s": "", //Trading pair
      "t": 0, //Time
      "v": "" //24h turnover
    }
  ],
  "returnCode": 0
}
```

## Get Latest Transaction Information of Trading Pairs

`GET` `/future/market/v1/public/q/deal`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |
| num | integer | false | 50 | Quantity | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "a": 0, //Volume
      "m": "", //Order side
      "p": 0, //Price
      "s": "", //Trading pair
      "t": 0 //Time
    }
  ],
  "returnCode": 0
}
```

## Get Depth Data of Trading Pairs

`GET` `/future/market/v1/public/q/depth`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |
| level | integer | true | N/A | Level(min:1,max:50) | |

### Limit Flow Rules

10/s/ip Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "a": [], //Buy
    "b": [], //Sell
    "s": "", //Trading pair
    "t": 0, //Time
    "u": 0 //updateId
  },
  "returnCode": 0
}
```

## Get Index Price for Single Trading Pair

`GET` `/future/market/v1/public/q/symbol-index-price`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "p": 0, //Price
    "s": "", //Trading pair
    "t": 0 //Time
  },
  "returnCode": 0
}
```

## Get Index Price for All Trading Pairs

`GET` `/future/market/v1/public/q/index-price`

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "p": 0, //Price
      "s": "", //Trading pair
      "t": 0 //Time
    }
  ],
  "returnCode": 0
}
```

## Get Mark Price for Single Trading Pair

`GET` `/future/market/v1/public/q/symbol-mark-price`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "p": 0, //Price
    "s": "", //Trading pair
    "t": 0 //Time
  },
  "returnCode": 0
}
```

## Get Mark Price for All Trading Pairs

`GET` `/future/market/v1/public/q/mark-price`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | false | N/A | Trading pair | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "p": 0, //Price
      "s": "", //Trading pair
      "t": 0 //Time
    }
  ],
  "returnCode": 0
}
```

## Get Trading Pair Information of Kline

`GET` `/future/market/v1/public/q/kline`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |
| interval | string | true | N/A | Time-interval | 1m;5m;15m;30m;1h;4h;1d;1w |
| startTime | integer | false | N/A | Start time | |
| endTime | integer | false | N/A | End time | |
| limit | integer | false | N/A | Limit | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "a": 0, //Volume
      "c": 0, //Close price
      "h": 0, //Highest price
      "l": 0, //Lowest price
      "o": 0, //Open price
      "s": "", //Trading pair
      "t": 0, //Time
      "v": 0 //Turnover
    }
  ],
  "returnCode": 0
}
```

## Get Aggregated Market Information for Specific Trading Pair

`GET` `/future/market/v1/public/q/agg-ticker`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "a": "", //24h volume
    "ap": "", //ask price
    "bp": "", //bid price
    "c": "", //Latest price
    "h": "", //Highest price in 24 hours
    "i": "", //index price
    "l": "", //Lowest price in 24 hours
    "m": "", //mark price
    "o": "", //The first transaction price 24 hours ago
    "r": "", //24h price fluctuation limit
    "s": "", //Trading pair
    "t": 0, //Time
    "v": "" //24h Turnover
  },
  "returnCode": 0
}
```

## Get Aggregated Market Information for All Trading Pairs

`GET` `/future/market/v1/public/q/agg-tickers`

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "a": "", //24h volume
      "ap": "", //ask price
      "bp": "", //bid price
      "c": "", //Latest price
      "h": "", //Highest price in 24 hours
      "i": "", //index price
      "l": "", //Lowest price in 24 hours
      "m": "", //mark price
      "o": "", //The first transaction price 24 hours ago
      "r": "", //24h price fluctuation limit
      "s": "", //Trading pair
      "t": 0, //Time
      "v": "" //24h Turnover
    }
  ],
  "returnCode": 0
}
```

## Get Funding Rate Information

`GET` `/future/market/v1/public/q/funding-rate`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

### Limit Flow Rules

1/s/ip Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "hasNext": false, //Is there a next page
    "hasPrev": false, //Is there a previous page
    "items": [ //Datasheets
      {
        "collectionInternal": 0, //Billing Cycle (hour)
        "createdTime": 0, //Time
        "fundingRate": 0, //Latest funding rate
        "id": 0, //id
        "symbol": "" //Trading pair
      }
    ]
  },
  "returnCode": 0
}
```

## Get Ask Bid Market Information for Specific Trading Pair

`GET` `/future/market/v1/public/q/ticker/book`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "ap": "", //ask price
    "aq": "", //ask amount
    "bp": "", //bid price
    "bq": "", //bid amount
    "s": "", //Trading pair
    "t": 0 //Time
  },
  "returnCode": 0
}
```

## Get Funding Rate Records

`GET` `/future/market/v1/public/q/funding-rate-record`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | false | N/A | Trading pair | |
| direction | string | false | NEXT | Direction（PREV:Previous page；NEXT:Next page） | PREV;NEXT |
| id | integer | false | N/A | id | |
| limit | integer | false | 10 | Limit | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "hasNext": false, //Is there a next page
    "hasPrev": false, //Is there a previous page
    "items": [ //Datasheets
      {
        "collectionInternal": 0, //Billing Cycle (second)
        "createdTime": 0, //Time
        "fundingRate": 0, //Latest funding rate
        "id": 0, //id
        "symbol": "" //Trading pair
      }
    ]
  },
  "returnCode": 0
}
```

## Get Ask Bid Market Information for All Trading Pairs

`GET` `/future/market/v1/public/q/ticker/books`

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "ap": "", //ask price
      "aq": "", //ask amount
      "bp": "", //bid price
      "bq": "", //bid amount
      "s": "", //Trading pair
      "t": 0 //Time
    }
  ],
  "returnCode": 0
}
```

## Get Trading Pair Risk Fund Balance

`GET` `/future/market/v1/public/contract/risk-balance`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | | Trading pair | |
| direction | string | false | NEXT | Direction（PREV:Previous page；NEXT:Next page） | PREV;NEXT |
| id | integer | false | N/A | id | |
| limit | integer | false | 10 | Limit | |

Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "hasNext": false, //Is there a next page
    "hasPrev": false, //Is there a previous page
    "items": [ //Datasheets
      {
        "amount": 0, //Balance
        "coin": "", //Currency
        "createdTime": 0, //Time
        "id": 0 //id
      }
    ]
  },
  "returnCode": 0
}
```

## Get the open position of a trading pair

`GET` `/future/market/v1/public/contract/open-interest`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair | |

### Limit Flow Rules

1/s/ip Note：This method does not require a signature.

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "symbol": "", //Trading pair
    "openInterest": "", //open position
    "openInterestUsd": 0, //open value
    "time": "", //time
  },
  "returnCode": 0
}
```

## Get Futures Info

`GET` `/future/market/v1/public/cg/contracts`

Content-Type = application/x-www-form-urlencoded

Note：This method does not require a signature.

```json Response theme={null}
[{
    "id": 123, 
    "ask": "1817.32",                 //Current lowest ask price
    "base_currency": "ETH",           //Symbol/currency code of base pair, eg. BTC
    "base_volume": "13267684284",     //24 hour trading volume
    "bid": "1817.31",                 //Current highest bid price
    "contractSize": 10,               //Futures par value
    "end_timestamp": 253402099200000, //Ending of this derivative product
    "funding_rate": "-0.03",          //Fund rate
    "high": "1828.89",                //24-hour highest trading price
    "index_currency": "USD",          //Underlying currency for index
    "index_name": "ETH-USD",          //Name of the underlying index if any
    "index_price": "1816.61",         //Underlying index price
    "last_price": "1817.31",          //Latest price
    "low": "1778.65",                 //24-hour lowest trading price
    "next_funding_rate": "-0.03",     //Upcoming predicted funding rate
    "next_funding_rate_timestamp":1698681600000,  //Next funding rate time
    "open_interest": "2419347630",    //The open interest in the last 24 hours in contracts
    "product_type": "PERPETUAL",      //Product type
    "start_timestamp": 1651328033000, //Starting of this derivative product (relevant for expirable futures or options)
    "symbol": "eth_usd",
    "target_currency": "USD",         //Symbol/currency code of target pair, eg. ETH
    "target_volume": "73698647.51054371",  //24 hours trading volume
    "ticker_id": "ETH-USD",           //Identifier of a ticker with delimiter to separate base/target, eg. BTC-PERP
    "underlyingType": 1               //Target type, Coin-M,USDT-M
  }]
```

## Get Depth Info

`GET` `/future/market/v1/public/cg/orderbook`

Content-Type = application/x-www-form-urlencoded

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | N/A | Trading pair, eg.BTC-USDT | |
| level | int | false | 50 | | 1-200 |

Note：This method does not require a signature.

```json Response theme={null}
{
          "ticker_id": "BTC-USDT", 
          "timestamp": 1698668957638,
          "bids": [[
               "34794.6",
               "97164"
              ],[
               "34794.5",
               "9897"
              ],...], 
          "asks": [[
               "34794.7",
               "168479"
              ],[
               "34794.8",
               "4009"
              ],...]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.