> ## 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.

# 行情数据

> 合约 API：行情数据。

## 获取客户端IP

`GET` `/future/public/client`

注：此方法不需要签名

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

## 获取交易对币种

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

注：**此方法不需要签名**

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

## 获取单个交易对的配置信息

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
       "baseCoin": "",      //标的资产
       "baseCoinDisplayPrecision": 0,  //标的币种显示精度
       "baseCoinPrecision": 0,  //标的币种精度
       "cnDesc": "",  //合约中文描述
       "cnName": "",  //合约中文名称
       "cnRemark": "",  //合约备注(中文)
       "contractSize": 0,  //合约乘数（面值）
       "contractType": "",  //合约类型，永续，交割
       "deliveryCompletion": false, //交割是否完成
       "deliveryDate": 0,  //交割时间
       "deliveryPrice": 0,  //交割价格
       "depthPrecisionMerge": 0,  //盘口精度合并
       "enDesc": "",      //合约英文描述
       "enName": "",      //合约英文名称
       "enRemark": "",    //合约备注(英文)
       "initLeverage": 0,  //初始杠杆倍数
       "initPositionType": "",  //初始仓位类型
       "isDisplay": false,      //是否展示
       "isOpenApi": false,      //是否支持OpenApi|
       "labels": [],            //标签
       "liquidationFee": 0,     //强平手续费
       "makerFee": 0,           //maker手续费
       "marketTakeBound": 0,    //市价单最多价格偏离
       "maxEntrusts": 0,        //最多open条件单
       "maxNotional": 0,        //最大名义价值
       "maxOpenOrders": 0,      //最多open订单
       "maxPrice": 0,           //预测合约价格上限(原型指数价格上限)
       "minNotional": 0,        //最小名义价值
       "minPrice": 0,           //预测合约价格下限(原型指数价格下限)
       "minQty": 0,             //最小数量
       "minStepPrice": 0,       //最小价格变动单位
       "multiplierDown": 0,     //限价卖单下限百分比
       "multiplierUp": 0,       //限价买单价格上限百分比
       "onboardDate": 0,        //上线时间
       "pair": "",              //标的交易对
       "plates": [],
       "predictEventParam": "",   //事件关联参数
       "predictEventSort": "",    //事件关联排序:WIN 胜, FLAT 平, NEGATIVE 负
       "predictEventType": "",    //预测事件类型:PERPETUAL 永续事件，ONCE 单事件
       "pricePrecision": 0,       //价格精度
       "productType": "",         //合约类型，perpetual, futures，不区分交割间隔
       "quantityPrecision": 0,     //数量精度
       "quoteCoin": "",            //报价资产
       "quoteCoinDisplayPrecision": 0,  //报价币种显示精度
       "quoteCoinPrecision": 0,         //报价币种精度
       "state": 0,                    //状态
       "supportEntrustType": "",      //支持计划委托类型
       "supportOrderType": "",        //支持订单类型
       "supportPositionType": "",     //支持仓位类型
       "supportTimeInForce": "",      //支持有效方式
       "symbol": "",                  //交易对
       "symbolGroupId": 0,
       "takerFee": 0,                  //手续费
       "tradeSwitch": false,           //交易对开关
       "underlyingType": ""            //标的类型，币本位，u本位
     },
  "returnCode": 0
}
```

## 获取上架和可交易的交易对配置信息

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

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
      {
       "baseCoin": "",      //标的资产
       "baseCoinDisplayPrecision": 0,  //标的币种显示精度
       "cnDesc": "",  //合约中文描述
       "cnName": "",  //合约中文名称
       "cnRemark": "",  //合约备注(中文)
       "contractSize": 0,  //合约乘数（面值）
       "contractType": "",  //合约类型，永续，交割
       "deliveryCompletion": false, //交割是否完成
       "deliveryDate": 0,  //交割时间
       "deliveryPrice": 0,  //交割价格
       "depthPrecisionMerge": 0,  //盘口精度合并
       "enDesc": "",      //合约英文描述
       "enName": "",      //合约英文名称
       "enRemark": "",    //合约备注(英文)
       "initLeverage": 0,  //初始杠杆倍数
       "initPositionType": "",  //初始仓位类型
       "isDisplay": false,      //是否展示
       "isOpenApi": false,      //是否支持OpenApi|
       "labels": [],            //标签
       "liquidationFee": 0,     //强平手续费
       "makerFee": 0,           //maker手续费
       "marketTakeBound": 0,    //市价单最多价格偏离
       "maxEntrusts": 0,        //最多open条件单
       "maxNotional": 0,        //最大名义价值
       "maxOpenOrders": 0,      //最多open订单
       "maxPrice": 0,           //预测合约价格上限(原型指数价格上限)
       "minNotional": 0,        //最小名义价值
       "minPrice": 0,           //预测合约价格下限(原型指数价格下限)
       "minQty": 0,             //最小数量
       "minStepPrice": 0,       //最小价格变动单位
       "multiplierDown": 0,     //限价卖单下限百分比
       "multiplierUp": 0,       //限价买单价格上限百分比
       "onboardDate": 0,        //上线时间
       "pair": "",              //标的交易对
       "plates": [],
       "predictEventParam": "",   //事件关联参数
       "predictEventSort": "",    //事件关联排序:WIN 胜, FLAT 平, NEGATIVE 负
       "predictEventType": "",    //预测事件类型:PERPETUAL 永续事件，ONCE 单事件
       "pricePrecision": 0,       //价格精度
       "productType": "",         //合约类型，perpetual, futures，不区分交割间隔
       "quantityPrecision": 0,     //数量精度(废弃)
       "quoteCoin": "",            //报价资产
       "quoteCoinDisplayPrecision": 0,  //报价币种显示精度
       "quoteCoinPrecision": 0,         //报价币种精度
       "baseCoinPrecision": 0,          //标的币种精度
       "state": 0,                    //状态
       "supportEntrustType": "",      //支持计划委托类型
       "supportOrderType": "",        //支持订单类型
       "supportPositionType": "",     //支持仓位类型
       "supportTimeInForce": "",      //支持有效方式
       "symbol": "",                  //交易对
       "symbolGroupId": 0,
       "takerFee": 0,                  //手续费
       "tradeSwitch": false,           //交易对开关
       "underlyingType": ""            //标的类型，币本位，u本位
     } 

  ],
  "returnCode": 0
}
```

