现货交易

公共

安全类型: None

公共类型接口不需要API-key或者签名就能自由访问

---

测试连接

GET https://openapi.xxx.com/sapi/v1/ping

测试REST API的连通性

200 连接正常

{}

---

服务器时间

GET https://openapi.xxx.com/sapi/v1/time

服务器时间

200 获取服务器时间成功

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

服务器时间返参:

名称	类型	例子	描述
timezone	string	China Standard Time	服务器时区
serverTime	long	1705039779880	服务器时间戳

---

币对列表

GET https://openapi.xxx.com/sapi/v1/symbols

市场支持的币对集合

200 获取币对列表成功

{
    "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"
        }
    ]
}

Response:

名称	类型	例子	描述
symbol	string	btcusdt	小写币对名称
baseAsset	string	BTC	base货币
quoteAsset	string	USDT	计价货币
pricePrecision	integer	2	价格精度
quantityPrecision	integer	6	数量精度
limitVolumeMin	BigDecimal	0.00001	限价单最小数量限制
marketBuyMin	BigDecimal	0.00001	市价单最小购买数量
marketSellMin	BigDecimal	0.00001	市价单最小卖出数量
limitPriceMin	BigDecimal	0.00001	限价单最小价格限制

---

行情

安全类型: None

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

---

订单薄

GET https://openapi.xxx.com/sapi/v1/depth

市场订单薄深度信息

Query Parameters

Name	Type	Description
limit*	integer	默认100; 最大100
symbol*	string	大写币对名称 例如：BTCUSDT

200 成功获取深度信息

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

Response:

名称	类型	例子	描述
time	long	1595563624731	当前时间(Unix Timestamp, 毫秒ms)
bids	array	[[1.3200,2.04],[0.2,0.4]]	订单薄买盘信息，数组长度为2，角标1为价格，类型为float；角标2为当前价格对应的数量，类型为float
asks	array	[[1.3200,2.04],[0.2,0.4]]	订单薄卖盘信息，数组长度为2，角标1为价格，类型为float；角标2为当前价格对应的数量，类型为float

bids和asks所对应的信息代表了订单薄的所有价格以及价格对应的数量的信息, 由最优价格从上到下排列

---

行情ticker

GET https://openapi.xxx.com/sapi/v1/ticker

24小时价格变化数据

Query Parameters

Name	Type	Description
symbol*	string	大写币对名称 例如 BTCUSDT

200 成功获取ticker信息

{
    "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
}

Response:

名称	类型	例子	描述
time	long	1595563624731	时间戳
high	float	9900	最高价
low	float	8800.34	最低价
last	float	8900	最新成交价
vol	float	4999	交易量
amount	float	23.20	交易额
buy	float	130	买一价格
sell	float	120	卖一价格
rose	string	+0.05	涨跌幅，+为涨，-为跌，+0.05为涨5%

---

最近成交

GET https://openapi.xxx.com/sapi/v1/trades

Query Parameters

Name	Type	Description
symbol*	string	大写币对名称 例如 BTCUSDT
limit*	string	默认100; 最大1000

200

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

Response:

名称	类型	例子	描述
price	float	0.055	交易价格
time	long	1537797044116	当前Unix时间戳，毫秒(ms)
qty	float	5	数量（张数）
side	string	buy/sell	主动单方向

---

K线/蜡烛图数据

GET https://openapi.xxx.com/sapi/v1/klines

Query Parameters

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

200

[
    {
        "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"
    }
]

Response:

名称	类型	例子	描述
idx	long	1538728740000	开始时间戳，毫秒（ms）
open	float	36.00	开盘价
close	float	33.00	收盘价
high	float	36.00	最高价
low	float	30.00	最低价
vol	float	2456.11	成交量

---

交易

安全类型: TRADE

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

---

创建新订单

POST https://openapi.xxx.com/sapi/v1/order

限速规则: 100次/2s

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

Request Body

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

200 发送新订单成功

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

Response:

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

---

创建测试订单

POST https://openapi.xxx.com/sapi/v1/order/test

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

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

Request Body

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

200 创建测试订单成功

{}

---

批量下单

POST https://openapi.xxx.com/sapi/v1/batchOrders

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

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

Request Body

Name	Type	Description
orders*	array	批量订单信息 最多10条
symbol*	string	大写币对名称 BTCUSDT

200

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

Resquest orders field:

名称	类型	例子	描述
price	float	1000.00	价格
volume	float	20.10	数量
side	string	BUY/SELL	方向
batchType	string	LIMIT/MARKET	类型
symbol	string	ETHUSDT	币对名称

Example of request

Example of request

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

---

订单查询

GET https://openapi.xxx.com/sapi/v1/order

限速规则: 20次/2s

Query Parameters

Name	Type	Description
orderId*	string	订单id
symbol*	string	小写币对名称 例如ethusdt

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

200

{
    "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"
}

Response:

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

---

撤销订单

POST https://openapi.xxx.com/sapi/v1/cancel

限速规则: 100次/2s

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

Request Body

Name	Type	Description
orderId*	string	订单id
symbol*	string	小写币对名称 例如 ethusdt

200 撤销订单成功

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

Response:

名称	类型	例子	描述
orderId	long	150695552109032492	订单ID（系统生成
symbol	string	ethusdt	币对名称
status	string	To be Cancelled	订单状态：To be Cancelled

---

批量撤销订单

POST https://openapi.xxx.com/sapi/v1/batchCancel

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

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

Request Body

Name	Type	Description
symbol*	string	大写币对名称 例如 BTCUSDT
orderIds*	array	要取消的订单id集合, id值以数字格式输入[123,456]

200

Return successful

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

Return failed

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

---

当前订单

GET https://openapi.xxx.com/sapi/v1/openOrders

限速规则: 20次/2s

Query Parameters

Name	Type	Description
symbol*	string	小写币对名称 例如 ethusdt
limit*	integer	最大1000

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

200

[
    {
        "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_"
    }
]

Response:

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

---

交易记录

GET https://openapi.xxx.com/sapi/v1/myTrades

限速规则: 20次/2s

Query Parameters

Name	Type	Description
symbol*	string	大写币对名称 例如 BTCUSDT
limit*	string	默认100; 最大1000

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

200

[
    {
        "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
    }
]

Response:

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

---

账户

安全类型: USER_DATA

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

---

账户信息

GET https://openapi.xxx.com/sapi/v1/account

限速规则: 20次/2s

Headers

Name	Type	Description
X-CH-SIGN*	string	签名
X-CH-APIKEY*	string	您的API-key
X-CH-TS*	integer	时间戳

200 获取账户信息成功

{
    "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"
        }
]

Response:

名称	类型	描述
balances	[]	账户余额集合

Balances field:

名称	类型	例子	描述
asset	string	USDT	币种名称
free	float	1000.30	账户可用金额
locked	float	400	账户冻结金额