行情API
示例
// Request
// Response
{
"code": 0,
"data": [
"LTCBCH",
"ETHBCH",
"ZECBCH",
"DASHBCH"
],
"message": "Ok"
}
GET /market/list- 获取所有市场列表，适用于币币和杠杆市场
- 是否需要签名：否
示例
// Request
// Response
{
"code": 0,
"message": "Ok",
"data":
{
"XRPBTC":
{
"taker_fee_rate": "0.001",
"pricing_name": "BTC",
"trading_name": "XRP",
"min_amount": "0.001",
"name": "XRPBTC",
"trading_decimal": 8,
"maker_fee_rate": "0.001",
"pricing_decimal": 8
},
"CETUSDC":
{
"taker_fee_rate": "0.001",
"pricing_name": "USDC",
"trading_name": "CET",
"min_amount": "0.001",
"name": "CETUSDC",
"trading_decimal": 8,
"maker_fee_rate": "0.001",
"pricing_decimal": 8
}
}
}
GET /market/info- 获取所有市场详细信息，适用于币币和杠杆市场
-
是否需要签名：否
-
返回参数说明
名称 类型 描述 name String 市场名称 taker_fee_rate String taker 费率 maker_fee_rate String maker 费率 min_amount String 最小交易量 trading_name String 交易币种 trading_decimal Integer 交易币种精度 pricing_name String 定价币种 pricing_decimal Integer 定价币种精度
示例
// Request
market=BTCUSDT
// Response
{
"code": 0,
"message": "Ok",
"data":
{
"taker_fee_rate": "0.001",
"pricing_name": "USDT",
"trading_name": "BTC",
"min_amount": "0.001",
"name": "BTCUSDT",
"trading_decimal": 8,
"maker_fee_rate": "0.001",
"pricing_decimal": 8
}
}
GET /market/detail- 获取单个市场详细信息，适用于币币和杠杆市场
- 是否需要签名：否
-
请求参数说明
名称 类型 是否必须 描述 market String Yes 市场名称 - 返回参数说明
同获取所有市场信息接口
示例
// Request
market=ETHUSDT
&merge=0.01
&limit=10
// Response
{
"code": 0,
"data": {
"last": "10.00",
"time": 1539764050033,
"asks": [
[
"10.00",
"0.9999"
]
],
"bids": [
[
"10.00",
"1.0000"
]
]
},
"message": "Ok"
}
GET /market/depth- 获取单个市场深度，适用于币币和杠杆市场
- 是否需要签名：否
-
最大深度50
-
请求参数说明
名称 类型 是否必须 描述 market String Yes 市场名称 merge String Yes ‘0’, ‘0.1’, ‘0.01’, ‘0.001’, ‘0.0001’, ‘0.00001’, ‘0.000001’, ‘0.0000001’, ‘0.00000001 limit Interger No(Default20) 返回数量，range: 5/10/20/50 -
返回参数说明
名称 类型 描述 last String 最新成交价 time Long 深度更新时间 asks Array 卖方深度 asks[0][0] String 下单价格 asks[0][1] String 下单量 bids Array 买方深度 bids[0][0] String 下单价格 bids[0][1] String 下单量
示例
// Request
market=ETHUSDT
&last_id=0
&limit=10
// Response
{
"code": 0,
"data": [
{
"amount": "0.0001", # Transaction amount
"date": 1494214689, # Transaction time(s)
"date_ms": 1494214689067, # Transaction time(ms)
"id": 5, # Transaction No
"price": "10.00", # Transaction price
"type": "buy" # Transaction type: buy, sell
}
],
"message": "Ok"
}
GET /market/deals- 获取单个市场最新交易数据，适用于币币和杠杆市场
- 是否需要签名：否
-
最大返回1000条记录
-
请求参数说明
名称 类型 是否必须 描述 market String Yes 市场名称 last_id Integer No 交易id，0代表从最新记录获取 limit Integer No(default 100) 最大1000 -
返回参数说明
名称 类型 描述 id Integer 交易id date Integer 交易时间戳 date_ms Integer 交易毫秒时间戳 amount String 交易量 price String 交易价 type String buy;
sell;
示例
// Request
market=ETHUSDT
&type=1day
&limit=10
// Response
{
"code": 0,
"data": [
[
1492358400,
"10.0",
"10.0",
"10.0",
"10.0",
"10",
"100",
]
],
"message": "Ok"
}
GET /market/kline- 获取单个市场k线数据，适用于币币和杠杆市场
- 是否需要签名：否
-
最大返回1000条记录
-
请求参数说明
名称 类型 是否必须 描述 market String Yes 市场名称 limit Integer No(default 100) 最大1000 type String Yes 1min:1min;
3min:3min;
5min:5min;
15min:15min;
30min:30min;
1hour:1hour;
2hour:2hour;
4hour:4hour;
6hour:6hour;
12hour:12hour;
1day:1day;
3day:3day;
1week:1week; -
返回参数说明
名称 类型 描述 data[0][0] Integer 时间戳 data[0][1] String 开盘价 data[0][2] String 收盘价 data[0][3] String 最高价 data[0][4] String 最低价 data[0][5] String 交易量 data[0][6] String 交易额
示例
// Request
market=ETHUSDT
// Response
{
"code": 0,
"data": {
"date": 1513865441609, # server time when returning
"ticker": {
"buy": "10.00", # buy 1
"buy_amount": "10.00", # buy 1 amount
"open": "10", # highest price
"high": "10", # highest price
"last": "10.00", # latest price
"low": "10", # lowest price
"sell": "10.00", # sell 1
"sell_amount": "0.78", # sell 1 amount
"vol": "110" # 24H volume
}
},
"message": "Ok"
}
GET /market/ticker- 获取单个市场统计数据，适用于币币和杠杆市场
- 是否需要签名：否
-
请求参数说明
名称 类型 是否必须 描述 market String Yes 市场名称 -
返回参数说明
名称 类型 描述 date String 服务器时间 last String 最新成交价 buy String 买一价 buy_amount String 买一量 sell String 卖一价 sell_amount String 卖一量 open String 24小时开盘价 high String 24小时最高价 low String 24小时最低价 vol String 24小时成交量
示例
// Request
// Response
{
"code": 0,
"data": {
"date": 1513865441609,
"ticker": {
"BCHBTC": {
"buy": "0.222",
"buy_amount": "0.1",
"open": "0.2322211",
"high": "0.2322211",
"last": "0.2322211",
"low": "0.222",
"sell": "0.3522211",
"sell_amount": "0.11",
"vol": "2.01430624"
},
}
},
"message": "Ok"
}
GET /market/ticker/all- 获取所有市场统计数据，适用于币币和杠杆市场
- 是否需要签名：否
- 返回参数说明
同获取单个市场统计接口
示例
// Request
// Response
{
"code": 0,
"data": {
"USDT_to_USD": "1.00128491",
"USDC_to_USD": "1",
"BTC_to_USD": "60079.09716983",
"BCH_to_USD": "600.770946",
"ETH_to_USD": "4163.84190845",
"CET_to_USD": "2.00256982"
},
"message": "Success"
}
GET /common/currency/rate- 获取所有币种对USD的汇率
- 是否需要签名：否
- 返回参数:各个币种对USD的汇率
示例
// Request
coin_type=CET
// Response
{
"code": 0,
"data": {
"CET-CSC": {
"asset": "CET",
"chain": "CSC",
"can_deposit": true,
"can_withdraw": false,
"deposit_least_amount": "1",
"withdraw_least_amount": "1",
"withdraw_tx_fee": "0.1"
},
"CET-ERC20": {
"asset": "CET",
"chain": "ERC20",
"can_deposit": true,
"can_withdraw": false,
"deposit_least_amount": "14",
"withdraw_least_amount": "14",
"withdraw_tx_fee": "14"
}
},
"message": "Success"
}
GET /common/asset/config- 获取所有资产配置
- 是否需要签名：否
-
请求参数说明
名称 类型 是否必须 描述 coin_type String No 币种名称 -
返回参数说明
名称 类型 描述 can_deposit Bool 充值状态 can_withdraw Bool 提现状态 deposit_least_amount String 充值最小量 withdraw_least_amount String 提现最小量 withdraw_tx_fee String 提现费率 withdrawal_precision String 提现精度 asset String 币种 chain String 币种所在的公链
示例
// Request
// Response
{
"code": 0,
"data": [
"CETUSDT",
"USDCUSDT",
"ETHBTC",
"ACMUSDT",
"ARDRUSDT",
"ARDRTUSD",
"AYAUSDT",
"AYAETH",
"KUNBTC",
"KUNBCH",
"KUNETH",
"KUNTUSD",
"LFTBTC",
"PAXUSDT",
"SNXUSDT",
"SNXBTC",
"SNXBCH",
"SNXETH",
"SYSUSDT",
"XRPUSDC",
"XRPETH"
],
"message": "Success"
}
GET /amm/market- 获取AMM市场列表
- 是否需要签名：否
- 返回参数
示例
// Request
// Response
{
"code": 0,
"data": {
"CETBCH": 3,
"BTCUSDC": 4,
"XRPPAX": 7,
"ETHUSDC": 9,
"BCHUSDT": 10,
"LTCUSDT": 11,
"XRPUSDT": 12,
"HCBTC": 13,
"ETHUSDT": 1,
"ETCUSDT": 15,
"BTCUSDT": 2,
"ETHBTC": 16,
"HCUSDT": 17,
"BSVUSDT": 19,
"OMGUSDT": 20,
"OMGUSDC": 22,
"OMGTUSD": 23,
"BANUSDT": 24,
"BANUSDC": 25
},
"message": "Success"
}
GET /margin/market- 获取杠杆市场列表
- 是否需要签名：否
- 请求参数：无
账户API
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": {
"BTC": {
"available": "9080.84156954",
"frozen": "1"
},
"USDT": {
"available": "43724611.65252752",
"frozen": "1897.84472856"
},
"CET": {
"available": "6524.13695056",
"frozen": "0"
},
"ETH": {
"available": "10000",
"frozen": "0"
}
},
"message": "Success"
}
GET /balance/info- 是否需要签名：是
- 获取账户信息，适用于现货交易市场
-
当币种资产(可用+冻结)为0时，无币种数据返回
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s -
返回参数说明
名称 描述 frozen 冻结量 available 可用量 lock 锁定量
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&sub_user_name=sub_user
&coin_type=BTC
// Response
{
"code": 0,
"data": {
"sun": {
"BTC": {
"available": "99",
"frozen": "0"
}
}
},
"message": "Success"
}
GET /sub_account/balance- 是否需要签名：是
- 获取子账号现货余额信息
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s sub_user_name String No 子账号名 coin_type String No 币种名称 -
返回参数说明
名称 描述 available 可用数量 frozen 冻结数量
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": [
{
"market": "ETHBTC",
"base_asset": "ETH",
"quote_asset": "BTC",
"base_amount": "944.24670636",
"quote_amount": "65.46687196"
}
],
"message": "Success"
}
GET /account/amm/balance- 是否需要签名：是
- 获取AMM账户信息
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s -
返回参数说明
名称 描述 market 市场 base_asset 基准资产 quote_asset 标价资产 base_amount 基准资产数量 quote_amount 标价资产数量
返回示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": [
{
"asset": "CET",
"available": "0",
"frozen": "0"
},
{
"asset": "USDT",
"available": "999900",
"frozen": "0"
}
],
"message": "Success"
}
-
GET /account/investment/balance -
是否需要签名：是
-
获取理财账户信息
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s -
返回参数说明
名称 描述 asset 资产 available 可用数量 frozen 冻结数量
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": {
"withdraw_rate": "1.4",
"trade_rate": "2",
"current_balance": "6506574.34065785",
"unflat_balance": "6336010.61421221",
"can_withdraw_balance": "6506574.34065785",
"can_trade_balance": "6506574.34065785",
"current_rate": "1.02691973"
},
"message": "Success"
}
-
GET /credit/info -
是否需要签名：是
-
获取账户授信信息
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s -
返回参数说明
名称 描述 withdraw_rate 可提现风险率 trade_rate 可交易风险率 current_balance 账户总资产市值 unflat_balance 待还市值 can_withdraw_balance 可提现金额市值 can_trade_balance 可交易金额市值 current_rate 风险率
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
// Response
{
"code": 0,
"data": {
"account_id": 2,
"leverage": 10,
"market_type": "BTCUSDT",
"sell_asset_type": "BTC",
"buy_asset_type": "USDT",
"balance": {
"sell_type": "2",
"buy_type": "0"
},
"frozen": {
"sell_type": "0",
"buy_type": "0"
},
"loan": {
"sell_type": "0",
"buy_type": "0"
},
"interest": {
"sell_type": "0",
"buy_type": "0"
},
"can_transfer": {
"sell_type": "2",
"buy_type": "0"
},
"warn_rate": "",
"liquidation_price": ""
},
"message": "Success"
}
GET /margin/account- 是否需要签名：是
-
获取市场杠杆账户
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String Yes 市场 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为 ±60s -
返回结果:
名称 类型 描述 account_id Integer 杠杆账户ID leverage Integer 最大杠杆倍数 market_type String 市场名称 sell_asset_type String 交易币种 buy_asset_type String 定价币种 balance Object 资产 frozen Object 冻结的金额 loan Object 借出的金额 interest Object 利息 can_transfer Object 可划转的金额 warn_rate String 风险率 liquidation_price String 爆仓价 sell_type String 交易币种数量 buy_type String 定价币种数量
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
// Response
{
"code": 0,
"data": {
"market": "BTCUSDT",
"leverage": 10,
"day_rate": "0.0009",
"BTC": {
"min_amount": "0.001",
"max_amount": "100"
},
"USDT": {
"min_amount": "1",
"max_amount": "2000000"
}
},
"message": "Success"
}
GET /margin/config- 是否需要签名：是
-
查询单一杠杆交易的设置信息，包括最高借贷金额，利息率。
-
请求参数:
名称 类型 是否必须 描述 market String No 市场名称 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为 ±60s -
返回结果:
名称 类型 描述 max_amount String 最高贷款额 min_amount String 最高贷款额 leverage Integer 最大杠杆倍数 day_rate String 每日利率 market String 市场
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": [
{
"asset": "USDT",
"unflat_amount": "98.99999998",
"interest_amount": "259.29744279"
}
],
"message": "Success"
}
-
GET /credit/balance -
是否需要签名：是
-
获取账户授信余额
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s -
返回参数说明
名称 描述 asset 授信资产 unflat_amount 未平仓余额 intrest_amount 利息总额
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&coin_type=ETH
&status=finish
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"has_next": false,
"curr_page": 1,
"count": 1,
"data": [
{
"coin_deposit_id": 14270229,
"create_time": 1637212022,
"amount": "200",
"amount_display": "200",
"diff_amount": "0",
"min_amount": "0",
"actual_amount": "200",
"actual_amount_display": "200",
"confirmations": 0,
"tx_id": "",
"tx_id_display": "XXXXXXXXXX",
"coin_address": "XXXXXXXXXX",
"coin_address_display": "XXXXXXXXXX",
"add_explorer": "",
"coin_type": "USDT",
"smart_contract_name": null,
"transfer_method": "local",
"status": "finish",
"status_display": "finish",
"remark": "",
"explorer": ""
}
],
"total": 1,
"total_page": 1
},
"message": "Success"
}
GET /balance/coin/deposit- 是否需要签名：是
-
获取充值记录
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s coin_type String No 币种名称 tx_id String No 交易id page Interger Yes 页码，从1开始 Limit Interger Yes 每页数量，最大100 Status String No 状态
processing:处理中
confirming：确认中
cancel：取消
finish：完成
too_small：充值金额过小
to_hot：转热钱包 -
返回参数说明
名称 描述 actual_amount 实际充值量 actual_amount_display 实际显示充值量 add_explorer 充值转出地址 amount 充值量 amount_display 显示充值量 coin_address 充值转入地址 coin_address_display 显示充值转入地址 coin_deposit_id 充值id coin_type 币种名称 confirmations 确认数 create_time 创建时间戳 explorer 交易的浏览器地址 remark 备注 status 状态 status_display 显示状态 transfer_method 交易方法 tx_id 交易id tx_id_display 显示交易id min_amount 最小充值额 smart_contract_name 智能合约名称
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&asset=USDT
&business=trade
&account_id=0
&start_time=1636451914
&end_time=1681724907
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"data": [
{
"time": 1636602204,
"account": 0,
"business": "trade",
"business_id": 35437896,
"asset": "BTC",
"change": "0.12995834",
"balance": "8748.45520473"
},
{
"time": 1636451914,
"account": 0,
"business": "trade",
"business_id": 35437896,
"asset": "USDT",
"change": "-6.70000000",
"balance": "42608970.78871773"
}
],
"curr_page": 1,
"has_next": true,
"count": 10
},
"message": "Success"
}
GET /account/balance/history- 是否需要签名：是
- 查询用户流水
- 请求参数说明
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| asset | String | No | 资产 |
| account_id | Integer | No | 现货账户ID: 0, 杠杆账户ID: 见获取市场杠杆账户 |
| start_time | Integer | No | 查询开始时间 |
| end_time | Integer | No | 查询结束时间 |
| page | Integer | Yes | 页数 |
| limit | Integer | Yes | 每页条数 |
| business | String | No | 业务类型 trade:交易 withdraw:提现 deposit:充值 maker_cash_back:现货返现 |
| access_id | String | Yes | access_id |
| tonce | Integer | Yes | 毫秒时间戳，与服务器时间可接受误差范围为±60s |
- 返回参数说明
| 名称 | 描述 |
|---|---|
| business_id | 业务ID |
| time | 创建时间 |
| account | 账户ID |
| asset | 币种 |
| change | 资产变动额 |
| balance | 操作后的余额 |
| business | 业务类型 trade:交易 withdraw:提现 deposit:充值 maker_cash_back:现货返现 |
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&business_type=SPOT
// Response
{
"code": 0,
"data": {
"taker": "0.0018",
"maker": "0.0018"
},
"message": "Success"
}
-
GET /account/market/fee -
是否需要签名：是
-
获取交易费率
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s market String Yes 市场 business_type String No 交易类型
SPOT:现货（默认）
PERPETUAL:合约 -
返回参数说明
名称 描述 taker taker费率 maker maker费率
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"transfer_account": "sub1",
"transfer_side": "out",
"coin_type": "USDT",
"amount": "1"
}
// Response
{
"code": 0,
"message": "Success",
"data": {}
}
POST /sub_account/transfer- 是否需要签名：是
- 现货主账号-子账号资产划转
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s transfer_account String Yes 子账号名 transfer_side String Yes “in”表示转入主账号, “out”表示主账号转出 coin_type String Yes 币种名称 amount String Yes 转账数量
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"from_account": "0",
"to_account": "1",
"coin_type": "USDT",
"amount": "1"
}
// Response
{
"code": 0,
"data": null,
"message": "Success"
}
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"transfer_side": "in",
"coin_type": "USDT",
"amount": "1"
}
// Response
{
"code": 0,
"data": null,
"message": "Success"
}
-
POST /contract/balance/transfer -
是否需要签名：是
-
现货-合约资产划转
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s coin_type String Yes 币种名称 transfer_side String Yes 操作方向
in：现货转入合约账户
out:合约转入现货账户amount String Yes 划转数量 -
返回参数
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"smart_contract_name": "CSC",
"coin_type": "USDT",
"coin_address": "0x3886be3128DEF4dEC006116acaf21750c0138Ad6",
"actual_amount": "1"
}
// Response
{
"code": 0,
"data": {
"actual_amount": "1.00000000",
"amount": "1.00000000",
"coin_address": "1KAv3pazbTk2JnQ5xTo6fpKK7p1it2RzD4",
"coin_type": "BCH",
"coin_withdraw_id": 206,
"confirmations": 0,
"create_time": 1524228297,
"status": "audit",
"tx_fee": "0",
"fee_asset": "BCH",
"fee_amount": "0",
"tx_id": ""
},
"message": "Ok"
}
POST /balance/coin/withdraw- 是否需要签名：是
-
申请提现
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s coin_type String Yes 币种名称 smart_contract_name String No 多协议支持的币种需要提供，比如USDT可选ERC20，Omni，TRC20 coin_address String Yes 授权的提现地址，若提现XMR或XMC，需要用 “:” 将 “address” 和 “payment_id” 结合成 “xxx:yyy” 的形式，若提现XRP，需要用 “:” 将 “address” 和 “tag” 结合成 “xxx:yyy” 的形式，站内转账可以填手机号或邮箱 transfer_method String No 1.onchain – 链上转账 2.local – 站内转账 actual_amount String Yes 提现实际数量，实际指的是扣掉手续费之后实际到账的数量，费率地址: https://www.coinex.com/fees fee_asset String No 提现手续费币种，默认是提现币种。支持CET、USDT、USDC、BTC、ETH -
返回参数说明
名称 描述 coin_withdraw_id 提现id create_time 创建时间戳 amount 提现数量 actual_amount 实际提现数量 tx_id 交易id coin_address 提现地址 fee_asset 提现手续费币种 fee_amount 提现手续费数目 confirmations 确认数 coin_type 币种名称 status 提现状态
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&coin_withdraw_id=37503
// Response
{
"code": 0,
"data": {},
"message": "Ok"
}
DELETE /balance/coin/withdraw- 是否需要签名：是
-
取消提现
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s coin_withdraw_id Integer Yes 提现记录id
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"coin_type": "USDT",
"market": "ETHUSDT",
"amount": "50",
"renew": "1"
}
// Response
{
"code": 0,
"data": {
"loan_id": 1670
},
"message": "Success"
}
POST /margin/loan- 是否需要签名：是
- 在杠杆账户下贷款
-
特殊频率限制：5r/5s
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为 ±60s market String Yes 市场名称 coin_type String Yes 币种名称 amount String Yes 借出量 renew Integer No 是否自动续期
0：否<br>1 :是 -
返回结果:
名称 类型 描述 loan_id Integer 借币记录 id
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETCUSDT",
"coin_type": "USDT",
"amount": "50"
}
// Response
{
"code": 0,
"data": null,
"message": "Success"
}
POST /margin/flat- 是否需要签名：是
-
在杠杆账户下偿还代币
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为 ±60s market String Yes 市场名称 coin_type String Yes 币种名称 amount String Yes 还币数量 loan_id Integer No 借币记录 id，当前市场剩余还币量还清时不填
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"smart_contract_name": "TRC20"
}
// Response
{
"code": 0,
"data": {
"coin_address": "0x40aa234bcdc528ce411a6020da1a3c07124039d4",
"is_bitcoin_cash": false
},
"message": "Success"
}
-
PUT /balance/deposit/address/<string:coin_type> -
是否需要签名：是
-
更新充值地址
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s smart_contract_name Integer No 如果某个币存在多个链，需要指定。 现阶段多链币种为 USDT, smart_contract_name可选为Omni, ERC20, TRC20
BTC, smart_contract_name可选为CoinExChain, BTC
BCH, smart_contract_name可选为CoinExChain, BCH
USDH, smart_contract_name可选为CoinExChain, SLP
CET, smart_contract_name可选为CoinExChain, ERC20
-
返回参数说明
| 名称 | 描述 |
|---|---|
| coin_address | 充值地址 |
| is_bitcoin_cash | 是否比特币现金（BCH） |
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&smart_contract_name=TRC20
// Response
{
"code": 0,
"data": {
"coin_address": "0x40aa234bcdc528ce411a6020da1a3c07124039d4",
"is_bitcoin_cash": false
},
"message": "Success"
}
GET /balance/deposit/address/<string:coin_type>- 是否需要签名：是
-
查询充值地址
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s smart_contract_name Integer No 如果某个币存在多个链，需要指定。 现阶段多链币种为 USDT, smart_contract_name可选为Omni, ERC20, TRC20
BTC, smart_contract_name可选为CoinExChain, BTC
BCH, smart_contract_name可选为CoinExChain, BCH
USDH, smart_contract_name可选为CoinExChain, SLP
CET, smart_contract_name可选为CoinExChain, ERC20
- 返回参数说明
| 名称 | 描述 |
|---|---|
| coin_address | 充值地址 |
| is_bitcoin_cash | 是否比特币现金（BCH） |
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&asset=USDT
&op_type=out
&start_time=1636451914
&end_time=1681724907
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"records": [
{
"id": 5063,
"created_at": 1636330200,
"updated_at": 1636330200,
"success_at": 1636330200,
"report_date": 1636329600,
"user_id": 305,
"investment_account_id": 2,
"asset": "BTC",
"amount": "0.00001052",
"opt_type": "INTEREST",
"day_rate": "0",
"status": "SUCCESS"
}
],
"total": 495
},
"message": "Success"
}
GET /investment/transfer/history- 现货-理财账户转账记录
- 请求参数说明
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| asset | String | No | 资产 |
| op_type | String | No | 操作 IN：现货转入理财账户 OUT:理财转入现货账户 INTEREST:利息 |
| start_time | Integer | No | 查询开始时间 |
| end_time | Integer | No | 查询结束时间 |
| page | Integer | Yes | 页数 |
| limit | Integer | Yes | 每页条数 |
- 返回参数说明
| 名称 | 描述 |
|---|---|
| id | 转账ID |
| create_at | 创建时间 |
| update_at | 更新时间 |
| success_at | 转账成功时间 |
| asset | 操作的资产 |
| amount | 数量 |
| opt_type | 操作 IN：现货转入理财账户 OUT:理财转入现货账户 INTEREST:利息 |
| day_rate | 日收益率 |
| status | 状态 |
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&sub_user_name=sub1
&coin_type=USDT
&start_time=1636451914
&end_time=1681724907
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"curr_page": 1,
"has_next": false,
"per_page": 10,
"total_page": 1,
"count": 4,
"data": [
{
"time": 1636443179,
"transfer_from": "sun",
"transfer_to": "",
"coin_type": "BTC",
"amount": "1",
"status": "success"
}
],
"total": 4
},
"message": "Success"
}
-
GET /sub_account/transfer/history -
是否需要签名：是
-
获取主账号-子账号划转记录
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s sub_user_name String No 子账号名 coin_type String No 币种名称 start_time Integer No 查询开始时间（时间戳） end_time Integer No 查询结束时间（时间戳） page Integer Yes 页数 limit Integer Yes 每页条数（最大500条） -
返回参数说明
名称 描述 time 转账时间 transfer_from 转账发起方 transfer_to 转账接收方（转账发起方和接收方默认只给出一个） from_account_type 转出账户
PERPETUAL: 合约账户
SPOT: 现货账户to_account_type 转入账户
PERPETUAL: 合约账户
SPOT: 现货账户coin_type 币种名称 amount 转账数量 status 转账状态
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&status=finish
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"page": 1,
"limit": 10,
"total": 9,
"data": [
{
"loan_id": 1666,
"create_time": 1635736743,
"market_type": "BTCUSDT",
"coin_type": "BTC",
"day_rate": "0.0008",
"loan_amount": "99.99",
"unflat_amount": "0",
"expire_time": 1636600743,
"is_renew": true,
"status": "finish"
},
{
"loan_id": 1665,
"create_time": 1635736729,
"market_type": "BTCUSDT",
"coin_type": "BTC",
"day_rate": "0",
"loan_amount": "0.01",
"unflat_amount": "0",
"expire_time": 1636600729,
"is_renew": true,
"status": "finish"
}
]
},
"message": "Success"
}
GET /margin/loan/history- 是否需要签名：是
-
获取杠杆账户借币记录
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为 ±60s market String No 市场名称 status String No 状态 page Integer Yes 页码，从 1 开始 limit Integer Yes 每页条数，最大 100 -
返回结果:
名称 类型 描述 loan_id Integer 借币记录ID create_time Integer 创建时间戳 market_type String 市场名称 coin_type String 币种名称 loan_amount String 借入金额 unflat_amount String 需要偿还的金额和利息 expire_time Integer 过期时间 is_renew Integer 是否自动续期，0: 关闭; 1: 开启; day_rate String 每日利率 status String pass: 借币中;
burst: 爆仓;
arrears: 欠款中;
finish: 已还币;
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&asset=USDT
&transfer_type=transfer_in
&start_time=1636451914
&end_time=1681724907
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"records": [
{
"amount": "12",
"asset": "USDT",
"transfer_type": "transfer_out",
"created_at": 1637287786
},
{
"amount": "1",
"asset": "BTC",
"transfer_type": "transfer_in",
"created_at": 1637287666
},
{
"amount": "10002",
"asset": "USDT",
"transfer_type": "transfer_in",
"created_at": 1637287619
}
],
"total": 3
},
"message": "Success"
}
GET /contract/transfer/history- 现货-合约账户划转记录
- 请求参数说明
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| asset | String | No | 资产 |
| transfer_type | String | No | 操作 transfer_in：现货转入合约账户 transfer_out:合约转入现货账户 |
| start_time | Integer | No | 查询开始时间 |
| end_time | Integer | No | 查询结束时间 |
| page | Integer | Yes | 页数 |
| limit | Integer | Yes | 每页条数 |
| access_id | String | Yes | access_id |
| tonce | Integer | Yes | 毫秒时间戳，与服务器时间可接受误差范围为±60s |
- 返回参数说明
| 名称 | 描述 |
|---|---|
| create_at | 创建时间 |
| asset | 操作的资产 |
| amount | 数量 |
| transfer_type | 操作 transfer_in：现货转入合约账户 transfer_out:合约转入现货账户 |
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&asset=USDT
&transfer_type=in
&start_time=1636451914
&end_time=1681724907
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"records": [
{
"id": 2612,
"updated_at": 1635846838,
"user_id": 1527,
"from_account_id": 0,
"to_account_id": 2,
"asset": "BTC",
"amount": "1",
"balance": "2",
"transfer_type": "IN",
"status": "SUCCESS",
"created_at": 1635846838
}
],
"total": 6
},
"message": "Success"
}
GET /margin/transfer/history- 是否需要签名：是
-
杠杆-现货账户划转记录
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id asset String No 资产类型 market String No 市场名称 transfer_type String No 划转方向 page Integer Yes 页码，从 1 开始 limit Integer Yes 每页条数，最大 1000 start_time Integer No 查询起始时间 end_time Integer No 查询结束时间 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为 ±60s -
返回结果:
名称 类型 描述 id Integer 记录 ID updated_at Integer 更新时间 user_id Integer 用户id from_account_id Integer 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户to_account_id Integer 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户asset String 资产 amount String 划转数量 balance String 账户余额 transfer_type String 划转方向，IN为转入杠杆账户，OUT为转出杠杆账户 status String 操作状态 created_at Integer 创建时间
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&coin_withdraw_id=37503
&coin_type=USDT
&page=1
&limit=100
// Response
{
"code": 0,
"data": [
{
"actual_amount": "1.00000000",
"amount": "1.00000000",
"coin_address": "1KAv3pazbTk2JnQ5xTo6fpKK7p1it2RzD4",
"coin_type": "BCH",
"coin_withdraw_id": 206,
"confirmations": 0,
"create_time": 1524228297,
"status": "audit",
"tx_fee": "0",
"fee_asset": "BCH",
"fee_amount": "0",
"tx_id": ""
},
{
"actual_amount": "0.10000000",
"amount": "0.10000000",
"coin_address": "15sr1VdyXQ6sVLqeJUJ1uPzLpmQtgUeBSB",
"coin_type": "BCH",
"coin_withdraw_id": 203,
"confirmations": 11,
"create_time": 1515806440,
"status": "finish",
"tx_fee": "0",
"fee_asset": "BCH",
"fee_amount": "0",
"tx_id": "896371d0e23d64d1cac65a0b7c9e9093d835affb572fec89dd4547277fbdd2f6"
},
{
"actual_amount": "0.01000000",
"amount": "0.01000000",
"coin_address": "1GVVx5UBddLKrckTprNi4VhHSymeQ8tsLF",
"coin_type": "BCH",
"coin_withdraw_id": 68,
"confirmations": 6,
"create_time": 1514978728,
"status": "finish",
"tx_fee": "0",
"fee_asset": "BCH",
"fee_amount": "0",
"tx_id": "f08802fea6745c07e420b92356cf3bcdaa78a00c4a062ef0b9e2de06a3f4d718"
},
{
"actual_amount": "0.00100000",
"amount": "0.00100000",
"coin_address": "1GVVx5UBddLKrckTprNi4VhHSymeQ8tsLF",
"coin_type": "BCH",
"coin_withdraw_id": 27,
"confirmations": 0,
"create_time": 1513933541,
"status": "cancel",
"fee_asset": "BCH",
"fee_amount": "0",
"tx_fee": "0",
"tx_id": ""
}
],
"message": "Ok"
}
GET /balance/coin/withdraw- 是否需要签名：是
-
获取提现历史记录
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s coin_type String No 币种名称 coin_withdraw_id Integer No 提现记录id page Interger Yes 页码，从1开始 limit Interger Yes 每页数量，最大100 -
返回参数说明
名称 描述 coin_withdraw_id 提现记录id create_time 创建时间戳 amount 提现数量 actual_amount 实际提现数量 tx_id 交易id coin_address 提出地址 fee_asset 提现手续费币种 fee_amount 提现手续费数目 confirmations 确认数 coin_type 币种名称 status audit;
pass;
processing;
confirming;
not_pass;
cancel;
finish;
fail;
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"sub_user_name": "sub2",
"permissions": [
"AMM",
"MARGIN"
]
}
// Response
{
"code": 0,
"message": "Success",
"data": {}
}
POST /sub_account/register- 是否需要签名：是
- 创建子账号(可创建的数量最多为20个)
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s sub_user_name String Yes 子账号名 permissions List No 权限列表，不传表示全部权限
PERPETUAL: 合约交易权限
MARGIN: 杠杆交易权限
AMM: AMM功能
API: API管理权限
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"sub_user_name": "sub2"
}
// Response
{
"code": 0,
"message": "Success",
"data": {}
}
PUT /sub_account/unfrozen- 是否需要签名：是
- 取消禁用子账号
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s sub_user_name String Yes 子账号名
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"sub_user_name": "sub2"
}
// Response
{
"code": 0,
"message": "Success",
"data": {}
}
PUT /sub_account/frozen- 是否需要签名：是
- 禁用子账号
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s sub_user_name String Yes 子账号名
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"cet_discount": "True"
}
// Response
{
"code": 0,
"message": "Success",
"data": {}
}
PUT /v1/account/settings- 是否需要签名：是
-
修改账户设置
-
请求参数说明
名称 类型 是否必须 描述 cet_discount Bool No 是否开启CET抵扣
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"sub_user_name": "sub1",
"allow_trade": "True",
"allowed_ips": [
"1.1.1.1",
"1.1.1.2"
],
"remark": "test"
}
// Response
{
"code": 0,
"data": {
"user_auth_id": 554,
"create_time": 1642145331,
"remark": "2233",
"access_id": "xxxxxxx",
"allowed_ips": [
"1.1.1.1"
],
"allow_withdraw": false,
"allow_trade": true,
"is_expires": false,
"expired_time": 0,
"secret_key": "xxxxxx"
},
"message": "Success"
}
-
POST /sub_account/auth/api -
是否需要签名：是
-
创建子账号APIKEY
-
备注：此API只能由主账号调用，最多可以为每个子账号创建50个APIKEY，需要对应子账号有API管理的权限
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s allow_trade Bool Yes 是否有交易权限,true: 是；false:否 allowed_ips List Yes 绑定的IP地址（最多可以绑定50个） remark String No API备注 sub_user_name String Yes 子账号的用户名 -
返回参数
名称 描述 user_auth_id APIKEY的唯一ID create_time 创建时间 remark API备注 access_id access_id allowed_ips 绑定的IP地址 allow_withdraw 是否开通提现权限 allow_trade 是否开通交易权限 is_expires APIKEY是否过期(如绑定了IP地址，则默认为永不过期；
如未绑定IP地址，则此APIKEY的有效期为三个月)expired_time 过期时间:
0: 永久有效secret_key secret_key
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&sub_user_name=sub1
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"has_next": false,
"curr_page": 1,
"count": 7,
"data": [
{
"user_auth_id": 554,
"create_time": 1642145331,
"remark": "2233",
"access_id": "5EDFCD524C7046B6AD9D10A2510A5BC9",
"allowed_ips": [
"1.1.1.1"
],
"allow_withdraw": false,
"allow_trade": true,
"is_expires": false,
"expired_time": 0
}
],
"total": 7,
"total_page": 1
},
"message": "Success"
}
-
GET /sub_account/auth/api -
是否需要签名：是
-
获取子账号APIKEY列表
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s page Integer Yes 页数 limit Integer Yes 每页条数 sub_user_name String Yes 子账号的用户名 -
返回参数
名称 描述 user_auth_id APIKEY的唯一ID create_time 创建时间 remark API备注 access_id access_id allowed_ips 绑定的IP地址 allow_withdraw 是否开通提现权限 allow_trade 是否开通交易权限 is_expires APIKEY是否过期(如绑定了IP地址，则默认为永不过期；
如未绑定IP地址，则此APIKEY的有效期为三个月)expired_time 过期时间:
0: 永久有效
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": {
"user_auth_id": 554,
"create_time": 1642145331,
"remark": "2233",
"access_id": "5EDFCD524C7046B6AD9D10A2510A5BC9",
"allowed_ips": [
"1.1.1.1"
],
"allow_withdraw": false,
"allow_trade": true,
"is_expires": false,
"expired_time": 0,
"secret_key": "xxxx"
},
"message": "Success"
}
-
GET /sub_account/auth/api/<int:user_auth_id> -
是否需要签名：是
-
获取子账号APIKEY详情
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s -
返回参数
名称 描述 user_auth_id APIKEY的唯一ID create_time 创建时间 remark API备注 access_id access_id allowed_ips 绑定的IP地址 allow_withdraw 是否开通提现权限 allow_trade 是否开通交易权限 is_expires APIKEY是否过期(如绑定了IP地址，则默认为永不过期；
如未绑定IP地址，则此APIKEY的有效期为三个月)expired_time 过期时间:
0: 永久有效secret_key secret_key
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"sub_user_name": "sub1",
"allow_trade": "True",
"allowed_ips": [
"1.1.1.1",
"1.1.1.2"
],
"remark": "test"
}
// Response
{
"code": 0,
"data": {
"user_auth_id": 554,
"create_time": 1642145331,
"remark": "API5",
"access_id": "5EDFCD524C7046B6AD9D10A2510A5BC9",
"allowed_ips": [],
"allow_withdraw": false,
"allow_trade": true,
"is_expires": false,
"expired_time": 1649924698,
"secret_key": "xxx"
},
"message": "Success"
}
-
PUT /sub_account/auth/api/<int:user_auth_id> -
是否需要签名：是
-
编辑子账号APIKEY
-
备注：此API只能由主账号调用，需要对应子账号有API管理的权限
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s allow_trade Bool Yes 是否有交易权限,true: 是；false:否 allowed_ips List Yes 绑定的IP地址（最多可以绑定50个） remark String No API备注 sub_user_name String Yes 子账号的用户名 -
返回参数
名称 描述 user_auth_id APIKEY的唯一ID create_time 创建时间 remark API备注 access_id access_id allowed_ips 绑定的IP地址 allow_withdraw 是否开通提现权限 allow_trade 是否开通交易权限 is_expires APIKEY是否过期(如绑定了IP地址，则默认为永不过期；
如未绑定IP地址，则此APIKEY的有效期为三个月)expired_time 过期时间:
0: 永久有效secret_key secret_key
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": {},
"message": "Success"
}
-
DELETE /sub_account/auth/api/<int:user_auth_id> -
是否需要签名：是
-
删除子账号APIKEY
-
备注：此API只能由主账号调用
-
请求参数
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s -
返回参数
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&sub_user_name=sub1
&frozen=true
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"curr_page": 1,
"has_next": false,
"per_page": 10,
"total_page": 1,
"count": 1,
"data": [
{
"user_name": "test_sub",
"permissions": [
"PERPETUAL",
"MARGIN",
"AMM",
"API"
],
"frozen": false,
"managed": false,
"balance_usd": "0.8"
}
],
"total": 1
},
"message": "Success"
}
-
GET /sub_account/list - 是否需要签名：是
- 获取子账号列表
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s page Integer Yes 页数 limit Integer Yes 每页条数 sub_user_name String No 子账号的用户名 frozen Bool No 是否禁用 -
返回参数
名称 描述 user_name 子账号的用户名 frozen 是否禁用 managed 是否授权 balance_usd 资产市值 permissions 权限列表
PERPETUAL: 合约交易权限
MARGIN: 杠杆交易权限
AMM: AMM功能
API: API管理权限
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"from_user_name": "sub1",
"to_user_name": "sub2",
"from_account_type": "SPOT",
"to_account_type": "SPOT",
"asset": "USDT",
"amount": "1"
}
// Response
{
"code": 0,
"message": "Success",
"data": {}
}
-
POST /sub_account/universal-transfer - 是否需要签名：是
- 子账号通用资产划转
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s from_user_name String No 转出子账号名 to_user_name String No 转入子账号名 from_account_type String Yes 转出账户
PERPETUAL: 合约账户
SPOT: 现货账户to_account_type String Yes 转入账户
PERPETUAL: 合约账户
SPOT: 现货账户asset String Yes 币种名称 amount String Yes 转账数量 - 请求参数 from_user_name 和 to_user_name 至少提供一个
- 子账号和子账号的划转，只允许是子账号
现货账户划转到 子账号现货账户 - 如果 from_user_name 未传，默认是主账号转出
- 如果 to_user_name 未传，默认是转入主账号
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"email": "test@coinex.com",
"remark": "test",
"sub_user_name": "sub2"
}
// Response
{
"code": 0,
"data": {
"email": "test@gmail.com",
"id": 54,
"remark": "123,",
"sub_user_name": "test_sub]"
},
"message": "Success"
}
-
POST /sub_account/authorize - 是否需要签名：是
- 授权子账号
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s sub_user_name String Yes 子账号名 email String Yes 被授权人邮箱 remark String No 备注，不超过50个字符 -
返回参数
名称 描述 id 授权的唯一ID sub_user_name 子账号的用户名 email 被授权人邮箱 remark 备注
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&sub_user_name=sub2
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"count": 1,
"curr_page": 1,
"data": [
{
"email": "test@gmail.com",
"id": 54,
"remark": "test_remark",
"sub_user_name": "test_sub"
}
],
"has_next": false,
"total": 1,
"total_page": 1
},
"message": "Success"
}
-
GET /sub_account/authorize - 是否需要签名：是
- 获取授权子账号列表
-
备注：此API只能由主账号调用
-
请求参数说明
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s page Integer Yes 页数 limit Integer Yes 每页条数 sub_user_name String Yes 子账号的用户名 -
返回参数
名称 描述 id 授权的唯一ID sub_user_name 子账号的用户名 email 被授权人邮箱 remark 备注
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": {},
"message": "Success"
}
-
DELETE /sub_account/authorize/<int:id> - 是否需要签名：是
- 删除子账号授权
-
备注：此API只能由主账号调用
-
请求参数
名称 类型 是否必须 描述 access_id String Yes access_id tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s
交易API
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETHUSDT",
"type": "buy",
"price": "1100",
"amount": "1",
"account_id": 0,
"client_id": "client1",
"source_id": "source1",
"hide": true,
"option": "NORMAL"
}
// Response
{
"code": 0,
"data": {
"id": 35435972,
"create_time": 1636019392,
"finished_time": null,
"amount": "0.01000000",
"price": "56000",
"deal_amount": "0.01",
"deal_money": "560.0000000000000000",
"deal_fee": "0",
"stock_fee": "0",
"money_fee": "0",
"asset_fee": "0.313600000000000000000000",
"fee_asset": "CET",
"fee_discount": "0.70",
"avg_price": "56000",
"market": "BTCUSDT",
"left": "0.00000000",
"maker_fee_rate": "0.0016",
"taker_fee_rate": "0.0016",
"order_type": "limit",
"type": "buy",
"status": "done",
"client_id": "abcd222",
"source_id": "1234"
},
"message": "Success"
}
POST /order/limit- 是否需要签名：是
-
下限价单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes 密钥ID market String Yes 市场名称 type String Yes 操作
sell: 卖单;
buy: 买单;amount String Yes 下单量, 最小下单量由市场决定 price String Yes 订单价格, 精确到小数点后8位 source_id String No 用户定义编号并返回 account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s client_id String No client_id是订单的自定义ID。目前它仅支持大写和小写字母，数字，连字符和下划线，并且应小于32个字节. hide Bool No 是否隐藏委托
true：隐藏
false：不隐藏option String No 下单策略（默认为NORMAL）
普通: NORMAL,
立即成交或取消: IOC,
全部成交或取消: FOK,
只做maker: MAKER_ONLY -
返回结果:
名称 类型 描述 amount String 下单量 avg_price String 平均成交价格 create_time Interger 下单时间 deal_amount String 成交数 deal_money String 成交量 finished_time Interger 完成时间 id Interger 订单号 maker_fee_rate String maker费率 market String 市场名称 order_type String limit:限价单;
market:市价单;price String 下单价格 status String not_deal: 未成交;
part_deal: 部分成交;
done: 完全成交;taker_fee_rate String taker费率 type String sell: 卖单;
buy: 买单;client_id String client_id: 用户自定义订单ID stock_fee String 收取的基准币种手续费 money_fee String 收取的标价币种手续费 asset_fee String 收取的抵扣手续费的币种的手续费 fee_asset String 用于抵扣手续费的币种(目前只有CET) fee_discount String 费率折扣 left String 订单剩余未成交的数量 source_id String 用户自定义的source_id
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETHUSDT",
"account_id": 0,
"batch_orders": "[{\"type\":\"buy\",\"amount\":\"1\",\"price\":\"1100\"}]"
}
// Response
{
"code": 0,
"data": [
{
"code": 0,
"data": {
"id": 35435969,
"create_time": 1636018159,
"finished_time": null,
"amount": "0.01000000",
"price": "56000",
"deal_amount": "0.01",
"deal_money": "560.0000000000000000",
"deal_fee": "0.896000000000000000000000",
"stock_fee": "0",
"money_fee": "0.896000000000000000000000",
"asset_fee": "0",
"fee_asset": null,
"fee_discount": "1",
"avg_price": "56000",
"market": "BTCUSDT",
"left": "0.00000000",
"maker_fee_rate": "0.0016",
"taker_fee_rate": "0.0016",
"order_type": "limit",
"type": "buy",
"status": "done",
"client_id": "",
"source_id": "1236"
},
"message": "OK"
}
],
"message": "Success"
}
POST /order/limit/batch- 是否需要签名：是
-
批量下限价单，在同一市场下多个限价单，数量最高为100单
- 请求参数:
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| access_id | String | Yes | access_id |
| batch_orders | String(json) | Yes | 多订单json格式字符串 |
| market | String | Yes | 市场名称 |
| tonce | Integer | Yes | 毫秒时间戳，与服务器时间可接受误差范围为±60s |
| account_id | Integer | no | 现货账户ID: 0, 杠杆账户ID: 见获取市场杠杆账户 |
- batch_orders参数说明
| 名称 | 类型 | 是否必须 | 描述 |
| type | String | Yes | sell: 卖单; buy: 买单; |
| amount | String | Yes | 下单量, 最小下单量由市场决定 |
| price | String | Yes | 订单价格。8位小数精度 |
| source_id | String | no | 用户定义id |
- 返回结果:
同限价下单接口
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETHUSDT",
"type": "buy",
"amount": "1",
"asset": "ETH",
"account_id": 0,
"client_id": "client1"
}
// Response
{
"code": 0,
"data": {
"id": 35435973,
"create_time": 1636020409,
"finished_time": null,
"amount": "1.00000000",
"amount_asset": "BTC",
"price": "0",
"deal_amount": "1",
"deal_money": "54334.4024000000000000",
"deal_fee": "0",
"stock_fee": "0",
"money_fee": "0",
"asset_fee": "30.427265344000000000000000",
"fee_asset": "CET",
"fee_discount": "0.70",
"avg_price": "54334.4024",
"market": "BTCUSDT",
"left": "0.00000000",
"maker_fee_rate": "0",
"taker_fee_rate": "0.0016",
"order_type": "market",
"type": "sell",
"status": "done",
"client_id": "",
"source_id": "1234"
},
"message": "Success"
}
POST /order/market- 是否需要签名：是
-
下市价订单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String Yes 市场名称 type String Yes sell: 卖单;
buy:买单;amount String Yes 下单量, 最小下单量由市场决定 asset String No 下单币种，卖单默认为交易币种，买单默认为定价币种 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户client_id String No client_id是订单的自定义ID。目前它仅支持大写和小写字母，数字，连字符和下划线，并且应小于32个字节. - 返回结果:
同限价下单接口
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETHUSDT",
"type": "buy",
"price": "1100",
"amount": "1",
"account_id": 0,
"client_id": "client1",
"source_id": "source1"
}
// Response
{
"code": 0,
"data": {
"id": 35436205,
"create_time": 1636080705,
"finished_time": null,
"amount": "0.30000000",
"price": "56000",
"deal_amount": "0.24721428",
"deal_money": "13843.9996800000000000",
"deal_fee": "0",
"stock_fee": "0",
"money_fee": "0",
"asset_fee": "8.721719798400000000000000",
"fee_asset": "CET",
"fee_discount": "0.70",
"avg_price": "56000",
"market": "BTCUSDT",
"left": "0.05278572",
"maker_fee_rate": "0.0018",
"taker_fee_rate": "0.0018",
"order_type": "limit",
"type": "buy",
"status": "cancel",
"client_id": "abcd222",
"source_id": "1234"
},
"message": "Success"
}
POST /order/ioc- 是否需要签名：是
-
立即成交或不能成交时取消下单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String Yes 市场名称 type String Yes sell: 卖单;
buy: 买单;amount String Yes 下单量, 最小下单量由市场决定 price String Yes 下单价格，由市场决定 source_id String No 用户定义id account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s client_id String No client_id是订单的自定义ID。目前它仅支持大写和小写字母，数字，连字符和下划线，并且应小于32个字节. - 返回结果:
同限价下单接口
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETHUSDT",
"type": "buy",
"price": "1100",
"stop_price": "1000",
"amount": "1",
"account_id": 0,
"client_id": "client1",
"source_id": "source1",
"hide": true,
"option": "NORMAL"
}
// Response
{
"code": 0,
"data": {
"status": "success"
},
"message": "Success"
}
POST /order/stop/limit- 是否需要签名：是
-
下计划限价单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes 密钥ID market String Yes 市场名称 type String Yes 操作
sell: 卖单;
buy: 买单;amount String Yes 下单量, 最小下单量由市场决定 price String Yes 下单价格, 精确到小数点后8位 source_id String No 用户定义编号并返回 account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s client_id String No client_id是订单的自定义ID。目前它仅支持大写和小写字母，数字，连字符和下划线，并且应小于32个字节. hide Bool No 是否隐藏委托
true：隐藏
false：不隐藏option String No 下单策略（默认为NORMAL）
普通: NORMAL,
立即成交或取消: IOC,
全部成交或取消: FOK,
只做maker: MAKER_ONLYstop_price String Yes 触发价格, 精确到小数点后8位 - 返回结果:
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETHUSDT",
"type": "buy",
"amount": "1",
"asset": "ETH",
"stop_price": "1000",
"account_id": 0,
"client_id": "client1",
"source_id": "source1",
"hide": true,
"option": "NORMAL"
}
// Response
{
"code": 0,
"data": null,
"message": "Success"
}
POST /order/stop/market- 是否需要签名：是
-
下计划限价单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes 密钥ID market String Yes 市场名称 type String Yes 操作
sell: 卖单;
buy: 买单;amount String Yes 下单量, 最小下单量由市场决定 asset String No 下单币种，默认为交易币种 source_id String No 用户定义编号并返回 account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s client_id String No client_id是订单的自定义ID。目前它仅支持大写和小写字母，数字，连字符和下划线，并且应小于32个字节. hide Bool No 是否隐藏委托
true：隐藏
false：不隐藏option String No 下单策略（默认为NORMAL）
普通: NORMAL,
立即成交或取消: IOC,
全部成交或取消: FOK,
只做maker: MAKER_ONLYstop_price String Yes 触发价格, 精确到小数点后8位 - 返回结果:
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&id=420291
// Response
{
"code": 0,
"data": {
"id": 35436205,
"account_id": 0,
"create_time": 1636080705,
"finished_time": 1636080705,
"amount": "0.3",
"amount_asset": "BTC",
"price": "56000",
"deal_amount": "0.24721428",
"deal_money": "13843.99968",
"deal_fee": "0",
"stock_fee": "0",
"money_fee": "0",
"asset_fee": "8.7217197984",
"fee_asset": "CET",
"fee_discount": "0.7",
"avg_price": "56000",
"market": "BTCUSDT",
"left": "0",
"maker_fee_rate": "0.0018",
"taker_fee_rate": "0.0018",
"order_type": "limit",
"type": "buy",
"status": "cancel",
"client_id": "abcd222"
},
"message": "Success"
}
GET /order/status- 是否需要签名：是
-
查询订单状态
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id id Interger Yes 订单号 market String Yes 市场名称 tonce Interger Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s -
返回结果:
名称 类型 描述 id Integer 订单号 market String 市场名称 order_type String limit:限价单;
market:市价单;price String 订单价格 type String sell: 卖单;
buy: 买单;create_time Integer 下单时间戳 finished_time Integer 订单完成时间戳 status String not_deal: 未成交(订单仍在挂单中);
part_deal: 部分成交(订单仍在挂单中);
done: 完全成交(订单已完成);
cancel:订单取消(订单已完成);
为了保证服务器性能，所有取消的订单均不会保存amount String 订单量 deal_amount String 成交量 left String 订单剩余未成交的数量 avg_price String 平均价格 deal_money String 成交额 maker_fee_rate String maker费率 taker_fee_rate String taker费率 deal_fee String 交易费 stock_fee String 收取的基准币种手续费 money_fee String 收取的标价币种手续费 asset_fee String 收取的抵扣手续费的币种的数量 fee_asset String 用于抵扣手续费的币种 fee_discount String 费率折扣
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&batch_ids=420291,420292
// Response
{
"code": 0,
"data": [
{
"code": 0,
"data": {
"id": 35435975,
"account_id": 0,
"create_time": 1636020972,
"finished_time": 1636020972,
"amount": "1000",
"amount_asset": "BTC",
"price": "0",
"deal_amount": "811.88590061",
"deal_money": "43814713.2324293",
"deal_fee": "60763.149707616",
"stock_fee": "0",
"money_fee": "60763.149707616",
"asset_fee": "3269.137012494808",
"fee_asset": "CET",
"fee_discount": "0.7",
"avg_price": "53966.58963963985619139301",
"market": "BTCUSDT",
"left": "0",
"maker_fee_rate": "0",
"taker_fee_rate": "0.0016",
"order_type": "market",
"type": "sell",
"status": "done",
"client_id": ""
},
"message": ""
}
],
"message": "Success"
}
GET /order/status/batch- 是否需要签名：是
-
查询订单状态
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id batch_ids String Yes 英文”,”分隔的订单 id 列表: “1,2,3” market String Yes 市场名称 tonce Interger Yes 毫秒时间戳，与服务器时间可接受误差范围为 ±60s - 返回结果:
同查询订单状态接口
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&id=462672
&account_id=0
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"data": [
{
"id": 462672,
"order_id": null,
"create_time": 1636020972,
"role": "taker",
"price": "45010",
"amount": "0.21728593",
"fee": "5.476822237208",
"fee_asset": "CET",
"deal_money": "9780.0397093"
}
],
"curr_page": 1,
"has_next": false,
"count": 6
},
"message": "Success"
}
GET /order/deals- 是否需要签名：是
-
查询已完成订单明细
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id id Interger Yes 订单号 page Interger Yes 页码，从1开始 limit Interger Yes 每页数量，最大100 tonce Interger Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer no 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户 -
返回结果:
名称 类型 描述 amount String 成交数量 create_time Interger 下单时间戳 deal_money String 成交额 fee String 交易手续费（以fee_asset转换成USD计价） fee_asset String 支付手续费所用的资产 id Interger 执行id price String 单价 role String 订单类型taker/maker type String sell:卖单;
buy:买单
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"data": [
{
"account_id": 0,
"order_id": 35436626,
"create_time": 1636104319,
"amount": "0.01",
"price": "59000",
"stop_price": "55999",
"fee_asset": "CET",
"fee_discount": "0.7",
"market": "BTCUSDT",
"order_type": "limit",
"type": "buy",
"status": "active"
}
],
"curr_page": 1,
"has_next": false,
"count": 7
},
"message": "Success"
}
GET /order/stop/finished- 是否需要签名：是
-
查询历史计划订单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String No 市场名称 page Integer Yes 页码，从1开始 limit Integer Yes 每页条数，最大100 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer no 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户 -
返回结果:
名称 类型 描述 amount String 订单量 stop_price String 触发价格 create_time Integer 下单时间戳 account_id Integer 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户status String not_deal: 未成交(订单仍在挂单中);
part_deal: 部分成交(订单仍在挂单中);
done: 完全成交(订单已完成);
cancel:订单取消(订单已完成);
为了保证服务器性能，所有取消的订单均不会保存order_id Integer 订单号 market String 市场名称 order_type String limit:限价单;
market:市价单;price String 订单价格 type String sell: 卖单;
buy: 买单;fee_asset String 用于抵扣手续费的币种 fee_discount String 费率折扣
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
&type=buy
&client_id=client1
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"data": [
{
"id": 35436199,
"account_id": 0,
"create_time": 1636079744,
"finished_time": null,
"amount": "1.00000000",
"amount_asset": "BTC",
"price": "51000",
"deal_amount": "0",
"deal_money": "0",
"deal_fee": "0",
"stock_fee": "0",
"money_fee": "0",
"asset_fee": "0",
"fee_asset": "CET",
"fee_discount": "0.7000",
"avg_price": "0.00",
"market": "BTCUSDT",
"left": "1.00000000",
"maker_fee_rate": "0.0018",
"taker_fee_rate": "0.0018",
"order_type": "limit",
"type": "buy",
"status": "not_deal",
"client_id": "abcd222"
}
],
"curr_page": 1,
"has_next": false,
"count": 4,
"total": 4
},
"message": "Success"
}
GET /order/pending- 是否需要签名：是
-
查询未成交的订单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String No 市场名称 page Integer Yes 页码，从1开始 limit Integer Yes 每页条数，最大100 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户type String No sell: 卖单;
buy: 买单;client_id String No client_id是订单的自定义ID。可批量查询使用同一client_id的订单。 - 返回结果:
| 名称 | 类型 | 描述 |
|---|---|---|
| id | Integer | 订单号 |
| market | String | 市场名称 |
| order_type | String | limit:限价单; market:市价单; |
| price | String | 订单价格 |
| type | String | sell: 卖单; buy: 买单; |
| create_time | Integer | 下单时间戳 |
| finished_time | Integer | 订单完成时间戳 |
| status | String | not_deal: 未成交(订单仍在挂单中); part_deal: 部分成交(订单仍在挂单中); done: 完全成交(订单已完成); cancel:订单取消(订单已完成); 为了保证服务器性能，所有取消的订单均不会保存 |
| amount | String | 订单量 |
| deal_amount | String | 成交量 |
| left | String | 订单剩余未成交的数量 |
| avg_price | String | 平均价格 |
| deal_money | String | 成交额 |
| maker_fee_rate | String | maker费率 |
| taker_fee_rate | String | taker费率 |
| deal_fee | String | 交易费 |
| stock_fee | String | 收取的基准币种手续费 |
| money_fee | String | 收取的标价币种手续费 |
| asset_fee | String | 收取的抵扣手续费的币种的数量 |
| fee_asset | String | 用于抵扣手续费的币种 |
| fee_discount | String | 费率折扣 |
| client_id | String | 用户定义的订单id |
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
&type=buy
&client_id=client1
&stop_order_id=423842
&start_time=1636451914
&end_time=1681724907
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"data": [
{
"id": 35435967,
"account_id": 0,
"create_time": 1636011309,
"finished_time": 1636011309,
"amount": "0.01",
"amount_asset": "BTC",
"price": "56000",
"deal_amount": "0.01",
"deal_money": "560",
"deal_fee": "0.896",
"stock_fee": "0",
"money_fee": "0.896",
"asset_fee": "0",
"fee_asset": "",
"fee_discount": "1",
"avg_price": "56000",
"market": "BTCUSDT",
"left": "0",
"maker_fee_rate": "0.0016",
"taker_fee_rate": "0.0016",
"order_type": "limit",
"type": "buy",
"status": "done",
"client_id": "abcd222"
}
],
"curr_page": 1,
"has_next": false,
"count": 8
},
"message": "Success"
}
GET /order/finished- 是否需要签名：是
-
查询历史订单
- 请求参数:
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| access_id | String | Yes | access_id |
| market | String | No | 市场名称 |
| start_time | Integer | Yes | 查询开始时间 |
| end_time | Integer | Yes | 查询结束时间 |
| page | Integer | Yes | 页码，从1开始 |
| limit | Integer | Yes | 每页条数，最大100 |
| tonce | Integer | Yes | 毫秒时间戳，与服务器时间可接受误差范围为±60s |
| account_id | Integer | No | 现货账户ID: 0, 杠杆账户ID: 见获取市场杠杆账户 |
| type | String | No | sell: 卖单; buy: 买单; |
| client_id | String | No | 用户定义的id |
| stop_order_id | Integer | No | 计划委托订单id |
- 返回结果:
同查询未完成的订单接口
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
&type=buy
&client_id=client1
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"data": [
{
"account_id": 0,
"order_id": 35436627,
"create_time": 1636104345,
"amount": "0.01000000",
"price": "59000",
"stop_price": "54999",
"taker_fee": "0.0018",
"maker_fee": "0.0018",
"state": 1,
"fee_asset": "CET",
"fee_discount": "0.7000",
"market": "BTCUSDT",
"order_type": "limit",
"type": "buy",
"client_id": "abcd222"
}
],
"curr_page": 1,
"has_next": false,
"count": 1,
"total": 1
},
"message": "Success"
}
GET /order/stop/pending- 是否需要签名：是
-
查询未成交的计划订单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String No 市场名称 page Integer Yes 页码，从1开始 limit Integer Yes 每页条数，最大100 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户type String No 操作
sell: 卖单;
buy: 买单;client_id String No client_id是订单的自定义ID。可批量查询使用同一client_id的订单。 -
返回结果:
名称 类型 描述 amount String 订单量 stop_price String 触发价格 create_time Integer 下单时间戳 account_id Integer 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户state Integer 计划单触发价与当前市场价的关系
1:低于当前市场价
2:高于当前市场价order_id Integer 订单号 maker_fee String maker费率 market String 市场名称 order_type String limit:限价单;
market:市价单;price String 订单价格 taker_fee String taker费率 type String sell: 卖单;
buy: 买单;client_id String 用户定义的订单id fee_asset String 用于抵扣手续费的币种 fee_discount String 费率折扣
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
&type=buy
&start_time=1636451914
&end_time=1681724907
&page=1
&limit=100
// Response
{
"code": 0,
"data": {
"data": [
{
"id": 462666,
"order_id": 35435973,
"account_id": 0,
"create_time": 1636020409,
"type": "sell",
"role": "taker",
"price": "54000",
"amount": "0.6655976",
"fee": "20.127671424",
"fee_asset": "CET",
"market": "BTCUSDT",
"deal_money": "35942.2704"
}
],
"curr_page": 1,
"has_next": false,
"count": 2
},
"message": "Success"
}
GET /order/user/deals- 是否需要签名：是
-
查询用户成交记录
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String No 市场名称 page Interger Yes 页码，从1开始 limit Interger Yes 每页数量，最大100 tonce Interger Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户type String No sell: 卖单;
buy: 买单;start_time Integer No 开始时间 end_time Integer No 结束时间 - 返回结果:
同查询已完成订单明细接口
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&id=462672
&market=ETHUSDT
&account_id=0
&type=buy
// Response
{
"code": 0,
"data": {
"id": 35436612,
"account_id": 2,
"create_time": 1636098643,
"finished_time": null,
"amount": "1.00000000",
"price": "62443",
"deal_amount": "0",
"deal_money": "0",
"deal_fee": "0",
"stock_fee": "0",
"money_fee": "0",
"asset_fee": "0",
"fee_asset": "CET",
"fee_discount": "0.70",
"avg_price": "0.00",
"market": "BTCUSDT",
"left": "1.00000000",
"maker_fee_rate": "0.0018",
"taker_fee_rate": "0.0018",
"order_type": "limit",
"type": "sell",
"status": "not_deal",
"client_id": ""
},
"message": "Success"
}
DELETE /order/pending- 是否需要签名：是
- 取消订单
-
限速规则: 200次/10s
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id id Integer No 订单id market String Yes 市场名称 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer No 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户type String No sell: 卖单;
buy: 买单; -
返回结果:
名称 类型 描述 id Integer 订单号 market String 市场名称 order_type String limit:限价单;
market:市价单;price String 订单价格 type String sell: 卖单;
buy: 买单;create_time Integer 下单时间戳 finished_time Integer 订单完成时间戳 status String not_deal: 未成交(订单仍在挂单中);
part_deal: 部分成交(订单仍在挂单中);
done: 完全成交(订单已完成);
cancel:订单取消(订单已完成);
为了保证服务器性能，所有取消的订单均不会保存amount String 订单量 deal_amount String 成交量 left String 订单剩余未成交的数量 avg_price String 平均价格 deal_money String 成交额 maker_fee_rate String maker费率 taker_fee_rate String taker费率 deal_fee String 交易费 stock_fee String 收取的基准币种手续费 money_fee String 收取的标价币种手续费 asset_fee String 收取的抵扣手续费的币种的数量 fee_asset String 用于抵扣手续费的币种 fee_discount String 费率折扣 Source_id String 用户自定义的source_id
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&batch_ids=462672,462673
&market=ETHUSDT
&account_id=0
// Response
{
"code": 0,
"data": null,
"message": "Success"
}
DELETE /order/pending/batch- 是否需要签名：是
-
批量取消订单，单次最大100
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id batch_ids String Yes 英文”,”分隔的订单 id 列表: “1,2,3” market String Yes 市场名称 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer no 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户 - 返回结果:
同取消订单接口
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
// Response
{
"code": 0,
"data": {
},
"message": "Ok"
}
DELETE /order/pending- 是否需要签名：是
-
取消所有订单
-
请求参数:
name type required description access_id String Yes access_id market String Yes 市场名称 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer no 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
&type=buy
// Response
{
"code": 0,
"data": null,
"message": "Success"
}
Delete /order/stop/pending/<int:order_id>- 是否需要签名：是
-
取消未成交的计划订单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String Yes 市场名称 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer no 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户type String No sell: 卖单;
buy: 买单; - 返回结果:
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
// Response
{
"code": 0,
"data": null,
"message": "Success"
}
Delete /order/stop/pending- 是否需要签名：是
-
取消所有未成交的计划订单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String Yes 市场名称 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s account_id Integer no 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户 - 返回结果:
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": {
"spot": {
"ALL": {
"taker": "0",
"maker": "0"
}
},
"perpetual": {
"ALL": {
"taker": "0.00025",
"maker": "-0.00025"
}
}
},
"message": "Success"
}
-
GET /order/user/trade/fee -
获取用户交易费率
-
是否需要签名：是
-
请求参数: 无
-
返回参数说明
名称 类型 描述 spot object 现货交易费率 perpetual object 合约交易费率 taker String taker费率 maker String maker费率 -
备注: API创建后，需要等待10分钟才能获取到真实交易费率
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
// Response
{
"code": 0,
"data": {
"CETUSDT": {
"maker_fee_rate": "0.003",
"taker_fee_rate": "0.003",
"depths": [
"0.1",
"0.01",
"0.001",
"0.0001",
"0.00001",
"0.000001",
"0.0000001",
"0.00000001"
],
"is_amm_market": true
},
"CETUSDC": {
"maker_fee_rate": "0.001",
"taker_fee_rate": "0.001",
"depths": [
"0.0001",
"0.00001",
"0.000001",
"0.0000001",
"0.00000001"
],
"is_amm_market": false
}
},
"message": "Success"
}
-
GET /order/market/trade/info -
获取市场交易信息
-
是否需要签名：否
-
请求参数: 无
-
返回参数说明
名称 类型 描述 maker_fee_rate String maker交易费率 taker_fee_rate String taker交易费率 depth List 深度列表 is_amm_market bool 是否可以自动做市
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETHUSDT",
"id": 462672,
"price": "1100",
"amount": "1"
}
// Response
{
"code": 0,
"data": {
"id": 35436205,
"create_time": 1636080705,
"finished_time": null,
"amount": "0.30000000",
"price": "56000",
"deal_amount": "0.24721428",
"deal_money": "13843.9996800000000000",
"deal_fee": "0",
"stock_fee": "0",
"money_fee": "0",
"asset_fee": "8.721719798400000000000000",
"fee_asset": "CET",
"fee_discount": "0.70",
"avg_price": "56000",
"market": "BTCUSDT",
"left": "0.05278572",
"maker_fee_rate": "0.0018",
"taker_fee_rate": "0.0018",
"order_type": "limit",
"type": "buy",
"status": "cancel",
"client_id": "abcd222",
"source_id": "1234"
},
"message": "Success"
}
POST /order/modify- 是否需要签名：是
-
修改普通委托单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes access_id market String Yes 市场名称 id Interger Yes 订单号 amount String No 下单量, 最小下单量由市场决定 price String No 下单价格，由市场决定 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s - 返回结果:
同限价下单接口
示例
// Request
{
"access_id": "4DA36FFC61334695A66F8D29020EB589",
"tonce": 1513746038205,
"market": "ETHUSDT",
"id": 462672,
"price": "1100",
"stop_price": "1000",
"amount": "1"
}
// Response
{
"code": 0,
"data": {
"status": "success"
},
"message": "Success"
}
POST /order/stop/modify- 是否需要签名：是
-
修改计划委托单
-
请求参数:
名称 类型 是否必须 描述 access_id String Yes 密钥ID market String Yes 市场名称 id Interger Yes 订单号 amount String No 下单量, 最小下单量由市场决定 price String No 下单价格, 精确到小数点后8位 stop_price String No 触发价格, 精确到小数点后8位 tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s - 返回结果:
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
&client_id=client1
// Response
{
"code": 0,
"data": [
{
"code": 0,
"order": {
"id": 35435975,
"account_id": 0,
"create_time": 1636020972,
"finished_time": 1636020972,
"amount": "1000",
"price": "0",
"deal_amount": "811.88590061",
"deal_money": "43814713.2324293",
"deal_fee": "60763.149707616",
"stock_fee": "0",
"money_fee": "60763.149707616",
"asset_fee": "3269.137012494808",
"fee_asset": "CET",
"fee_discount": "0.7",
"avg_price": "53966.58963963985619139301",
"market": "BTCUSDT",
"left": "0",
"maker_fee_rate": "0",
"taker_fee_rate": "0.0016",
"order_type": "market",
"type": "sell",
"status": "done",
"client_id": ""
},
"message": ""
}
],
"message": "Ok"
}
DELETE /order/pending/by_client_id- 是否需要签名：是
-
通过client_id撤销订单
-
请求参数:
name type required description access_id String Yes access_id market String no 市场名称 client_id String Yes client_id是订单的自定义ID。可批量撤销使用同一client_id的订单。 account_id Integer no 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s
示例
// Request
access_id=4DA36FFC61334695A66F8D29020EB589
&tonce=1513746038205
&market=ETHUSDT
&account_id=0
&client_id=client1
// Response
{
"code": 0,
"data": [
{
"code": 0,
"order": {
"id": 35435975,
"account_id": 0,
"create_time": 1636020972,
"finished_time": 1636020972,
"amount": "1000",
"price": "0",
"deal_amount": "811.88590061",
"deal_money": "43814713.2324293",
"deal_fee": "60763.149707616",
"stock_fee": "0",
"money_fee": "60763.149707616",
"asset_fee": "3269.137012494808",
"fee_asset": "CET",
"fee_discount": "0.7",
"avg_price": "53966.58963963985619139301",
"market": "BTCUSDT",
"left": "0",
"maker_fee_rate": "0",
"taker_fee_rate": "0.0016",
"order_type": "market",
"type": "sell",
"status": "done",
"client_id": ""
},
"message": ""
}
],
"message": "Ok"
}
DELETE /order/stop/pending/by_client_id- 是否需要签名：是
-
通过client_id撤销计划委托单
-
请求参数:
name type required description access_id String Yes access_id market String no 市场名称 client_id String Yes client_id是订单的自定义ID。可批量撤销使用同一client_id的订单。 account_id Integer no 现货账户ID: 0,
杠杆账户ID: 见获取市场杠杆账户tonce Integer Yes 毫秒时间戳，与服务器时间可接受误差范围为±60s
WebSocket
websocket地址是 wss://socket.coinex.com/
在一个连接中如果对同一个数据重复订阅，前一个订阅会被取消
- 压缩请求
在尝试连接时，需要配置通过 Deflate 算法进行压缩，参考标准为 RFC7692，开发人员大部分使用的 工具库都支持了这一特性，只需要稍加配置即可开启。
右侧示例为 Python 的 websockets 的代码实现：
import websockets
websockets.connect(..., compression='deflate')
- 请求参数说明:
- method: 方法, String.
- params: 参数, Array.
- id: 请求id, Integer
请求示例:
{ "id": 4, "method": "state.subscribe", "params": [] }
-
返回结果
- result: Json对象, 空为失败.
- error: Json对象, 空为成功, 非空为失败.
- code: 错误码
- message: 错误信息
- id: 请求id, Integer.
返回示例
//success
{
"error": null,
"id": 4,
"result": "success"
}
//success with result
{
"error": null
"id": 4,
"result": {}
}
//error
{
"error": {
"code": 1,
"message": ""
},
"id": 4,
"result": null
}
-
推送
- method: 方法, String
- params: 参数, Array
- id: Null
推送示例:
{
"id": null,
"method": "state.update",
"params": []
}
- 错误码描述
| 错误码 | 错误信息 | 描述 |
|---|---|---|
| 1 | invalid argument | 无效参数 |
| 2 | internal error | 内部错误 |
| 3 | service unavailable | 服务不可用 |
| 4 | method not found | 未找到方法 |
| 5 | service timeout | 服务超时 |
| 6 | require auth | 需要授权 |
| 7 | too quick | 访问频率过快 |
示例:
// Request
{
"method": "server.sign",
"params": [
"4DA36FFC61334695A66F8D29020EB589",
"C6F0DDA352101C2258F992A277397F4A",
1513746038205
],
"id": 15,
}
// Response
{
"error": null,
"result": {
"status": "success"
},
"id": 15
}
- 方法: “server.sign”
-
请求参数说明:
名称 类型 是否必须 描述 access_id String Yes access_id sign_data String Yes 对字符串 “access_id={access_id}&tonce={tonce}&secret_key={secret_key}” 使用32位MD5算法进行加密，将加密结果转换为大写 timestamp Interger Yes 时间戳, 毫秒, 跟服务器时间戳相差不能大于1分钟 -
返还参数说明:
名称 类型 描述 status String 请求结果, 当鉴权成功时返回值为”success”, 鉴权失败信息存在于error字段中
示例:
// Request
{
"method":"server.ping",
"params":[],
"id": 11
}
// Response
{
"error": null,
"result": "pong",
"id": 11
}
- 方法: “server.ping”
-
返还参数说明:
名称 类型 描述 result String “pong”
示例:
// Request
{
"method":"server.time",
"params":[],
"id": 11
}
// Response
{
"error": null,
"result": 1493285895,
"id": 11
}
- 方法: “server.time”
-
返还参数说明:
名称 类型 描述 timestamp Integer 时间戳，单位：秒
示例:
// Request
{
"method":"kline.query",
"params":[
"BTCUSDT",
1639982322,
1639985922,
60
],
"id": 5
}
// Response
{
"error": null,
"result": [
[
1639982280,
"46324.37",
"46345.71",
"46356.11",
"46324.37",
"0.20288204",
"9402.0920386072"
]
],
"id": 5
}
- 方法: “kline.query”
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称 params[1] Integer Yes start_time, 开始时间 params[2] Integer Yes end_time, 结束时间 params[3] Integer Yes period, 周期, 1min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 12hour, 1day, 3day, 1week -
返还参数说明:
名称 类型 描述 result[0][0] Integer 时间戳 result[0][1] String 开盘价 result[0][2] String 收盘价 result[0][3] String 最高价 result[0][4] String 最低价 result[0][5] String 数量 result[0][6] String 交易额
示例:
// Request
{
"method": "state.query",
"params": [
"BTCUSD",
86400,
],
"id":15
}
// Response
{
"error": null,
"result": {
"open": "47598.70",
"last": "46318.55",
"high": "48262.66",
"low": "46111.11",
"deal": "26883503.6092410415",
"volume": "572.07705108",
"sell_total": "11.74193255",
"buy_total": "6.76222116",
"period": 86400
},
"id": 15
}
- 方法: “state.query”
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称 params[1] Integer Yes period, 周期, 例如. 86400为过去24小时 -
返还参数说明
名称 类型 描述 open String 开盘价 last String 最新价 high String 最高价 low String 最低价 deal String 总交易额 volume String 总交易量 sell_total String 卖单数量 buy_total String 买单数量 period Integer 周期
示例:
// Request
{
"method": "state.subscribe",
"params": [
"BTCUSD"
],
"id":15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “state.subscribe”
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称, 空为订阅所有市场 -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "state.update",
"params": [{
"BTCUSD": {
"open": "47598.70",
"last": "46318.55",
"high": "48262.66",
"low": "46111.11",
"deal": "26883503.6092410415",
"volume": "572.07705108",
"sell_total": "11.74193255",
"buy_total": "6.76222116",
"period": 86400
},
}],
"id": 15
}
- 方法: “state.update”
-
推送参数说明:
名称 类型 描述 open String 开盘价 last String 最新价 high String 最高价 low String 最低价 deal String 总交易额 volume String 总交易量 sell_total String 卖单数量 buy_total String 买单数量 period Integer 周期
示例:
// Request
{
"method": "state.unsubscribe",
"params": [],
"id": 15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “state.unsubscribe”
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method":"deals.query",
"params":[
"BTCUSD",
10,
0
],
"id":16
}
// Response
{
"error": null,
"result": [
{
"type": "sell",
"time": 1496458040.059284,
"price": "46444.74",
"id": 29433,
"amount": "0.00120000"
}
],
"id": 16
}
- 方法: “deals.query”
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称 params[1] Integer Yes limit, 获取记录数 params[2] Integer Yes last_id, 上次返回结果的最大ID -
返还参数说明:
名称 类型 描述 type String 类型, “sell”: 卖, “buy”: 买 time Float 时间戳 price String 价格 id Integer 编号 amount String 数量
示例:
// Request
{
"method":"deals.query_user",
"params":[
12,
"BTCUSDT",
1,
1639982322,
1639985922,
0,
10
],
"id":16
}
// Response
{
"error": null,
"result": [
{
"type": "sell",
"time": 1496458040.059284,
"price": "46444.74",
"id": 29433,
"amount": "0.00120000"
}
],
"id": 16
}
- 方法: “deals.query_user”
-
请求参数说明:
名称 类型 是否必须 描述 params[0] Integer Yes account, 账户
现货账户: 0
杠杆账户: 见获取市场杠杆账户
用于查询所有帐户: -1
用于查询帐户>0的交易: -2params[1] String Yes market, 市场名称 params[2] Integer Yes side, 买卖方向, 0: 所有, 1: 卖, 2: 买 params[3] Integer Yes start_time, 开始时间, 0: 不限制 params[4] Integer Yes end_time, 结束时间, 0: 不限制 params[5] Integer Yes offset, 偏移量，即从哪条开始获取 params[6] Integer Yes limit, 获取记录数 -
返还参数说明:
名称 类型 描述 type String 类型, “sell”: 卖, “buy”: 买 time Float 时间戳 price String 价格 id Integer 编号 amount String 数量
示例:
// Request
{
"method": "deals.subscribe",
"params": [
"BTCUSDT"
],
"id": 16
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “deals.subscribe”
-
请求参数说明:
名称 类型 是否必须 描述 params Array<String> No 市场列表, 空为订阅所有市场 -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "deals.update",
"params": [
"BTCUSD",
[
{
"type": "sell",
"time": 1496458040.059284,
"price": "46444.74",
"id": 29433,
"amount": "0.00120000"
}
]
],
"id": null
}
- 方法: “deals.update”
-
推送参数说明:
名称 类型 描述 params[0] String market, 市场 type String 类型, “sell”: 卖, “buy”: 买 time float 时间戳 price String 价格 id Integer 编号 amount String 数量
示例:
// Request
{
"method":"deals.unsubscribe",
"params":[],
"id":16
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “deals.unsubscribe”
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method": "depth.query",
"params": [
"BTCUSDT",
10,
"0"
],
"id": 15
}
// Response
{
"error": null,
"result": {
"asks": [
[
"46350.52",
"1.07871851"
],
...
],
"bids": [
[
"46349.61",
"0.04000000"
],
...
],
"last": "46349.93",
"time": 1639987469166,
"checksum": 1533284725
},
"id": 15
}
- 方法: “depth.query”
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称 params[1] Integer Yes limit, 获取记录数, [5, 10, 20, 50]中的其中一个 params[2] Integer Yes interval, 合并深度精度, [“10”, “1”, “0”, “0.1”, “0.01”]的其中一个 -
返还参数说明:
名称 类型 描述 last String 最新价 time Integer 时间戳 checksum Integer 校验和是全深度数据的有符号的32位整数，用于验证深度数据的准确性。
1. 构造校验和字符串：bid1_price:bid1_amount:bid2_price:bid2_amount:ask1_price:ask1_amout:…（如果没有出价，则校验和字符串是ask1_price:ask1_amount:ask2_price:ask2_amount:…）
2. 将校验和字符串使用crc32算法编码asks[0][0] String 卖一价 asks[0][1] String 卖一量 bids[0][0] String 买一价 bids[0][1] String 买一量
示例:
// Request
{
"method": "depth.subscribe",
"params": [
"BTCUSDT",
10,
"0",
true
],
"id": 15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “depth.subscribe”
- 说明: 调用该命令，会取消之前的所有市场深度订阅
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称 params[1] Integer Yes limit, 获取记录数, [5, 10, 20, 50]中的其中一个 params[2] Integer Yes interval, 合并深度精度, [“10”, “1”, “0”, “0.1”, “0.01”]的其中一个 params[3] Bool No diff, true: 增量订阅, false: 全量订阅, 默认为true -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Request
{
"method": "depth.subscribe_multi",
"params": [
["BTCUSDT", 10, "0", true],
["ETHUSDT", 10, "0", false],
],
"id": 15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “depth.subscribe_multi”
- 说明: 调用该命令，会取消之前的所有市场深度订阅
-
请求参数说明:
名称 类型 是否必须 描述 params[0][0] String Yes market, 市场名称 params[0][1] Integer Yes limit, 获取记录数, [5, 10, 20, 50]中的其中一个 params[0][2] Integer Yes interval, 合并深度精度, [“10”, “1”, “0”, “0.1”, “0.01”]的其中一个 params[0][3] Bool No diff, true: 增量订阅, false: 全量订阅, 默认为true -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "depth.update",
"params": [
false,
{
"asks": [
["46350.52", "1.07871851"],
...
],
"bids": [
["46349.61", "0.04000000"],
...
],
"last": "46349.93",
"time": 1639987469166,
"checksum": 1533284725
},
"BTCUSDT"
],
"id": null
}
- 方法: “depth.update”
- 说明:
- params[0]参数表明此次推送是增量推送或是全量推送。
- 增量推送：每次仅推送上个推送时点到当前时点更新的深度数据。每200毫秒推送一次，若无深度更新，则不推送。
- 全量推送：每次推送完整的深度数据。每200毫秒推送一次，若无深度更新，则不推送。
- 如果订阅了多个市场，通过params[2]参数来区分不同市场的推送消息。
- 市场深度每隔1分钟会推送一次全量数据。
-
推送参数说明:
名称 类型 描述 params[0] Bool true: 全量结果，false: 最新增量 last String 最新价 time Integer 时间戳 checksum Integer 校验和是全深度数据的有符号的32位整数，用于验证深度数据的准确性。
1.校验和只能根据全量结果计算，如果是增量订阅，需要先计算出全量结果
2.构造校验和字符串：bid1_price:bid1_amount:bid2_price:bid2_amount:ask1_price:ask1_amout:…（如果没有出价，则校验和字符串是ask1_price:ask1_amount:ask2_price:ask2_amount:…）
3. 将校验和字符串使用crc32算法编码asks[n][0] String 价格 asks[n][1] String 数量，为0时删除该深度，非0时替换 bids[n][0] String 价格 bids[n][1] String 数量，为0时删除该深度，非0时替换 params[2] String market, 市场名称
示例:
// Request
{
"method":"depth.unsubscribe",
"params":[],
"id":15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “depth.unsubscribe”
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method":"depth.unsubscribe_multi",
"params":[],
"id":15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “depth.unsubscribe_multi”
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method": "order.query",
"params": [
"BTCUSDT",
0,
0,
10
],
"id": 15
}
// Response
{
"error": null,
"result": {
"records": [{
"asset_fee": "0",
"account": 1,
"money_fee": "0",
"stock_fee": "0",
"ctime": 1558680350.41878,
"maker_fee": "0.0001",
"price": "0.01900000",
"deal_stock": "0",
"fee_discount": "0.9000",
"side": 1,
"source": "api",
"amount": "1.00000000",
"user": 553,
"mtime": 1558680350.41878,
"fee_asset": "CET",
"deal_money": "0",
"left": "1.00000000",
"type": 1,
"id": 303,
"market": "BTCUSDT",
"taker_fee": "0.0001",
"client_id": "test_123",
"stop_id": 0
}],
"total": 1,
"limit": 100,
"offset": 0
},
"id": 15
}
- 方法: “order.query”
- 说明: 该接口只查询账户为0的订单
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称 params[1] Integer Yes side, 0: 所有, 1: 卖, 2: 买 params[2] Integer Yes offset, 偏移量，即从哪条开始获取 params[3] Integer Yes limit, 获取记录数 -
返还参数说明:
名称 类型 描述 total Integer 返回的订单结果数 limit Integer 获取记录数 offset Integer 偏移量 asset_fee String 抵扣手续费的币种数量 account Integer 账户, 现货账户: 0 money_fee String 收取的标价币种手续费 stock_fee String 收取的基准币种手续费 ctime Float 创建时间 maker_fee String maker费率 price String 价格 deal_stock String 已成交价值 fee_discount String 费率折扣 source String 来源 side Integer 1: 卖单, 2: 买单 amount String 下单量, 最小下单量由市场决定 user Integer 用户id mtime Float 更新时间 fee_asset String 抵扣手续费的币种 deal_money String 成交量 left String 剩余未成交量 type Integer 1: 限价单, 2: 市价单 id Integer 订单id market String 市场名称 taker_fee String taker费率 client_id String 客户端自定义的id stop_id Integer 计划单id
示例:
// Request
{
"method": "order.query_stop",
"params": [
"BTCUSDT",
2,
0,
10
],
"id": 15
}
// Response
{
"error": null,
"result": {
"limit":10,
"offset":0,
"total":1,
"records":[
{
"id":259,
"type":2,
"side":2,
"user":1415,
"account":0,
"option":68,
"state":1,
"ctime":1640483195.167732,
"mtime":1640483195.167732,
"market":"BTCUSDT",
"source":"http_api_test",
"client_id":"",
"stop_price":"54999.00000000",
"price":"0",
"amount":"100000.00000000",
"taker_fee":"0.0010",
"maker_fee":"0.0010",
"fee_discount":"1",
"fee_asset":null
}
]
},
"id": 15
}
- 方法: “order.query_stop”
- 说明: 该接口只查询账户为0的订单
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称 params[1] Integer Yes side, 0: 所有, 1: 卖, 2: 买 params[2] Integer Yes offset, 偏移量，即从哪条开始获取 params[3] Integer Yes limit, 获取记录数 -
返还参数说明:
名称 类型 描述 total Integer 返回的订单结果数 limit Integer 获取记录数 offset Integer 偏移量 account Integer 账户, 现货账户: 0 money_fee String 收取的标价币种手续费 state Integer 计划单触发价与当前市场价的关系
1:低于当前市场价
2:高于当前市场价ctime Float 创建时间 maker_fee String maker费率 price String 价格 fee_discount String 费率折扣 source String 来源 side Integer 1: 卖单, 2: 买单 amount String 下单量, 最小下单量由市场决定 user Integer 用户id mtime Float 更新时间 type Integer 1: 限价单, 2: 市价单 id Integer 订单id market String 市场名称 stop_price String 触发价格 taker_fee String taker费率 client_id String 客户端自定义的id
示例:
// Request
{
"method": "order.account_query",
"params": [
12,
"BTCUSDT",
0,
0,
10
],
"id": 15
}
// Response
{
"error": null,
"result": {
"records": [{
"asset_fee": "0",
"account": 1,
"money_fee": "0",
"stock_fee": "0",
"ctime": 1558680350.41878,
"maker_fee": "0.0001",
"price": "0.01900000",
"deal_stock": "0",
"fee_discount": "0.9000",
"side": 1,
"source": "api",
"amount": "1.00000000",
"user": 553,
"mtime": 1558680350.41878,
"fee_asset": "CET",
"deal_money": "0",
"left": "1.00000000",
"type": 1,
"id": 303,
"market": "BTCUSDT",
"taker_fee": "0.0001",
"client_id": "test_123",
"stop_id": 0
}],
"total": 1,
"limit": 100,
"offset": 0
},
"id": 15
}
- 方法: “order.account_query”
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params[0] Integer Yes account, 账户
现货账户: 0
杠杆账户: 见获取市场杠杆账户
用于查询所有帐户: -1
用于查询帐户>0的交易: -2params[1] String Yes market, 市场名称 params[2] Integer Yes side, 0: 所有, 1: 卖, 2: 买 params[3] Integer Yes offset, 偏移量，即从哪条开始获取 params[4] Integer Yes limit, 获取记录数 -
返还参数说明:
名称 类型 描述 total Integer 返回的订单结果数 limit Integer 获取记录数 offset Integer 偏移量 asset_fee String 抵扣手续费的币种数量 account Integer 账户, 现货账户: 0, 杠杆账户: 见获取市场杠杆账户 money_fee String 收取的标价币种手续费 stock_fee String 收取的基准币种手续费 ctime Float 创建时间 maker_fee String maker费率 price String 价格 deal_stock String 已成交价值 fee_discount String 费率折扣 source String 来源 side Integer 1: 卖单, 2: 买单 amount String 下单量, 最小下单量由市场决定 user Integer 用户id mtime Float 更新时间 fee_asset String 抵扣手续费的币种 deal_money String 成交量 left String 剩余未成交量 type Integer 1: 限价单, 2: 市价单 id Integer 订单id market String 市场名称 taker_fee String taker费率 client_id String 客户端自定义的id stop_id Integer 计划单id
示例:
// Request
{
"method": "order.account_query_stop",
"params": [
12,
"BTCUSDT",
0,
0,
10
],
"id": 15
}
// Response
{
"error": null,
"result": {
"limit":10,
"offset":0,
"total":1,
"records":[
{
"id":259,
"type":2,
"side":2,
"user":1415,
"account":0,
"option":68,
"state":1,
"ctime":1640483195.167732,
"mtime":1640483195.167732,
"market":"BTCUSDT",
"source":"http_api_test",
"client_id":"",
"stop_price":"54999.00000000",
"price":"0",
"amount":"100000.00000000",
"taker_fee":"0.0010",
"maker_fee":"0.0010",
"fee_discount":"1",
"fee_asset":null
}
]
},
"id": 15
}
- 方法: “order.account_query_stop”
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params[0] Integer Yes account, 账户
现货账户: 0
杠杆账户: 见获取市场杠杆账户
用于查询所有帐户: -1
用于查询帐户>0的交易: -2params[1] String Yes market, 市场名称 params[2] Integer Yes side, 0: 所有, 1: 卖, 2: 买 params[3] Integer Yes offset, 偏移量，即从哪条开始获取 params[4] Integer Yes limit, 获取记录数 -
返还参数说明:
名称 类型 描述 total Integer 返回的订单结果数 limit Integer 获取记录数 offset Integer 偏移量 account Integer 账户, 现货账户: 0 money_fee String 收取的标价币种手续费 ctime Float 创建时间 maker_fee String maker费率 state Integer 计划单触发价与当前市场价的关系
1:低于当前市场价
2:高于当前市场价price String 价格 fee_discount String 费率折扣 source String 来源 side Integer 1: 卖单, 2: 买单 amount String 下单量, 最小下单量由市场决定 user Integer 用户id mtime Float 更新时间 type Integer 1: 限价单, 2: 市价单 id Integer 订单id market String 市场名称 stop_price String 触发价格 taker_fee String taker费率 client_id String 客户端自定义的id
示例:
// Request
{
"method": "order.subscribe",
"params": [
"BTCUSDT"
],
"id": 15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “order.subscribe”
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params Array<String> Yes market list, 市场列表 -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "order.update",
"params": [
3,
{
"asset_fee": "0",
"account": 1,
"money_fee": "0",
"stock_fee": "0",
"ctime": 1558680350.41878,
"maker_fee": "0.0001",
"price": "0.01900000",
"deal_stock": "0",
"fee_discount": "0.9000",
"side": 1,
"source": "api",
"amount": "1.00000000",
"user": 553,
"mtime": 1558680350.41878,
"fee_asset": "CET",
"deal_money": "0",
"left": "1.00000000",
"type": 1,
"id": 303,
"market": "BTCUSDT",
"taker_fee": "0.0001",
"client_id": "test_123",
"stop_id": 0
}
],
"id": null
}
- 方法: “order.udpate”
- 鉴权: 需要, 参考server.sign
-
推送参数说明:
名称 类型 描述 params[0] Integer event, 事件类型, 1: PUT, 2: UPDATE, 3: FINISH asset_fee String 抵扣手续费的币种数量 account Integer 账户, 现货账户: 0, 杠杆账户: 见获取市场杠杆账户 money_fee String 收取的标价币种手续费 stock_fee String 收取的基准币种手续费 ctime Float 创建时间 maker_fee String maker费率 price String 价格 deal_stock String 已成交价值 fee_discount String 费率折扣 source String 来源 side Integer 1: 卖单, 2: 买单 amount String 下单量, 最小下单量由市场决定 user Integer 用户id mtime Float 更新时间 fee_asset String 抵扣手续费的币种 deal_money String 成交量 left String 剩余未成交量 type Integer 1: 限价单, 2: 市价单 id Integer 订单id market String 市场名称 taker_fee String taker费率 client_id String 客户端自定义的id stop_id Integer 计划单id
示例:
// Request
{
"method": "order.unsubscribe",
"params": [],
"id":15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “order.unsubscribe”
- 鉴权: 需要, 参考server.sign
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method": "asset.query",
"params": [
"BTC",
"ETH"
],
"id": 15
}
// Response
{
"error": null,
"result": {
"BTC": {
"available": "5",
"frozen": "1",
},
"ETH": {
"available": "5",
"frozen": "1",
}
},
"id": 15
}
- 方法: “asset.query”
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params Array<String> Yes asset list, 资产列表 -
返还参数说明:
名称 类型 描述 available String 可用的金额 frozen String 冻结的金额
示例:
// Request
{
"method": "asset.account_query",
"params": [
0,
["BTC","ETH"]
],
"id": 15
}
// Response
{
"error": null,
"result": {
"BTC": {
"available": "250",
"frozen": "10",
},
"ETH":{
"available": "250",
"frozen": "10",
}
},
"id": 15
}
- 方法: “asset.account_query”
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params[0] Integer Yes account, 账户
现货账户: 0
杠杆账户: 见获取市场杠杆账户params[1] Array<String> Yes asset array, 资产列表 -
返还参数说明:
名称 类型 描述 available String 可用的金额 frozen String 冻结的金额
示例:
// Request
{
"method":"asset.account_query_all",
"params":[],
"id":15
}
// Response
{
"error": null,
"result": {
"1": {
"BCH": {
"available": "990554.89473682",
"frozen": "9445.10526318"
},
"BTC": {
"available": "92.919825",
"frozen": "7.08000000"
}
},
"0": {
"CET": {
"available": "999900473.1500094689",
"frozen": "0"
},
"BCH": {
"available": "1002000200.00000000",
"frozen": "0"
},
"BTC": {
"available": "100.00000000",
"frozen": "0"
}
},
...
},
"id": 15
}
- 方法: “asset.account_query_all”
- 鉴权: 需要, 参考server.sign
-
返还参数说明:
名称 类型 描述 available String 可用的金额 frozen String 冻结的金额
示例:
// Request
{
"method": "asset.subscribe",
"params": ["BTC"],
"id": 15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “asset.subscribe”
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params Array<String> Yes asset list, 资产列表 -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "asset.update",
"params": [
{
"BTC": {
"available": "250",
"frozen": "10",
}
}
],
"id": null
}
- 方法: “asset.update”
- 鉴权: 需要, 参考server.sign
-
推送参数说明:
名称 类型 描述 available String 可用的金额 frozen String 冻结的金额
示例:
// Request
{
"method": "asset.unsubscribe",
"params": [],
"id": 15
}
// Response
{
"error": null,
"id": 4,
"result": "success"
}
- 方法: “asset.unsubscribe”
- 鉴权: 需要, 参考server.sign
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method":"index.query",
"params":[
"BTCUSDT",
],
"id":15
}
// Response
{
"error": null,
"result": {
"name": "BTCUSDT",
"time": 1637548343,
"index": "57000.00"
},
"id": 15
}
- 方法: “index.query”
-
请求参数说明:
名称 类型 是否必须 描述 params[0] String Yes market, 市场名称 -
返还参数说明:
名称 类型 描述 name String 市场名称 time Integer 时间戳 index String 指标价
示例:
// Request
{
"method":"index.list",
"params":[],
"id":15
}
// Response
{
"error": null,
"result": {
"BTC": {
"time": 1637564110000,
"index": "239094157.9068"
},
"HCUSDT": {
"time": 1637564110000,
"index": "1.005"
},
"BSVUSDT": {
"time": 1637564110000,
"index": "155.54000000"
},
...
},
"id": 15
}
- 方法: “index.list”
-
返还参数说明:
名称 类型 描述 time Integer 时间戳 index String 指标价
示例:
// Request
{
"method": "index.subscribe",
"params": [],
"id":15
}
// Response
{
"error": null,
"result": "success",
"id": 15
}
- 方法: “index.subscribe”
-
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "index.update",
"params": [
"BTCUSDT",
"57000.00"
],
"id": null
}
- 方法: “index.update”
-
推送参数说明:
名称 类型 描述 params[0] String 市场名称 params[1] String 指标价
示例:
// Request
{
"method": "index.unsubscribe",
"params": [],
"id":15
}
// Response
{
"error": null,
"result": "success",
"id": 15
}
- 方法: “index.unsubscribe”
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method": "notice.subscribe",
"params": [
101
],
"id":15
}
// Response
{
"error": null,
"result": "success",
"id": 15
}
- 方法: “notice.subscribe”
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params[0] Integer Yes 101,表示临时维护通知 -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "notice.update",
"params": [
101,
{
"started_at": 1655347758,
"ended_at": 1656556940,
"protect_duration_start": 1703834254,
"protect_duration_end": 1703834854,
"scope": ["SPOT"]
}
],
"id": null
}
- 方法: “notice.update”
-
推送参数说明:
名称 类型 描述 params[0] Integer 订阅id，101表示临时维护通知 params[1] Object 维护内容 started_at Integer 维护开始时间 ended_at Integer 维护结束时间 protect_duration_start Integer 维护结束后的保护期开始时间 protect_duration_end Integer 维护结束后的保护期结束时间 scope Array<String> 维护范围，PERPETUAL: 合约, SPOT: 现货, ALL_SITE: 全局维护
示例:
// Request
{
"method": "notice.unsubscribe",
"params": [],
"id":15
}
// Response
{
"error": null,
"result": "success",
"id": 15
}
- 方法: “notice.unsubscribe”
- 鉴权: 需要, 参考server.sign
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method": "deals_own.subscribe",
"params": [
"BTCUSDT"
],
"id":15
}
// Response
{
"error": null,
"result": "success",
"id": 15
}
- 方法: “deals_own.subscribe”
- 鉴权: 需要, 参考server.sign
-
请求参数说明:
名称 类型 是否必须 描述 params Array<String> No 市场列表, 空为订阅所有市场 -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "deals_own.update",
"params": [
"BTCUSDT",
[
{
"type": "sell",
"time": 1496458040.059284,
"price": "46444.74",
"id": 29433,
"amount": "0.00120000",
"order_id": 523941,
"client_id": ""
}
]
],
"id": null
}
- 方法: “deals_own.update”
-
推送参数说明:
名称 类型 描述 params[0] String market, 市场 type String 类型, “sell”: 卖, “buy”: 买 time float 时间戳 price String 价格 id Integer 编号 amount String 数量 order_id Integer 订单id client_id String 客户端id
示例:
// Request
{
"method": "deals_own.unsubscribe",
"params": [],
"id":15
}
// Response
{
"error": null,
"result": "success",
"id": 15
}
- 方法: “deals_own.unsubscribe”
- 鉴权: 需要, 参考server.sign
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果
示例:
// Request
{
"method": "bbo.subscribe",
"params": ["BTCUSDT"],
"id":15
}
// Response
{
"error": null,
"result": "success",
"id": 15
}
- 方法: “bbo.subscribe”
-
请求参数说明:
名称 类型 是否必须 描述 params Array<String> No 市场列表, 空为订阅所有市场 -
返还参数说明:
名称 类型 描述 result String 订阅结果
示例:
// Notify
{
"method": "deals_own.update",
"params": {
"market": "BTCUSDT"
"time": 1656660154,
"bid_price": "20000",
"bid_amount": "0.1",
"ask_price": "200001",
"ask_amount": "0.15"
},
"id": null
}
- 方法: “bbo.update”
-
推送参数说明:
名称 类型 描述 market String 市场名称 time Integer 时间戳 bid_price String 买一价 bid_amount String 买一量 ask_price String 卖一价 ask_amount String 卖一量
示例:
// Request
{
"method": "bbo.unsubscribe",
"params": [],
"id":15
}
// Response
{
"error": null,
"result": "success",
"id": 15
}
- 方法: “bbo.unsubscribe”
-
返还参数说明:
名称 类型 描述 result String 取消订阅结果