# 现货交易

## 公共

### 安全类型: None

{% hint style="info" %}
公共类型接口不需要API-key或者签名就能自由访问
{% endhint %}

***

## &#x20;测试连接

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/ping`

测试REST API的连通性

{% tabs %}
{% tab title="200  连接正常" %}

```
{}
```

{% endtab %}
{% endtabs %}

***

## &#x20;服务器时间

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/time`

服务器时间

{% tabs %}
{% tab title="200  获取服务器时间成功" %}

```java
{
    "timezone": "GMT+08:00",
    "serverTime": 1595563624731
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="服务器时间返参:" %}

<table><thead><tr><th>名称</th><th width="113">类型</th><th>例子</th><th>描述</th></tr></thead><tbody><tr><td>timezone</td><td>string</td><td>China Standard Time</td><td>服务器时区</td></tr><tr><td>serverTime</td><td>long</td><td>1705039779880</td><td>服务器时间戳</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## 币对列表&#x20;

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/symbols`

市场支持的币对集合

{% tabs %}
{% tab title="200 获取币对列表成功" %}

```java
{
    "symbols": [
        {
            "quantityPrecision": 3,
            "limitVolumeMin":0.0001,
            "symbol": "sccadai",
            "pricePrecision": 6,
            "marketBuyMin":0.0001,
            "marketSellMin":0.0001,
            "baseAsset": "SCCA",
            "limitPriceMin":0.001,
            "quoteAsset": "DAI",
        },
        {
            "quantityPrecision": 8,
            "limitVolumeMin":0.0001,
            "symbol": "btcusdt",
            "pricePrecision": 2,
            "marketBuyMin":0.0001,
            "marketSellMin":0.0001,
            "baseAsset": "BTC",
            "limitPriceMin":0.001,
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 3,
            "limitVolumeMin":0.0001,
            "symbol": "bchusdt",
            "pricePrecision": 2,
            "marketBuyMin":0.0001,
            "marketSellMin":0.0001,
            "baseAsset": "BCH",
            "limitPriceMin":0.001,
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 2,
            "limitVolumeMin":0.0001,
            "symbol": "etcusdt",
            "pricePrecision": 2,
            "marketBuyMin":0.0001,
            "marketSellMin":0.0001,
            "baseAsset": "ETC",
            "limitPriceMin":0.001,
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 2,
            "limitVolumeMin":0.0001,
            "symbol": "ltcbtc",
            "pricePrecision": 6,
            "marketBuyMin":0.0001,
            "marketSellMin":0.0001,
            "baseAsset": "LTC",
            "limitPriceMin":0.001,
            "quoteAsset": "BTC"
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th>名称</th><th>类型</th><th width="135">例子</th><th>描述</th></tr></thead><tbody><tr><td>symbol</td><td>string</td><td>btcusdt</td><td>小写币对名称</td></tr><tr><td>baseAsset</td><td>string</td><td><code>BTC</code></td><td>base货币</td></tr><tr><td>quoteAsset</td><td>string</td><td><code>USDT</code></td><td>计价货币</td></tr><tr><td>pricePrecision</td><td>integer</td><td><code>2</code></td><td>价格精度</td></tr><tr><td>quantityPrecision</td><td>integer</td><td><code>6</code></td><td>数量精度</td></tr><tr><td>limitVolumeMin</td><td>BigDecimal</td><td>0.00001</td><td>限价单最小数量限制</td></tr><tr><td>marketBuyMin</td><td>BigDecimal</td><td>0.00001</td><td>市价单最小购买数量</td></tr><tr><td>marketSellMin</td><td>BigDecimal</td><td>0.00001</td><td>市价单最小卖出数量</td></tr><tr><td>limitPriceMin</td><td>BigDecimal</td><td>0.00001</td><td>限价单最小价格限制</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## 行情

### 安全类型: None

行情下方的接口不需要API-Key或者签名就能自由访问

***

## &#x20;订单薄

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/depth`

市场订单薄深度信息

#### Query Parameters

| Name                                     | Type    | Description       |
| ---------------------------------------- | ------- | ----------------- |
| limit<mark style="color:red;">\*</mark>  | integer | 默认100; 最大100      |
| symbol<mark style="color:red;">\*</mark> | string  | 大写币对名称 例如：BTCUSDT |

