跳到主要内容

Orders

合约订单

获取订单详情

通过订单 ID 获取订单信息。

URL
https://big.one/api/contract/v2/orders/{id}
HTTP 请求方法

GET

请求参数
参数是否必填类型说明
idstring订单 ID
请求示例 URL
https://big.one/api/contract/v2/orders/5aec8f9f-1609-4e54-0005-86e30e0cb1c6
响应示例
{
"liquidateUserId": null,
"side": "BUY", // 买入方向
"meta": { // 元数据
"bestPrice": null, // 最佳价格
"markPrice": 10051.43, // 标记价格
"bestPrices": { // 最佳买卖价
"ask": null, // 卖出价格
"bid": null // 买入价格
} //
}, //
"userId": "5aec525e-335d-4724-0005-20153b361f89", // 用户 ID
"filledNotional": 0, // 已成交金额
"ts": 1562063567960, // 时间戳
"notional": 0.102512, // 订单金额
"status": "NEW", // 订单状态
"isLiquidate": false, // 是否为强平
"reduceOnly": false, // 是否仅减仓
"type": "LIMIT", // 订单类型
"symbol": "BTCUSD", // 合约类型
"seqNo": null, // 序列号
"filled": 0, // 成交量
"conditional": null, // 条件订单
"id": "5aec8f9f-1609-4e54-0005-86e30e0cb1c6", // 订单 ID
"size": 1000, // 合约数量
"avgPrice": 0, // 平均成交价格
"price": 9755 // 订单价格
}

下单

下单操作。

URL
https://big.one/api/contract/v2/orders
HTTP 请求方法

POST

请求参数
参数是否必填类型说明
sizenumber合约数量
symbolstring合约类型,包括 BTCUSDBTCUSDTETHUSDTEOSUSDT
typestring订单类型,包括 LIMITMARKETIOCFOKPOST_ONLY
sidestringBUYSELL
pricenumber订单价格
reduceOnlyboolean是否为减仓订单,仅可减少持仓,无法增加持仓。如果该订单会增加持仓,将被修改为减仓或取消
conditionalobject条件订单,目前只有一个选项 REACH,价格类型包括 MARK_PRICEINDEX_PRICEMARKET_PRICE
请求示例 URL
https://big.one/api/contract/v2/orders
请求体示例
{
"size": 1,
"symbol": "BTCUSD",
"type": "LIMIT",
"side": "BUY",
"price": 8000,
"reduceOnly": false,
"conditional": {
"type": "REACH",
"price": 8000,
"priceType": "MARKET_PRICE"
}
}
响应示例
{
"meta": null,
"reduceOnly": false,
"symbol": "BTCUSD",
"type": "LIMIT",
"userId": "5aec525e-335d-4724-0005-20153b361f89",
"liquidateUserId": null,
"size": 1,
"notional": 0,
"status": "UNTRIGGERED",
"id": "5aed7b45-5d19-40f2-0005-ca49d01f33e3",
"side": "BUY",
"filledNotional": 0,
"seqNo": null,
"filled": 0,
"price": 8000,
"conditional": {
"type": "REACH",
"priceType": "MARKET_PRICE",
"price": 8000
}
}

取消订单

通过订单 ID 取消订单。

URL
https://big.one/api/contract/v2/orders/{id}
HTTP 请求方法

DELETE

请求参数
参数是否必填类型说明
idstring订单 ID
请求示例 URL
https://big.one/api/contract/v2/orders/5aec8f9f-1609-4e54-0005-86e30e0cb1c6

无响应内容

批量下单

URL
https://big.one/api/contract/v2/orders/batch
HTTP 请求方法

POST

请求参数
参数是否必填类型说明
symbolstring合约类型,包括 BTCUSDBTCUSDTETHUSDTEOSUSDT
orderslist订单信息列表
请求示例 URL
https://big.one/api/contract/v2/orders/batch
请求体示例
{
"symbol": "BTCUSD",
"orders": [ // 订单列表
{
"price": 11234, // 合约价格
"size": 200, // 合约数量
"side": "BUY" // 买入或卖出
}
]
}
响应示例
[
{
"liquidateUserId": null,
"price": 11234,
"size": 200,
"id": "5aedb78e-6641-4d00-0005-2b2439f84663",
"userId": "5aec525e-335d-4724-0005-20153b361f89",
"filledNotional": 0,
"ts": 1562141145497, // 时间戳
"status": "NEW",
"isLiquidate": false,
"reduceOnly": false,
"type": "LIMIT",
"symbol": "BTCUSD",
"seqNo": null,
"filled": 0,
"conditional": null,
"side": "BUY",
"avgPrice": 0,
"meta": {
"markPrice": 11303.14,
"bestPrices": {
"ask": 11311,
"bid": 11305.5
},
"bestPrice": 11305.5
},
"notional": 0.017804
}
]

批量取消订单

URL
https://big.one/api/contract/v2/orders/batch
HTTP 请求方法

DELETE