## 查询单个交易对杠杆分层

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "leverageBrackets": [
      {
        "bracket": 0, //档位
        "maintMarginRate": 0, //维持保证金率
        "maxLeverage": 0, //最大杠杆倍数
        "maxNominalValue": 0, //该层最大名义价值
        "maxStartMarginRate": 0, //最大起始保证金率
        "minLeverage": 0, //最小杠杆倍数
        "startMarginRate": 0, //起始保证金率
        "symbol": "" //交易对
      }
    ],
    "symbol": ""
  },
  "returnCode": 0
}
```

## 查询所有交易对杠杆分层

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

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "leverageBrackets": [
        {
          "bracket": 0, //档位
          "maintMarginRate": 0, //维持保证金率
          "maxLeverage": 0, //最大杠杆倍数
          "maxNominalValue": 0, //该层最大名义价值
          "maxStartMarginRate": 0, //最大起始保证金率
          "minLeverage": 0, //最小杠杆倍数
          "startMarginRate": 0, //起始保证金率
          "symbol": "" //交易对
        }
      ],
      "symbol": ""
    }
  ],
  "returnCode": 0
}
```

## 获取指定交易对的行情信息

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "a": "", //24小时成交量
    "c": "", //最新价
    "h": "", //24小时最高价
    "l": "", //24小时最低价
    "o": "", //24小时前第一笔成交价
    "r": "", //24小时涨跌幅
    "s": "", //交易对
    "t": 0, //时间
    "v": "" //24小时成交额
  },
  "returnCode": 0
}
```

## 获取全交易对的行情信息

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

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "a": "", //24小时成交量
      "c": "", //最新价
      "h": "", //24小时最高价
      "l": "", //24小时最低价
      "o": "", //24小时前第一笔成交价
      "r": "", //24小时涨跌幅
      "s": "", //交易对
      "t": 0, //时间
      "v": "" //24小时成交额
    }
  ],
  "returnCode": 0
}
```