{% tabs %}
{% tab title="200  成功获取深度信息" %}

```java
{
  "bids": [
    [
      "3.90000000",   // 价格
      "431.00000000"  // 数量
    ],
    [
      "4.00000000",
      "431.00000000"
    ]
  ],
  "asks": [
    [
      "4.00000200",  // 价格
      "12.00000000"  // 数量
    ],
    [
      "5.10000000",
      "28.00000000"
    ]
  ],
  "time": 1701658276000
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="95">名称</th><th width="78">类型</th><th width="211">例子</th><th>描述</th></tr></thead><tbody><tr><td>time</td><td>long</td><td><code>1595563624731</code></td><td>当前时间(Unix Timestamp, 毫秒ms)</td></tr><tr><td>bids</td><td>array</td><td>[[1.3200,2.04],[0.2,0.4]]</td><td>订单薄买盘信息，数组长度为2，角标1为价格，类型为float；角标2为当前价格对应的数量，类型为float</td></tr><tr><td>asks</td><td>array</td><td>[[1.3200,2.04],[0.2,0.4]]</td><td>订单薄卖盘信息，数组长度为2，角标1为价格，类型为float；角标2为当前价格对应的数量，类型为float</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

{% hint style="info" %}
bids和asks所对应的信息代表了订单薄的所有价格以及价格对应的数量的信息, 由最优价格从上到下排列
{% endhint %}

***

## &#x20;行情ticker

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/ticker`

24小时价格变化数据

#### Query Parameters

| Name                                     | Type   | Description         |
| ---------------------------------------- | ------ | ------------------- |
| symbol<mark style="color:red;">\*</mark> | string | 大写币对名称 例如 `BTCUSDT` |

{% tabs %}
{% tab title="200  成功获取ticker信息" %}

```java
{
    "amount":"23.20",
    "high": "9279.03",
    "vol": "1302.00",
    "last": "9200.00",
    "low": "9279.03",
    "buy":130.00,
    "sell":0.00,
    "rose": "+0.05",
    "time": 1595563624731
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="139">名称</th><th width="154">类型</th><th width="188">例子</th><th>描述</th></tr></thead><tbody><tr><td>time</td><td>long</td><td><code>1595563624731</code></td><td>时间戳</td></tr><tr><td>high</td><td>float</td><td><code>9900</code></td><td>最高价</td></tr><tr><td>low</td><td>float</td><td><code>8800.34</code></td><td>最低价</td></tr><tr><td>last</td><td>float</td><td><code>8900</code></td><td>最新成交价</td></tr><tr><td>vol</td><td>float</td><td><code>4999</code></td><td>交易量</td></tr><tr><td>amount</td><td>float</td><td>23.20</td><td>交易额</td></tr><tr><td>buy</td><td>float</td><td>130</td><td>买一价格</td></tr><tr><td>sell</td><td>float</td><td>120</td><td>卖一价格</td></tr><tr><td>rose</td><td>string</td><td>+0.05</td><td>涨跌幅，+为涨，-为跌，+0.05为涨5%</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## &#x20;最近成交

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/trades`

#### Query Parameters

| Name                                     | Type   | Description         |
| ---------------------------------------- | ------ | ------------------- |
| symbol<mark style="color:red;">\*</mark> | string | 大写币对名称 例如 `BTCUSDT` |
| limit<mark style="color:red;">\*</mark>  | string | 默认100; 最大1000       |

{% tabs %}
{% tab title="200 " %}

```java
[
    {
        "side": "buy",
        "price": 130.0000000000000000,
        "qty": 0.1000000000000000,
        "time": 1704788645416
    },
    {
        "side": "buy",
        "price": 130.0000000000000000,
        "qty": 0.1000000000000000,
        "time": 1704788282332
    }
]
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="150">名称</th><th width="115">类型</th><th width="181">例子</th><th>描述</th></tr></thead><tbody><tr><td><code>price</code></td><td>float</td><td><code>0.055</code></td><td>交易价格</td></tr><tr><td><code>time</code></td><td>long</td><td><code>1537797044116</code></td><td>当前Unix时间戳，毫秒(ms)</td></tr><tr><td><code>qty</code></td><td>float</td><td><code>5</code></td><td>数量（张数）</td></tr><tr><td><code>side</code></td><td>string</td><td><code>buy/sell</code></td><td>主动单方向</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## K线/蜡烛图数据

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/klines`

