币币交易

公共

安全类型: 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
}

币对列表

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

市场支持的币对集合

200 获取币对列表成功

{
    "symbols": [
        {
            "quantityPrecision": 3,
            "symbol": "sccadai",
            "pricePrecision": 6,
            "baseAsset": "SCCA",
            "quoteAsset": "DAI"
        },
        {
            "quantityPrecision": 8,
            "symbol": "btcusdt",
            "pricePrecision": 2,
            "baseAsset": "BTC",
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 3,
            "symbol": "bchusdt",
            "pricePrecision": 2,
            "baseAsset": "BCH",
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 2,
            "symbol": "etcusdt",
            "pricePrecision": 2,
            "baseAsset": "ETC",
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 2,
            "symbol": "ltcbtc",
            "pricePrecision": 6,
            "baseAsset": "LTC",
            "quoteAsset": "BTC"
        }
    ]
}

Response:

名称	类型	例子	描述
symbol	string	BTCUSDT	币对名称
baseAsset	string	BTC	base货币
quoteAsset	string	USDT	计价货币
pricePrecision	integer	2	价格精度
quantityPrecision	integer	6	数量精度

行情

安全类型: None

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

订单薄

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

市场订单薄深度信息

Query Parameters

Name	Type	Description
limit	integer	默认100; 最大100
symbol	string	币对名称 E.g. BTCUSDT

200 成功获取深度信息

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

Response:

名称	类型	例子	描述
time	long	1595563624731	当前时间(Unix Timestamp, 毫秒ms)
bids	list	如下	订单薄买盘信息
asks	list	如下	订单薄卖盘信息

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

名称	类型	例子	描述
' '	float	131.1	价格
' '	float	2.3	当前价格对应的数量

行情ticker

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

24小时价格变化数据

Query Parameters

Name	Type	Description
symbol	string	币对名称 E.g. BTCUSDT

200 成功获取ticker信息

{
    "high": "9279.0301",
    "vol": "1302",
    "last": "9200",
    "low": "9279.0301",
    "rose": "0",
    "time": 1595563624731
}

Response:

名称	类型	例子	描述
time	long	1595563624731	时间戳
high	float	9900	最高价
low	float	8800.34	最低价
open	float	8700	开盘价
last	float	8900	最新价
vol	float	4999	交

交易

安全类型: 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	币对名称 E.g. BTCUSDT
volume	number	订单数量
side	string	订单方向, BUY/SELL
type	string	订单类型, LIMIT/MARKET
price	number	订单价格, 对于LIMIT订单必须发送
newClientOrderId	string	客户端订单标识
recvWindow	integer	时间窗口

200 发送新订单成功

{
    'symbol': 'LXTUSDT', 
    'orderId': '150695552109032492', 
    'clientOrderId': '157371322565051',
    'transactTime': '1573713225668', 
    'price': '0.005452', 
    'origQty': '110', 
    'executedQty': '0', 
    'status': 'NEW',
    'type': 'LIMIT', 
    'side': 'SELL'
}

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	订单状态。可能出现的值为：NEW(新订单，无成交)、PARTIALLY_FILLED（部分成交）、FILLED（全部成交）、CANCELED（已取消）和REJECTED（订单被拒绝）.

创建测试订单

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
recvWindow	integer	时间窗口
symbol	string	币对名称 E.g. BTCUSDT
volume	number	订单数量
side	string	订单方向, BUY/SELL
type	string	订单类型, LIMIT/MARKET
price	number	订单价格, 对于LIMIT订单必须发送
newClientOrderId	string	客户端订单标识

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	币对名称 E.g. BTCUSDT

200

{
    "mass_place": [
        {
            "msg": "Success",
            "order_id": [
                150951796778795013,
                150951796778795014
            ],
            "code": "0"
        }
    ],
    "mass_cancel": []
}

Resquest orders field:

名称	类型	例子	描述
price	folat	1000	价格
volume	folat	20.1	数量
side	string	BUY/SELL	方向
batchType	string	LIMIT/MARKET	类型

订单查询

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

限速规则: 20次/2s

Query Parameters

Name	Type	Description
orderId	string	订单id
newClientOrderId	string	客户端订单标识
symbol	string	币对名称 E.g. BTCUSDT