## 获取交易对的最新成交信息

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |
| num | integer | false | 50 | 数量 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "a": 0, //成交量
      "m": "", //买卖方向
      "p": 0, //成交价
      "s": "", //交易对
      "t": 0 //成交时间
    }
  ],
  "returnCode": 0
}
```

## 获取交易对的深度信息

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |
| level | integer | true | N/A | 档位（min:1,max:50） | |

### 限流规则

10/s/ip\
注：此方法不需要签名

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "a": [], //卖单
    "b": [], //买单
    "s": "", //交易对
    "t": 0, //时间
    "u": 0 //updateId
  },
  "returnCode": 0
}
```

## 获取单个交易对的指数价格

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "p": 0, //价格
    "s": "", //交易对
    "t": 0 //时间
  },
  "returnCode": 0
}
```

## 获取所有交易对的指数价格

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

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "p": 0, //价格
      "s": "", //交易对
      "t": 0 //时间
    }
  ],
  "returnCode": 0
}
```

## 获取单个交易对的标记价格

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "p": 0, //价格
    "s": "", //交易对
    "t": 0 //时间
  },
  "returnCode": 0
}
```

## 获取所有交易对的标记价格

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | false | N/A | 交易对 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "p": 0, //价格
      "s": "", //交易对
      "t": 0 //时间
    }
  ],
  "returnCode": 0
}
```

## 获取交易对的k线信息

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |
| interval | string | true | N/A | 时间间隔 | 1m;5m;15m;30m;1h;4h;1d;1w |
| startTime | integer | false | N/A | 起始时间 | |
| endTime | integer | false | N/A | 结束时间 | |
| limit | integer | false | N/A | 限制条数 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "a": 0, //成交量
      "c": 0, //结束价
      "h": 0, //最高价
      "l": 0, //最低价
      "o": 0, //开始价
      "s": "", //交易对
      "t": 0, //时间
      "v": 0 //成交额
    }
  ],
  "returnCode": 0
}
```

## 获取指定交易对的聚合行情信息

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "a": "", //24小时成交量
    "ap": "", //卖一价格
    "bp": "", //买一价格
    "c": "", //最新价
    "h": "", //24小时最高价
    "i": "", //指数价格
    "l": "", //24小时最低价
    "m": "", //标记价格
    "o": "", //24小时前第一笔成交价
    "r": "", //24小时涨跌幅
    "s": "", //交易对
    "t": 0, //时间
    "v": "" //24小时成交额
  },
  "returnCode": 0
}
```

## 获取全交易对的聚合行情信息

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

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "a": "", //24小时成交量
      "ap": "", //卖一价格
      "bp": "", //买一价格
      "c": "", //最新价
      "h": "", //24小时最高价
      "i": "", //指数价格
      "l": "", //24小时最低价
      "m": "", //标记价格
      "o": "", //24小时前第一笔成交价
      "r": "", //24小时涨跌幅
      "s": "", //交易对
      "t": 0, //时间
      "v": "" //24小时成交额
    }
  ],
  "returnCode": 0
}
```

## 获取资金费率

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

### 限流规则

1/s/ip\
注：此方法不需要签名

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "hasNext": false, //是否有下一页
    "hasPrev": false, //是否有上一页
    "items": [ //数据列表
      {
        "collectionInternal": 0, //收取时间间隔（时）
        "createdTime": 0, //时间
        "fundingRate": 0, //最新资金费率
        "id": 0, //id
        "symbol": "" //交易对
      }
    ]
  },
  "returnCode": 0
}
```