#### Query Parameters

| Name                                       | Type    | Description                                                                                                  |
| ------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------ |
| symbol<mark style="color:red;">\*</mark>   | string  | 大写币对名称 例如`BTCUSDT`                                                                                           |
| interval<mark style="color:red;">\*</mark> | string  | k线图区间, 可识别发送的值为： `1min`,`5min`,`15min`,`30min`,`60min`,`1day`,`1week`,`1month`（min=分钟，day=天，week=星期，month=月） |
| limit                                      | integer | 默认100; 最大300                                                                                                 |

{% tabs %}
{% tab title="200 " %}

```java
[
    {
        "high": "6228.77",
        "vol": "111",
        "low": "6228.77",
        "idx": 1594640340,
        "close": "6228.77",
        "open": "6228.77"
    },
    {
        "high": "6228.77",
        "vol": "222",
        "low": "6228.77",
        "idx": 1587632160,
        "close": "6228.77",
        "open": "6228.77"
    },
    {
        "high": "6228.77",
        "vol": "333",
        "low": "6228.77",
        "idx": 1587632100,
        "close": "6228.77",
        "open": "6228.77"
    }
]
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="165">名称</th><th width="127">类型</th><th width="167">例子</th><th>描述</th></tr></thead><tbody><tr><td><code>idx</code></td><td>long</td><td><code>1538728740000</code></td><td>开始时间戳，毫秒（ms）</td></tr><tr><td><code>open</code></td><td>float</td><td><code>36.00</code></td><td>开盘价</td></tr><tr><td><code>close</code></td><td>float</td><td><code>33.00</code></td><td>收盘价</td></tr><tr><td><code>high</code></td><td>float</td><td><code>36.00</code></td><td>最高价</td></tr><tr><td><code>low</code></td><td>float</td><td><code>30.00</code></td><td>最低价</td></tr><tr><td><code>vol</code></td><td>float</td><td><code>2456.11</code></td><td>成交量</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## 交易

### 安全类型: TRADE

交易下方的接口都需要签名和API-key验证

***

## &#x20;创建新订单

<mark style="color:green;">`POST`</mark> `https://openapi.xxx.com/sapi/v1/order`

\
\
**限速规则: 100次/2s**

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

#### Request Body

| Name                                     | Type   | Description                                                                                       |
| ---------------------------------------- | ------ | ------------------------------------------------------------------------------------------------- |
| symbol<mark style="color:red;">\*</mark> | string | 币对名称,不限制大小写 例如 `BTCUSDT 或 btcusdt`                                                                |
| volume<mark style="color:red;">\*</mark> | number | 订单数量，有精度限制，精度由管理员配置                                                                               |
| side<mark style="color:red;">\*</mark>   | string | 订单方向, `BUY/SELL`                                                                                  |
| type<mark style="color:red;">\*</mark>   | string | 订单类型, `LIMIT/MARKET`                                                                              |
| price                                    | number | 订单价格, 对于`LIMIT`订单必须发送，有精度限制，精度由管理员配置                                                              |
| newClientOrderId                         | string | 该字段为第三方标识字段，不参与交易所业务逻辑处理、也不存入数据库，只在响应中原样返回 <mark style="color:red;">(该字段不是交易所业务订单id，请注意区分)</mark> |

{% tabs %}
{% tab title="200  发送新订单成功" %}