请求参数
参数是否必填类型说明
symbolstring合约类型,包括 BTCUSDBTCUSDTETHUSDTEOSUSDT
idslist订单 ID 列表
请求示例 URL
https://big.one/api/contract/v2/orders/batch
请求体示例
{
"symbol": "BTCUSD",
"ids": [
"5aedb78e-6641-4d00-0005-2b2439f84663",
"5aed7b45-5d19-40f2-0005-ca49d01f33e3"
]
}

无响应内容

获取订单列表

URL
https://big.one/api/contract/v2/orders
HTTP 请求方法

GET

请求参数
参数是否必填类型说明
symbolstring合约类型,包括 BTCUSDBTCUSDTETHUSDTEOSUSDT
idstring上一响应的订单 ID,用于分页。
start-timeinteger查询开始时间
end-timeinteger查询结束时间。如果提供了 id,则该参数会被覆盖。
typestring订单类型,包括 LIMITMARKETIOCFOKPOST_ONLYADL
sidestringBUYSELL
statusstring订单状态,包含 NEWPARTIALLY_FILLEDPARTIALLY_CANCELEDCANCELEDREJECTEDFILLEDUNTRIGGEREDPENDING_CANCELTRIGGERED,多个状态用逗号分隔
optstringTRIGGEREDLIQUIDATE
limitnumber响应大小限制。

如果未指定任何参数,则返回所有订单。

请求 URL 示例
https://big.one/api/contract/v2/orders?symbol=BTCUSD&type=LIMIT&side=BUY&status=NEW,PARTIALLY_CANCELED&limit=30&start-time=2020-03-06T15:59:59Z
响应示例
[
{
"liquidateUserId": null,
"id": "5aed94fc-703e-42a2-0005-578d4c468767",
"ts": 1562132083136, // 时间戳
"side": "BUY",
"userId": "5aec525e-335d-4724-0005-20153b361f89",
"filledNotional": 0,
"notional": 0.102512,
"status": "NEW",
"isLiquidate": false,
"reduceOnly": false,
"type": "LIMIT",
"symbol": "BTCUSD",
"seqNo": null,
"filled": 0,
"conditional": null,
"size": 1000,
"avgPrice": 0,
"price": 9755,
"meta": {
"bestPrice": 11311,
"markPrice": 11536.1075491,
"bestPrices": {
"ask": 11311,
"bid": 11305.5
}
}
}
]

获取当前激活订单列表

URL
https://big.one/api/contract/v2/orders/opening
HTTP 请求方法

GET

请求参数
参数是否必填类型说明
symbolstring合约类型,包括 BTCUSDBTCUSDTETHUSDTEOSUSDT
idstring上一响应的订单 ID,用于分页。
start-timeinteger查询开始时间
end-timeinteger查询结束时间。如果提供了 id,则该参数会被覆盖。
limitnumber每次请求的响应限制
请求 URL 示例
https://big.one/api/contract/v2/orders/opening?symbol=BTCUSD&limit=30&start-time=2020-03-06T15:59:59Z
响应示例
[
{
"liquidateUserId": null,
"ts": 1562125342068, // 时间戳
"size": 1,
"notional": 0,
"side": "BUY",
"userId": "5aec525e-335d-4724-0005-20153b361f89",
"filledNotional": 0,
"isLiquidate": false,
"reduceOnly": false,
"type": "LIMIT",
"symbol": "BTCUSD",
"seqNo": null,
"filled": 0,
"meta": null,
"status": "UNTRIGGERED",
"avgPrice": 0,
"price": 8000,
"conditional": {
"type": "REACH",
"price": 8000,
"priceType": "MARKET_PRICE"
},
"id": "5aed7b45-5d19-40f2-0005-ca49d01f33e3"
}
]

订单计数

URL
https://big.one/api/contract/v2/orders/count
HTTP 请求方法

GET

请求参数
参数是否必填类型说明
symbolstring合约类型,包括 BTCUSDBTCUSDTETHUSDTEOSUSDT
idstring上一响应的订单 ID,用于分页。
start-timeinteger查询开始时间
end-timeinteger查询结束时间。如果提供了 id,则该参数会被覆盖。
typestringLIMITMARKETIOCFOKPOST_ONLYADL 等订单类型
sidestringBUYSELL
statusstring订单状态,包含 NEWPARTIALLY_FILLEDPARTIALLY_CANCELEDCANCELEDREJECTEDFILLEDUNTRIGGEREDPENDING_CANCELTRIGGERED,多个状态用逗号分隔
optstringTRIGGEREDLIQUIDATE
请求 URL 示例
https://big.one/api/contract/v2/orders/count?symbol=BTCUSD&type=LIMIT&side=BUY&status=NEW,PARTIALLY_CANCELED&start-time=2020-03-06T15:59:59Z
响应示例
{
"count": 1
}

获取当前激活订单计数

URL
https://big.one/api/contract/v2/orders/opening/count
HTTP 请求方法

GET

请求参数
参数是否必填类型说明
symbolstring合约类型,包括 BTCUSDBTCUSDTETHUSDTEOSUSDT
start-timeinteger查询开始时间
end-timeinteger查询结束时间
请求 URL 示例
https://big.one/api/contract/v2/orders/opening/count?symbol=BTCUSD&start-time=2020-03-06T15:59:59Z
响应示例
{
"count": 2
}