Headers

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

200

{
    'orderId': '499890200602846976', 
    'clientOrderId': '157432755564968', 
    'symbol': 'BHTUSDT', 
    'price': '0.01', 
    'origQty': '50', 
    'executedQty': '0', 
    'avgPrice': '0', 
    'status': 'NEW', 
    'type': 'LIMIT', 
    'side': 'BUY', 
    'transactTime': '1574327555669'
}

Response:

名称	类型	例子	描述
orderId	long	150695552109032492	订单ID（系统生成）
clientOrderId	string	213443	订单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（市价）
side	string	BUY	订单方向。可能出现的值只能为：BUY（买入做多） 和 SELL（卖出做空）
status	string	NEW	订单状态。可能出现的值为：NEW(新订单，无成交)、PARTIALLY_FILLED（部分成交）、FILLED（全部成交）、CANCELED（已取消）和REJECTED（订单被拒绝）.

撤销订单

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
newClientOrderId	string	客户端订单标识
symbol	string	币对名称 E.g. BTCUSDT

200 撤销订单成功

{
    'symbol': 'BHTUSDT', 
    'clientOrderId': '0', 
    'orderId': '499890200602846976', 
    'status': 'CANCELED'
}

Response:

名称	类型	例子	描述
orderId	long	150695552109032492	订单ID（系统生成
clientOrderId	string	213443	订单ID（自己发送的）
symbol	string	BHTUSDT	币对名称
status	string	NEW	订单状态。可能出现的值为：NEW(新订单，无成交)、PARTIALLY_FILLED（部分成交）、FILLED（全部成交）、CANCELED（已取消）和REJECTED（订单被拒绝）

批量撤销订单

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	币对名称 E.g. BTCUSDT
orderIds	array	要取消的订单id集合 [123,456]

200

{
    "mass_place": [],
    "mass_cancel": [
        {
            "msg": "Success",
            "order_id": [
                150695662109032492
            ],
            "code": "0"
        }
    ]
}

当前订单

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

限速规则: 20次/2s

Query Parameters

Name	Type	Description
symbol	string	币对名称 E.g. BTCUSDT
limit	integer	默认100; 最大1000

Headers

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

200

[
    {
        'orderId': '499902955766523648', 
        'symbol': 'BHTUSDT', 
        'price': '0.01', 
        'origQty': '50', 
        'executedQty': '0', 
        'avgPrice': '0', 
        'status': 'NEW', 
        'type': 'LIMIT', 
        'side': 'BUY', 
        'time': '1574329076202'
        },...
]

Response:

名称	类型	例子	描述
orderId	long	150695552109032492	订单ID（系统生成）
clientOrderId	string	213443	订单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（市价）
side	string	BUY	订单方向。可能出现的值只能为：BUY（买入做多） 和 SELL（卖出做空）
status	string	NEW	订单状态。可能出现的值为：NEW(新订单，无成交)、PARTIALLY_FILLED（部分成交）、FILLED（全部成交）、CANCELED（已取消）和REJECTED（订单被拒绝）.

交易记录

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

限速规则: 20次/2s

Query Parameters

Name	Type	Description
symbol	string	币对名称 E.g. BTCUSDT
limit	string	默认100; 最大1000
fromId	integer	从这个tradeId开始检索

Headers

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

200

[
  {
    "symbol": "ETHBTC",
    "id": 100211,
    "bidId": 150695552109032492,
    "askId": 150695552109032493,
    "price": "4.00000100",
    "qty": "12.00000000",
    "time": 1499865549590,
    "isBuyer": true,
    "isMaker": false,
    "feeCoin": "ETH",
    "fee":"0.001"
  },...
]

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	bool	true	true= Buyer false= Seller
isMaker	bool	false	true=Maker false=Taker
feeCoin	string	ETH	交易手续费币种
fee	number	0.001	交易手续费

账户

安全类型: 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': 'BTC', 
                'free': '0', 
                'locked': '0'
                }, 
            {
                'asset': 'ETH', 
                'free': '0', 
                'locked': '0'
                },...
        ]
}

Response:

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

balances field:

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