```json
{
    "symbol": "ETHUSDT",
    "side": "BUY",
    "executedQty": 0,
    "orderId": [
        "2012274607240433332"
    ],
    "price": 0,
    "origQty": 0.01,
    "clientOrderId": "1212",
    "transactTime": 1704959985403,
    "type": "MARKET",
    "status": "NEW"
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="186">名称</th><th width="111">类型</th><th width="191">例子</th><th>描述</th></tr></thead><tbody><tr><td><code>orderId</code></td><td>long</td><td><code>150695552109032492</code></td><td>订单ID（系统生成）</td></tr><tr><td><code>clientOrderId</code></td><td>string</td><td><code>213443</code></td><td>订单ID（客户端入参发送）</td></tr><tr><td><code>symbol</code></td><td>string</td><td><code>BTCUSDT</code></td><td>大写币对名称</td></tr><tr><td><code>transactTime</code></td><td>integer</td><td><code>1273774892913</code></td><td>订单创建时间</td></tr><tr><td><code>price</code></td><td>float</td><td><code>4765.29</code></td><td>订单价格</td></tr><tr><td><code>origQty</code></td><td>float</td><td><code>1.01</code></td><td>订单数量</td></tr><tr><td><code>executedQty</code></td><td>float</td><td><code>1.01</code></td><td>已经成交订单数量</td></tr><tr><td><code>type</code></td><td>string</td><td><code>LIMIT</code></td><td>订单类型<code>LIMIT</code>(限价)<code>MARKET</code>（市价）</td></tr><tr><td><code>side</code></td><td>string</td><td><code>BUY</code></td><td>订单方向。可能出现的值只能为：<code>BUY</code>（买入做多） 和 <code>SELL</code>（卖出做空）</td></tr><tr><td><code>status</code></td><td>string</td><td><code>New Order</code></td><td><p>订单状态。可能出现的值为：New Order(新订单，无成交)、Partially Filled（部分成交）、Filled（全部成交）、</p><p>Partially Filled/Cancelled（部分成交/已取消，没有完全成交的订单被主动取消后的状态）</p><p>Cancelled（已取消）</p></td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## &#x20;创建测试订单

<mark style="color:green;">`POST`</mark> `https://openapi.xxx.com/sapi/v1/order/test`

\
\
创建和验证新订单, 但不会送入撮合引擎

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

#### Request Body

| Name                                     | Type   | Description                                                                                       |
| ---------------------------------------- | ------ | ------------------------------------------------------------------------------------------------- |
| symbol<mark style="color:red;">\*</mark> | string | 大写币对名称  `BTCUSDT`                                                                                 |
| volume<mark style="color:red;">\*</mark> | number | 订单数量，有精度限制，由管理员配置                                                                                 |
| side<mark style="color:red;">\*</mark>   | string | 订单方向, `BUY/SELL`                                                                                  |
| type<mark style="color:red;">\*</mark>   | string | 订单类型, `LIMIT/MARKET`                                                                              |
| price                                    | number | 订单价格, 对于`LIMIT`订单必须发送，有精度限制，由管理员配置                                                                |
| newClientOrderId                         | string | 该字段为第三方标识字段，不参与交易所业务逻辑处理、也不存入数据库，只在响应中原样返回 <mark style="color:red;">(该字段不是交易所业务订单id，请注意区分)</mark> |

{% tabs %}
{% tab title="200  创建测试订单成功" %}

```
{}
```

{% endtab %}
{% endtabs %}

***

## &#x20;批量下单

<mark style="color:green;">`POST`</mark> `https://openapi.xxx.com/sapi/v1/batchOrders`

\
\
**限速规则: 50次/2s 一个批量最多10个订单**

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

#### Request Body

| Name                                     | Type   | Description       |
| ---------------------------------------- | ------ | ----------------- |
| orders<mark style="color:red;">\*</mark> | array  | 批量订单信息 最多10条      |
| symbol<mark style="color:red;">\*</mark> | string | 大写币对名称  `BTCUSDT` |

{% tabs %}
{% tab title="200 " %}

```java
{
    "ids": [
        165964665990709251,
        165964665990709252,
        165964665990709253
    ]
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Resquest orders field:" %}

<table><thead><tr><th width="167">名称</th><th width="163">类型</th><th>例子</th><th>描述</th></tr></thead><tbody><tr><td><code>price</code></td><td>float</td><td>1000.00</td><td>价格</td></tr><tr><td><code>volume</code></td><td>float</td><td>20.10</td><td>数量</td></tr><tr><td><code>side</code></td><td>string</td><td><code>BUY/SELL</code></td><td>方向</td></tr><tr><td><code>batchType</code></td><td>string</td><td><code>LIMIT/MARKET</code></td><td>类型</td></tr><tr><td>symbol</td><td>string</td><td>ETHUSDT</td><td>币对名称</td></tr></tbody></table>
{% endtab %}

{% tab title="Example of request" %}
{% code title="Example of request" %}

```json
{"symbol":"ETHUSDT","orders":[{"side":"BUY","price":1980.00,"volume":1,"batchType":"MARKET"}]}
```

{% endcode %}
{% endtab %}
{% endtabs %}

***

## &#x20;订单查询

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/order`

\
\
**限速规则: 20次/2s**