## 获取指定交易对的买一卖一行情信息

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "ap": "", //卖一价格
    "aq": "", //卖一数量
    "bp": "", //买一价格
    "bq": "", //买一数量
    "s": "", //交易对
    "t": 0 //时间
  },
  "returnCode": 0
}
```

## 获取资金费率记录

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | false | N/A | 交易对 | |
| direction | string | false | NEXT | 方向（PREV:上一页；NEXT:下一页） | PREV;NEXT |
| id | integer | false | N/A | id | |
| limit | integer | false | 10 | 条数 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "hasNext": false, //是否有下一页
    "hasPrev": false, //是否有上一页
    "items": [ //数据列表
      {
        "collectionInternal": 0, //收取时间间隔（秒）
        "createdTime": 0, //时间
        "fundingRate": 0, //最新资金费率
        "id": 0, //id
        "symbol": "" //交易对
      }
    ]
  },
  "returnCode": 0
}
```

## 获取全交易对的买一卖一行情信息

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

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": [
    {
      "ap": "", //卖一价格
      "aq": "", //卖一数量
      "bp": "", //买一价格
      "bq": "", //买一数量
      "s": "", //交易对
      "t": 0 //时间
    }
  ],
  "returnCode": 0
}
```

## 获取交易对风险基金余额

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | | 交易对 | |
| direction | string | false | NEXT | 方向（PREV:上一页；NEXT:下一页） | PREV;NEXT |
| id | integer | false | N/A | id | |
| limit | integer | false | 10 | 条数 | |

注：**此方法不需要签名**

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "hasNext": false, //是否有下一页
    "hasPrev": false, //是否有上一页
    "items": [ //数据列表
      {
        "amount": 0, //余额
        "coin": "", //币种
        "createdTime": 0, //时间
        "id": 0 //id
      }
    ]
  },
  "returnCode": 0
}
```

## 获取交易对开仓量

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对 | |

### 限流规则

1/s/ip\
注：此方法不需要签名

```json Response theme={null}
{
  "error": {
    "code": "",
    "msg": ""
  },
  "msgInfo": "",
  "result": {
    "symbol": "", //交易对
    "openInterest": "", //开仓量
    "openInterestUsd": 0, //开仓价值
    "time": "", //时间
  },
  "returnCode": 0
}
```

## 获取合约信息

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

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

Note：这个方法不需要签名.

```json Response theme={null}
[{
    "id": 123, 
    "ask": "1817.32",                 //当前最低价
    "base_currency": "ETH",           //标的币种，比如 BTC
    "base_volume": "13267684284",     //24小时交易量
    "bid": "1817.31",                 //当前最高价
    "contractSize": 10,               //合约面值
    "end_timestamp": 253402099200000, //该衍生品的终结时间
    "funding_rate": "-0.03",          //资金费率
    "high": "1828.89",                //24小时最高成交价
    "index_currency": "USD",          //指数的基础币种
    "index_name": "ETH-USD",          //基础指数的名称
    "index_price": "1816.61",         //基础指数价格
    "last_price": "1817.31",          //最新价格
    "low": "1778.65",                 //24小时最低成交价
    "next_funding_rate": "-0.03",     //预计下一个资金费率
    "next_funding_rate_timestamp":1698681600000,  //下一个资金费率时间
    "open_interest": "2419347630",    //24小时合约持仓量
    "product_type": "PERPETUAL",      //产品类型
    "start_timestamp": 1651328033000, //该衍生品的开始时间
    "symbol": "eth_usd",
    "target_currency": "USD",         //报价币种
    "target_volume": "73698647.51054371",  //24小时交易量
    "ticker_id": "ETH-USD",           //代码标识符
    "underlyingType": 1               //标的类型，币本位，u本位
  }]
```

## 获取交易对深度信息

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

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

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | N/A | 交易对，例如BTC-USDT | |
| level | int | false | 50 | | 1-200 |

Note：这个方法不需要签名

```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.