-
Notifications
You must be signed in to change notification settings - Fork 3
REST_API_Reference_C
重要:完整的请求格式请参考API请求、返回格式说明,以下描述API接口时只列出部分。
目录
POST https://api.bibox.com/v1/cquery
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|
POST请求方法:query/assets
返回结果说明
{
"result":[
{
"result":{
"balance":"97.2378", // 可用余额
"freeze":"1.7326", // 冻结金额
"profit":"-2.4327",
"margin":"1.7326",
"imargin":"0.0000",
"total_balance":"98.8397",
"BTCValue":"0.02528321",
"CNYValue":"664.61",
"USDValue":"98.84",
"floatProfitBTC":"-0.00003344",
"floatProfit":"-0.1308",
"profitBTC":"-0.00062226",
"freezeBTC":"0.00044322"
},
"cmd":"query/assets"
}
]
}
示例
// Request
{
"cmd":"query/assets",
"body":{
}
}
// Response
{
"result":[
{
"result":{
"balance":"97.2378", // 可用余额
"freeze":"1.7326", // 冻结金额
"profit":"-2.4327",
"margin":"1.7326",
"imargin":"0.0000",
"total_balance":"98.8397",
"BTCValue":"0.02528321",
"CNYValue":"664.61",
"USDValue":"98.84",
"floatProfitBTC":"-0.00003344",
"floatProfit":"-0.1308",
"profitBTC":"-0.00062226",
"freezeBTC":"0.00044322"
},
"cmd":"query/assets"
}
]
}
POST https://api.bibox.com/v1/cquery
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
pair | true | string | 合约符号 | 4BTC_USDT,4ETH_USDT, ... |
POST请求方法:query/order
返回结果说明
{
"result":[
{
"result":{
"coin_symbol":"USDT",
"pair":"4BTC_USDT", // 合约符号
"contract":2, // 持仓张数
"margin":"1.5612", // 持仓保证金
"profit":"-2.4995",
"price":"3903.0450", // 开仓均价
"order_side":2, // 开仓方向:1开多,2开空
"price_force":"3961.5907", // 强平价格
"floatProfit":"-0.1376",
"leverage":50, // 0:全仓,其它:逐仓杠杆倍数
"icontract_up":2, // 开多未成交订单张数
"icontract_down":0 // 开空未成交订单张数
},
"cmd":"query/order"
}
]
}
示例
// Request
{
"cmd":"query/order",
"body":{
"pair":"4BTC_USDT" // 合约符号:BTCUSDT永续合约符号为4BTC_USDT,ETHUSDT永续合约符号为4ETH_USDT 。。。
}
}
// Response
{
"result":[
{
"result":{
"coin_symbol":"USDT",
"pair":"4BTC_USDT",
"contract":2,
"margin":"1.5612",
"profit":"-2.4995",
"price":"3903.0450",
"order_side":2,
"price_force":"3961.5907",
"floatProfit":"-0.1376",
"leverage":50,
"icontract_up":2,
"icontract_down":0
},
"cmd":"query/order"
}
]
}
POST https://api.bibox.com/v1/cquery
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
pair | true | string | 合约符号 | 4BTC_USDT,4ETH_USDT, ... |
POST请求方法:query/orderAll
返回结果说明
{
"result":[
{
"result":[
{
"coin_symbol":"USDT",
"pair":"4BTC_USDT", // 合约符号
"contract":2, // 持仓张数
"margin":"1.5612", // 持仓保证金
"profit":"-2.4995",
"price":"3903.0450", // 开仓均价
"order_side":2, // 开仓方向:1开多,2开空
"price_force":"3961.5907", // 强平价格
"floatProfit":"-0.1376",
"leverage":50, // 0:全仓,其它:逐仓杠杆倍数
"icontract_up":2, // 开多未成交订单张数
"icontract_down":0 // 开空未成交订单张数
},
...
],
"cmd":"query/orderAll"
}
]
}
示例
// Request
{
"cmd":"query/orderAll",
"body":{
}
}
// Response
{
"result":[
{
"result":[
{
"coin_symbol":"USDT",
"pair":"4BTC_USDT",
"contract":2,
"margin":"1.5612",
"profit":"-2.4995",
"price":"3903.0450",
"order_side":2,
"price_force":"3961.5907",
"floatProfit":"-0.1376",
"leverage":50,
"icontract_up":2,
"icontract_down":0
},
{
"coin_symbol":"USDT",
"pair":"4ETH_USDT",
"contract":6,
"margin":"0.1714",
"profit":"0.0668",
"price":"142.8816",
"order_side":2,
"price_force":"145.0248",
"floatProfit":"0.0063",
"leverage":50,
"icontract_up":6,
"icontract_down":0
}
],
"cmd":"query/orderAll"
}
]
}
POST https://api.bibox.com/v1/cquery
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
page | true | integer | 第几页 | 1,2, ... | |
size | true | integer | 条数 | 10,20, ... | |
pair | false | string | 合约符号 | 4BTC_USDT,4ETH_USDT, ... |
POST请求方法:query/orderPending
返回结果说明
{
"result":[
{
"result":{
"count":3,
"page":1,
"items":[
{
"id":491168, // 订单号
"coin_symbol":"USDT",
"pair":"4ETH_USDT", // 合约符号
"order_side":1, // 挂单方向:1开多,2开空
"order_type":2,
"contract":3, // 委托合约张数
"order_from":1,
"status":1, // 0,1未成交 2部分成交 3完全成交 4部分取消 5完全取消 6,7 系统取消
"price":"136.0000", // 委托价格
"price_deal":"0.0000", // 成交均价
"deal_count":0,
"contract_deal":0, // 已成交合约张数
"createdAt":"2019-02-20T02:01:46.000Z",
"updatedAt":"2019-02-20T02:01:46.000Z"
},
...
]
},
"cmd":"query/orderPending"
}
]
}
示例
// Request
{
"cmd":"query/orderPending",
"body":{
"page":1,
"size":20,
"pair":""
}
}
// Response
{
"result":[
{
"result":{
"count":3,
"page":1,
"items":[
{
"id":491168,
"coin_symbol":"USDT",
"pair":"4ETH_USDT",
"order_side":1,
"order_type":2,
"contract":3,
"order_from":1,
"status":1,
"price":"136.0000",
"price_deal":"0.0000",
"deal_count":0,
"contract_deal":0,
"createdAt":"2019-02-20T02:01:46.000Z",
"updatedAt":"2019-02-20T02:01:46.000Z"
},
{
"id":489453,
"coin_symbol":"USDT",
"pair":"4BTC_USDT",
"order_side":1,
"order_type":2,
"contract":2,
"order_from":1,
"status":1,
"price":"3850.0000",
"price_deal":"0.0000",
"deal_count":0,
"contract_deal":0,
"createdAt":"2019-02-20T01:51:41.000Z",
"updatedAt":"2019-02-20T01:51:42.000Z"
}
]
},
"cmd":"query/orderPending"
}
]
}
POST https://api.bibox.com/v1/ctrade
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
order_type | true | integer | 订单类型 | 1:市价,2:限价 | |
leverage | true | integer | 杠杆倍数 | 全仓:0,逐仓:1,2,... | |
cross_leverage | false | integer | 全仓杠杆 | 25 | leverage=0时且全仓:1,2,...50 |
order_side | true | integer | 挂单方向 | 1:开多,2:开空 | |
price | true | string | 委托价格 | 大于0的数 | |
contract | true | string | 合约张数 | 1,2, ... | |
pair | true | string | 合约符号 | 4BTC_USDT,4ETH_USDT, ... | |
order_from | true | integer | 6 | 6 | |
client_oid | false | Long | 自定义标识 | > 0 |
POST请求方法:order/open
返回结果说明
{
"result":[
{
result: '17592186044786', // 订单号
client_oid: '123456789', // 自定义标识
cmd: 'order/open',
}
]
}
示例
// Request
{
"cmd":"order/open",
"body":{
"pair":"4BTC_USDT",
"order_type":2,
"price":"3929.97",
"contract":"1",
"order_from":1,
"leverage":50,
"cross_leverage":25,
"order_side":1,
"client_oid": '123456789',
}
}
// Response
{
"result":[
{
result: '17592186044786', // 订单号
client_oid: '123456789', // 自定义标识
cmd: 'order/open',
}
]
}
POST https://api.bibox.com/v1/ctrade
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
leverage | true | integer | 杠杆倍数 | 全仓:0,逐仓:1,2,... | |
cross_leverage | false | integer | 全仓杠杆 | 25 | leverage=0时全仓1,2,...50 |
order_side | true | integer | 挂单方向 | 1:开多,2:开空 | |
price | true | string | 委托价格 | 大于0的数 | |
contract | true | string | 合约张数 | 1,2, ... | |
pair | true | string | 合约符号 | 4BTC_USDT,4ETH_USDT, ... | |
client_oid | false | Long | 自定义标识 | > 0 |
POST请求方法:order/openBatch
返回结果说明
{
"result":[
{
"result":[
{
code: 0, // 0代表成功;非0代表失败,code是错误码
id: '17592186044787', // 挂单id号
msg: '',
client_oid: '123456787'
},
...
],
"cmd":"order/openBatch"
}
]
}
示例
// Request
{
"cmd":"order/openBatch",
"body":{
"pair":"4ETH_USDT",
"leverage":50,
"cross_leverage": 25,
"arr":[
{
"order_side":1,
"price":140,
"contract":1,
client_oid: '123456787'
},
{
"order_side":1,
"price":140.5,
"contract":1,
client_oid: '123456788'
}
]
}
}
// Response
{
"result":[
{
"result":[
{
code: 0,
id: '17592186044789',
msg: '',
client_oid: '123456787'
},
{
code: 0,
id: '17592186044790',
msg: '',
client_oid: '123456788'
}
],
"cmd":"order/openBatch"
}
]
}
POST https://api.bibox.com/v1/ctrade
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
order_id | true | integer | 订单号 |
POST请求方法:order/close
返回结果说明
{
"result":[
{
"result":"success",
"cmd":"order/close"
}
]
}
示例
// Request
{
"cmd":"order/close",
"body":{
"order_id":574954
}
}
// Response
{
"result":[
{
"result":"success",
"cmd":"order/close"
}
]
}
POST https://api.bibox.com/v1/ctrade
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
order_ids | true | integer | 订单号数组 |
POST请求方法:order/closeBatch
返回结果说明
{
"result":[
{
"result":"success",
"cmd":"order/closeBatch",
"index":13
}
]
}
示例
// Request
{
"cmd":"order/closeBatch",
"body":{
"order_ids":[
574953,
574954
]
},
"index":13
}
// Response
{
"result":[
{
"result":"success",
"cmd":"order/closeBatch",
"index":13
}
]
}
POST https://api.bibox.com/v1/ctrade
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
pair | false | string | 合约符号 | 4BTC_USDT,4ETH_USDT, ... |
POST请求方法:order/closeAll
返回结果说明
{
"result":[
{
"result":"success",
"cmd":"order/closeAll",
"index":13
}
]
}
示例
// Request
{
"cmd":"order/closeAll",
"body":{
"pair":"4BTC_USDT"
},
"index":13
}
// Response
{
"result":[
{
"result":"success",
"cmd":"order/closeAll",
"index":13
}
]
}
POST https://api.bibox.com/v1/ctrade
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
pair | true | string | 合约符号 | 4BTC_USDT,4ETH_USDT, ... | |
leverage | true | integer | 杠杆倍数 | 全仓:0,逐仓:1,2,... | |
cross | true | integer | 是否全仓 | 0逐仓,1全仓 |
POST请求方法:order/changeLeverage
返回结果说明
{
"result":[
{
"result":"success",
"cmd":"order/changeLeverage",
"index":13
}
]
}
示例
// Request
{
"cmd":"order/changeLeverage",
"body":{
"pair":"4BTC_USDT",
"leverage":40,
"cross": 0
},
"index":13
}
// Response
{
"result":[
{
"result":"success",
"cmd":"order/changeLeverage",
"index":13
}
]
}
POST https://api.bibox.com/v1/ctrade
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
pair | true | string | 合约符号 | 4BTC_USDT,4ETH_USDT, ... | |
margin | true | integer | 增减保证金 | 增加margin>=0.5;减少margin<=-0.5 |
POST请求方法:order/changeMargin
返回结果说明
{
"result":[
{
"result":"success",
"cmd":"order/changeMargin"
}
]
}
示例
// Request
{
"cmd":"order/changeMargin",
"body":{
"pair": "4ETH_USDT",
"margin": 4
},
"index":13
}
// Response
{
"result":[
{
"result":"success",
"cmd":"order/changeMargin",
"index":13
}
]
}
POST https://api.bibox.com/v1/ctrade
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
amount | true | integer | 金额 |
POST请求方法:transfer/in
返回结果说明
{
"result":[
{
"result":"success",
"cmd":"transfer/in"
}
]
}
示例
// Request
{
"cmd":"transfer/in",
"body":{
"amount":"100"
}
}
// Response
{
"result":[
{
"result":"success",
"cmd":"transfer/in"
}
]
}
GET https://api.bibox.com/v1/cquery?cmd=deals&&pair=4ETH_USDT&&size=10
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
pair | true | String | 合约符号 | 4BTC_USDT,4ETH_USDT,... | |
size | true | integer | 返回数量 | 1,2,... |
返回结果说明
{
"result":{
"result":[
{
"pair":"4ETH_USDT",
"order_side":1,
"contract":75,
"price":"182.7500",
"createdAt":1565861520000
},
...
],
"cmd":"deals"
}
}
示例 https://api.bibox.com/v1/cquery?cmd=deals&&pair=4ETH_USDT&&size=10
{
"result":{
"result":[
{
"pair":"4ETH_USDT", // 合约符号
"order_side":1, // 1看涨 2 看空
"contract":75, // 张数
"price":"182.7500", // 价格
"createdAt":1565861520000 // 时间
},
...
],
"cmd":"deals"
}
}
POST https://api.bibox.com/v1/cquery
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
ids | true | integer array | 订单号 | 最大长度限制50单 |
POST请求方法:query/orderPendingByIDs
返回结果说明
{
"result":[
{
"result":[
{
"id":491168, // 订单号
"coin_symbol":"USDT",
"pair":"4ETH_USDT", // 合约符号
"order_side":1, // 挂单方向:1开多,2开空
"order_type":2,
"contract":3, // 委托合约张数
"order_from":1,
"status":1, // 0,1未成交 2部分成交 3完全成交 4部分取消 5完全取消 6,7 系统取消
"price":"136.0000", // 委托价格
"price_deal":"0.0000", // 成交均价
"deal_count":0,
"contract_deal":0, // 已成交合约张数
"createdAt":"2019-02-20T02:01:46.000Z",
"updatedAt":"2019-02-20T02:01:46.000Z"
},
...
],
"cmd":"query/orderPendingByIDs",
"index":13
}
]
}
示例
// Request
{
"cmd":"query/orderPendingByIDs",
"body":{
"ids":[
491168,
2
]
},
"index":13
}
// Response
{
"result":[
{
"result":[
{
"id":491168,
"coin_symbol":"USDT",
"pair":"4ETH_USDT",
"order_side":1,
"order_type":2,
"contract":3,
"order_from":1,
"status":1,
"price":"136.0000",
"price_deal":"0.0000",
"deal_count":0,
"contract_deal":0,
"createdAt":"2019-02-20T02:01:46.000Z",
"updatedAt":"2019-02-20T02:01:46.000Z"
},
{
"id":2,
"coin_symbol":"USDT",
"pair":"4BTC_USDT",
"order_side":1,
"order_type":2,
"contract":1,
"order_from":1,
"status":3,
"price":"3622.0000",
"price_deal":"3622.0000",
"deal_count":1,
"contract_deal":1,
"createdAt":"2019-02-15T13:10:27.000Z",
"updatedAt":"2019-02-15T13:10:45.000Z"
}
],
"cmd":"query/orderPendingByIDs",
"index":13
}
]
}
POST https://api.bibox.com/v1/cquery
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
pair | true | String | 合约符号 | 4BTC_USDT,4ETH_USDT,... | |
page | true | integer | 第几页 | 1,2,... | |
size | true | integer | 多少条 | 1,2,... | |
begin_time | false | integer | 开始时间 | ||
end_time | false | integer | 结束时间 | ||
type | false | integer | 成交类型 | 1开仓, 2平仓, 3爆仓, 4减仓 |
POST请求方法:query/orderList
返回结果说明
{
"result":[
{
"result":{
"count":101,
"page":1,
"items":[
{
"id":236343,
"coin_symbol":"USDT",
"pair":"4BTC_USDT", // 合约符号
"type":2, // 1开仓, 2平仓, 3爆仓, 4减仓
"order_side":2, // 1开多,2开空
"price_open":"3999.0000", // 委托价格
"price":"3964.5800", // 开仓均价
"price_deal":"3999.0000", // 成交价格
"contract":2, // 合约张数
"profit":"0.6884", // 盈亏
"fee":"0.0000", // 手续费
"createdAt":"2019-02-23T17:07:31.000Z"
},
...
]
},
"cmd":"query/orderList"
}
]
}
示例
// Request
{
"cmd":"query/orderList",
"body":{
"pair":"4BTC_USDT",
"page":1,
"size":100,
"begin_time":1550971541000,
"end_time":1550977541000,
type: 2,
}
}
// Response
{
"result":[
{
"result":{
"count":101,
"page":1,
"items":[
{
"id":236343,
"coin_symbol":"USDT",
"pair":"4BTC_USDT",
"type":2,
"order_side":2,
"price_open":"3999.0000",
"price":"3964.5800",
"price_deal":"3999.0000",
"contract":2,
"profit":"0.6884",
"fee":"0.0000",
"createdAt":"2019-02-23T17:07:31.000Z"
},
...
]
},
"cmd":"query/orderList"
}
]
}
POST https://api.bibox.com/v1/cquery
请求参数
参数名称 | 是否必须 | 类型 | 描述 | 默认值 | 取值范围 |
---|---|---|---|---|---|
id | true | String | 订单号 |
POST请求方法:query/orderDetailByID
返回结果说明
{
"result":[
{
"result":{
"items":[
{
"id":42, // 成交记录ID
"coin_symbol":"USDT", //计价单位
"pair":"4BTC_USDT", // 合约符号
"order_side":1, // 1 买,看涨; 2 卖,看空;
"contract":1, // 合约张数
"order_from":1, // 1网页,2安卓,3ios, 6 apikey,
"createdAt":"2019-08-13T08:22:25.000Z", // 创建时间
"updatedAt":"2019-08-13T08:22:26.000Z",
"price":"7029.9700", // 价格
"price_deal":"0.0000", // 成交价
"fee":"0.0000", // 手续费
"is_cancel":1, // 0 正常单; 1: 已撤销
"is_maker":1, // 0: taker; 1: maker;
"order_type":2 // 1 市价单; 2 限价单
}
],
"count":9,
"page":1
},
"cmd":"query/orderDetailByID"
}
]
}
示例
// Request
{
"cmd":"query/orderDetailByID",
"body":{
"id":"58", // 订单号
}
}
// Response
{
"result":[
{
"result":{
"items":[
{
"id":42, // 成交记录ID
"coin_symbol":"USDT", //计价单位
"pair":"4BTC_USDT", // 合约符号
"order_side":1, // 1 买,看涨; 2 卖,看空;
"contract":1, // 合约张数
"order_from":1, // 1网页,2安卓,3ios, 6 apikey,
"createdAt":"2019-08-13T08:22:25.000Z", // 创建时间
"updatedAt":"2019-08-13T08:22:26.000Z",
"price":"7029.9700", // 价格
"price_deal":"0.0000", // 成交价
"fee":"0.0000", // 手续费
"is_cancel":1, // 0 正常单; 1: 已撤销
"is_maker":1, // 0: taker; 1: maker;
"order_type":2 // 1 市价单; 2 限价单
}
],
"count":9,
"page":1
},
"cmd":"query/orderDetailByID"
}
]
}
GET https://api.bibox.com/v1/cquery?cmd=contractValue
请求参数: 无
返回结果说明
{
"result":{
"result":[
{
"pair":"4BTC_USDT",
"value":"0.0100000000",
"coin_symbol":"BTC"
},
],
"cmd":"contractValue"
}
}
示例 https://api.bibox.com/v1/cquery?cmd=contractValue
// Response
{
"result":[
{
"result":[
{
"pair":"4BTC_USDT", //合约符号
"value":"0.0100000000", //合约面值
"coin_symbol":"BTC"
},
...
],
"cmd":"query/contractValue",
"index":13
}
]
}
GET https://api.bibox.com/v1/cquery?cmd=contractConfig
请求参数: 无
返回结果说明
{
"result":{
"result":{
"cross_leverage":25,
"leverage_max":50,
"margin_rate_force":"0.01",
"night_fee_rate":"0.0006",
"hold_limit":{
"BTC":5000,
"ETH":150000,
"EOS":50000,
"LTC":35000,
"BCH":100000
}
},
"cmd":"contractConfig"
}
}
示例 https://api.bibox.com/v1/cquery?cmd=contractConfig
// Response
{
"result":{
"result":{
"cross_leverage":25, // 全仓默认杠杆数
"leverage_max":50, // 最大杠杆数
"margin_rate_force":"0.01", // 爆仓率
"night_fee_rate":"0.0006", // 隔夜费
"hold_limit":{ // 最大持仓数量
"BTC":5000,
"ETH":150000,
"EOS":50000,
"LTC":35000,
"BCH":100000
}
},
"cmd":"contractConfig"
}
}
GET https://api.bibox.com/v1/cquery?cmd=openLimit
请求参数: 无
返回结果说明
{
"result":{
"result":{
"BTC":5000,
"ETH":75000,
"EOS":75000,
"LTC":15000,
"BCH":15000
},
"cmd":"openLimit"
}
}
示例 https://api.bibox.com/v1/cquery?cmd=openLimit
// Response
{
"result":{
"result":{
"BTC":5000,
"ETH":75000,
"EOS":75000,
"LTC":15000,
"BCH":15000
},
"cmd":"openLimit"
}
}
Bibox交易所提供REST API 和 WebSocket API,便于投资者查看行情、快速交易。