#### Query Parameters

| Name                                      | Type   | Description        |
| ----------------------------------------- | ------ | ------------------ |
| orderId<mark style="color:red;">\*</mark> | string | 订单id               |
| symbol<mark style="color:red;">\*</mark>  | string | 小写币对名称 例如`ethusdt` |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

{% tabs %}
{% tab title="200 " %}

```json
{
    "symbol": "ethusdt",
    "side": "BUY",
    "executedQty": 0E-16,
    "orderId": 53,
    "price": 20200.00,
    "origQty": 0.024,
    "avgPrice": 0E-16,
    "transactTime": 1672274311107,
    "type": "LIMIT",
    "status": "PENDING_CANCEL"
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="185">名称</th><th width="91">类型</th><th width="216">例子</th><th>描述</th></tr></thead><tbody><tr><td><code>orderId</code></td><td>long</td><td><code>150695552109032492</code></td><td>订单ID（系统生成）</td></tr><tr><td><code>clientOrderId</code></td><td>string</td><td><code>213443</code></td><td>订单ID（用户发送的）</td></tr><tr><td><code>symbol</code></td><td>string</td><td>ethusdt</td><td>小写币对名称</td></tr><tr><td><code>price</code></td><td>float</td><td><code>4765.29</code></td><td>订单价格</td></tr><tr><td><code>origQty</code></td><td>float</td><td><code>1.01</code></td><td>订单数量</td></tr><tr><td><code>executedQty</code></td><td>float</td><td><code>1.01</code></td><td>已经成交订单数量</td></tr><tr><td><code>avgPrice</code></td><td>float</td><td><code>4754.24</code></td><td>订单已经成交的平均价格</td></tr><tr><td><code>type</code></td><td>string</td><td><code>LIMIT</code></td><td>订单类型。可能出现的值只能为:<code>LIMIT</code>(限价)和<code>MARKET</code>（市价）</td></tr><tr><td>transactTime</td><td>long</td><td>1672274311107</td><td>时间戳</td></tr><tr><td><code>side</code></td><td>string</td><td><code>BUY</code></td><td>订单方向。可能出现的值只能为：<code>BUY</code>（买入做多） 和 <code>SELL</code>（卖出做空）</td></tr><tr><td><code>status</code></td><td>string</td><td><code>New Order</code></td><td><p>订单状态。可能出现的值为：New Order(新订单，无成交)、Partially Filled（部分成交）、Filled（全部成交）、</p><p>Partially Filled/Cancelled（部分成交/已取消，没有完全成交的订单被主动取消后的状态）</p><p>Cancelled（已取消）</p></td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## &#x20;撤销订单

<mark style="color:green;">`POST`</mark> `https://openapi.xxx.com/sapi/v1/cancel`

\
\
**限速规则: 100次/2s**

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

#### Request Body

| Name                                      | Type   | Description        |
| ----------------------------------------- | ------ | ------------------ |
| orderId<mark style="color:red;">\*</mark> | string | 订单id               |
| symbol<mark style="color:red;">\*</mark>  | string | 小写币对名称 例如  ethusdt |

{% tabs %}
{% tab title="200  撤销订单成功" %}

```json
{
    "symbol": "ethusdt",
    "orderId": [
        "1938321163093079425"
    ],
    "status": "PENDING_CANCEL"
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="148">名称</th><th width="97">类型</th><th width="220">例子</th><th>描述</th></tr></thead><tbody><tr><td><code>orderId</code></td><td>long</td><td><code>150695552109032492</code></td><td>订单ID（系统生成</td></tr><tr><td><code>symbol</code></td><td>string</td><td>ethusdt</td><td>币对名称</td></tr><tr><td><code>status</code></td><td>string</td><td>To be Cancelled</td><td>订单状态：To be Cancelled</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## &#x20;批量撤销订单

<mark style="color:green;">`POST`</mark> `https://openapi.xxx.com/sapi/v1/batchCancel`

\
\
**限速规则: 50次/2s 一次批量最多10个订单**

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

#### Request Body

| Name                                       | Type   | Description                                                       |
| ------------------------------------------ | ------ | ----------------------------------------------------------------- |
| symbol<mark style="color:red;">\*</mark>   | string | 大写币对名称 例如 `BTCUSDT`                                               |
| orderIds<mark style="color:red;">\*</mark> | array  | 要取消的订单id集合, <mark style="color:red;">id值以数字格式输入</mark>`[123,456]` |

{% tabs %}
{% tab title="200 " %}
{% code title="Return successful" %}

```java
{
    "success": [
        165964665990709251,
        165964665990709252,
        165964665990709253
    ],
    "failed": [ //取消失败一般是因为订单不存在或订单状态已经到终态
        165964665990709250  
    ]
}
```

{% endcode %}

{% code title="Return failed" %}

```json
{} //通常是因为订单号错误，需要检查orderIds里的内容是否正确
```

{% endcode %}
{% endtab %}
{% endtabs %}

***

## &#x20;当前订单

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/openOrders`

\
\
**限速规则: 20次/2s**

#### Query Parameters

| Name                                     | Type    | Description       |
| ---------------------------------------- | ------- | ----------------- |
| symbol<mark style="color:red;">\*</mark> | string  | 小写币对名称 例如 ethusdt |
| limit<mark style="color:red;">\*</mark>  | integer | 最大1000            |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

{% tabs %}
{% tab title="200 " %}

```json
[
    {
        "symbol": "ETHUSDT",
        "side": "BUY",
        "executedQty": "0",
        "orderId": 1938321163093077686,
        "price": "0",
        "origQty": "0.10",
        "avgPrice": "0",
        "time": 1701240367864,
        "type": "MARKET",
        "status": "NEW_"
    },
    {
        "symbol": "ETHUSDT",
        "side": "BUY",
        "executedQty": "0",
        "orderId": 1938321163093078022,
        "price": "0",
        "origQty": "0.01",
        "avgPrice": "0",
        "time": 1701243281850,
        "type": "MARKET",
        "status": "NEW_"
    }
]
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="168">名称</th><th width="87">类型</th><th width="219">例子</th><th>描述</th></tr></thead><tbody><tr><td><code>orderId</code></td><td>long</td><td><code>150695552109032492</code></td><td>订单ID（系统生成）</td></tr><tr><td><code>symbol</code></td><td>string</td><td><code>BTCUSDT</code></td><td>币对名称</td></tr><tr><td><code>price</code></td><td>float</td><td><code>4765.29</code></td><td>订单价格</td></tr><tr><td><code>origQty</code></td><td>float</td><td><code>1.01</code></td><td>订单数量</td></tr><tr><td><code>executedQty</code></td><td>float</td><td><code>1.01</code></td><td>已经成交订单数量</td></tr><tr><td><code>avgPrice</code></td><td>float</td><td><code>4754.24</code></td><td>订单已经成交的平均价格</td></tr><tr><td><code>type</code></td><td>string</td><td><code>LIMIT</code></td><td>订单类型。可能出现的值只能为:<code>LIMIT</code>(限价)和<code>MARKET</code>（市价）</td></tr><tr><td>time</td><td>long</td><td>1701243281850</td><td>时间戳</td></tr><tr><td><code>side</code></td><td>string</td><td><code>BUY</code></td><td>订单方向。可能出现的值只能为：<code>BUY</code>（买入做多） 和 <code>SELL</code>（卖出做空）</td></tr><tr><td><code>status</code></td><td>string</td><td><code>New Order</code></td><td><p>订单状态。可能出现的值为：New Order(新订单，无成交)、Partially Filled（部分成交）、Filled（全部成交）、</p><p>Partially Filled/Cancelled（部分成交/已取消，没有完全成交的订单被主动取消后的状态）</p><p>Cancelled（已取消）</p></td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## &#x20;交易记录

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/myTrades`

\
\
**限速规则: 20次/2s**

#### Query Parameters

| Name                                     | Type   | Description         |
| ---------------------------------------- | ------ | ------------------- |
| symbol<mark style="color:red;">\*</mark> | string | 大写币对名称 例如 `BTCUSDT` |
| limit<mark style="color:red;">\*</mark>  | string | 默认100; 最大1000       |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

{% tabs %}
{% tab title="200 " %}

```json
[
    {
        "symbol": "ETHUSDT",
        "side": "BUY",
        "fee": "0.00000000428",
        "isMaker": false,
        "isBuyer": true,
        "bidId": 1954603951049381893,
        "bidUserId": 10083,
        "feeCoin": "ETH",
        "price": "2334",
        "qty": "0.00000428",
        "askId": 1856176838352995447,
        "id": 159,
        "time": 1701623660989,
        "isSelf": false,
        "askUserId": 10671
    },
    {
        "symbol": "ETHUSDT",
        "side": "BUY",
        "fee": "0.00000004284",
        "isMaker": false,
        "isBuyer": true,
        "bidId": 1938321163093068889,
        "bidUserId": 10083,
        "feeCoin": "ETH",
        "price": "2334",
        "qty": "0.00004284",
        "askId": 1856176838352995447,
        "id": 158,
        "time": 1701165091964,
        "isSelf": false,
        "askUserId": 10671
    }
]
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

<table><thead><tr><th width="131">名称</th><th width="96">类型</th><th width="221">例子</th><th>描述</th></tr></thead><tbody><tr><td><code>symbol</code></td><td>string</td><td><code>ETHBTC</code></td><td>大写币种名称(交易对)</td></tr><tr><td><code>id</code></td><td>integer</td><td><code>28457</code></td><td>交易ID</td></tr><tr><td><code>bidId</code></td><td>long</td><td><code>150695552109032492</code></td><td>买方订单ID</td></tr><tr><td><code>askId</code></td><td>long</td><td><code>150695552109032493</code></td><td>卖方订单ID</td></tr><tr><td><code>price</code></td><td>integer</td><td><code>4.01</code></td><td>交易时间戳</td></tr><tr><td><code>qty</code></td><td>float</td><td><code>12</code></td><td>交易数量</td></tr><tr><td><code>time</code></td><td>number</td><td><code>1499865549590</code></td><td>交易时间戳</td></tr><tr><td><code>isBuyer</code></td><td>boolean</td><td><code>true</code></td><td><code>true</code>= Buyer <code>false</code>= Seller</td></tr><tr><td><code>isMaker</code></td><td>boolean</td><td><code>false</code></td><td><code>true</code>=Maker <code>false</code>=Taker</td></tr><tr><td><code>feeCoin</code></td><td>string</td><td><code>ETH</code></td><td>交易手续费币种</td></tr><tr><td><code>fee</code></td><td>number</td><td><code>0.01</code></td><td>交易手续费</td></tr><tr><td>bidUserId</td><td>integer</td><td>10083</td><td>买方用户uid</td></tr><tr><td>askUserId</td><td>integer</td><td>10094</td><td>卖方用户uid</td></tr><tr><td>isSelf</td><td>boolean</td><td>false</td><td>是否为自成交<br>true = 是自成交<br>false = 不是自成交</td></tr><tr><td>side</td><td>string</td><td>BUY</td><td>主动单方向 BUY/SELL</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

***

## 账户

### 安全类型: USER\_DATA

账户下方的接口都需要签名和API-key验证

***

## &#x20;账户信息

<mark style="color:blue;">`GET`</mark> `https://openapi.xxx.com/sapi/v1/account`

\
\
**限速规则: 20次/2s**

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| X-CH-SIGN<mark style="color:red;">\*</mark>   | string  | 签名          |
| X-CH-APIKEY<mark style="color:red;">\*</mark> | string  | 您的API-key   |
| X-CH-TS<mark style="color:red;">\*</mark>     | integer | 时间戳         |

{% tabs %}
{% tab title="200  获取账户信息成功" %}

```json
{
    "balances": [
        {
            "asset": "ABAT",
            "free": "10.00",
            "locked": "20.00"
        },
        {
            "asset": "DOT",
            "free": "10.00",
            "locked": "10.00"
        },
        {
            "asset": "TT",
            "free": "50.00",
            "locked": "50.00"
        }
]
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Response:" %}

| 名称           | 类型   | 描述     |
| ------------ | ---- | ------ |
| `balances`   | `[]` | 账户余额集合 |
| {% endtab %} |      |        |

{% tab title="Balances field:" %}

<table><thead><tr><th width="178">名称</th><th width="150">类型</th><th width="179">例子</th><th>描述</th></tr></thead><tbody><tr><td><code>asset</code></td><td>string</td><td><code>USDT</code></td><td>币种名称</td></tr><tr><td><code>free</code></td><td>float</td><td>1000.30</td><td>账户可用金额</td></tr><tr><td><code>locked</code></td><td>float</td><td>400</td><td>账户冻结金额</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
