Bitget APIBitget API
统一账户经典账户
旧文档
  • 概览
  • API 文档
  • WebSocket
  • Agent Hub
  • SDK
  • 更新日志
Copied to clipboard
交易
    订单管理
      下单post修改订单post撤单post倒计时全部撤单post批量下单post批量修改订单post批量撤单post一键撤单post获取订单信息get获取当前委托get获取历史委托get获取成交明细get创建Reality股票订单post撤销Reality股票订单post
    仓位管理
      获取最大可开可用post一键平仓post仓位转移post获取移仓历史get获取当前仓位get获取历史仓位get获取仓位ADL排名get获取借币数据get
    策略交易
      创建策略单post修改策略单post撤销策略单post获取当前策略单get获取历史策略单get获取历史策略子订单get
    网格交易
      追加投资额post查询网格交易机器人详情get终止网格交易机器人post创建网格交易机器人post创建中性网格交易机器人post查询网格交易机器人挂单详情get修改网格交易机器人参数post修改网格区间和网格数post修改中性网格交易机器人参数post修改中性网格区间和网格数post查询中性网格交易机器人详情get查询中性网格机器人挂单详情get验证中性网格参数post验证网格输入post
交易
交易

策略交易

策略交易


创建策略单

POST
https://api.bitget.com
/api/v3/trade/place-strategy-order

限频规则: 10次/秒/UID

创建策略单

API Broker返佣标识:

需在HTTP Header请求头中添加如下代码块

"X-CHANNEL-API-CODE":"your-channel-api-code"

  • 限频规则: 10次/秒/UID
  • 需要统一账户交易读写权限

创建策略单 › Request Parameters

category
​string · required

产品类型 SPOT 现货 MARGIN 杠杆 USDT-FUTURES USDT合约 COIN-FUTURES 币本位合约 USDC-FUTURES USDC合约

symbol
​string · required

交易对名称 例如:BTCUSDT

type
​string

策略类型 tpsl止盈止损 trigger计划委托 ocoOCO委托 trailing_stop跟踪止损 iceberg冰山委托 twapTWAP委托 默认为tpsl止盈止损

side
​string

交易方向 buy买 sell卖 双向持仓: 开多:side=buy & posSide=long 开空:side=sell & posSide=short 平多:side=sell & posSide=long 平空:side=buy & posSide=short 单向持仓: 开多 side=buy 开空 side=sell 平多 side=sell & reduceOnly=yes 平空 side=buy & reduceOnly=yes

posSide
​string

持仓方向 long 多 short 空

qty
​string

委托数量

clientOid
​string

自定义策略订单id, 幂等有效期六小时 (不完全保证) ^[\.A-Z\:/a-z0-9_-]{1,32}$ 仅在 type=tpsl 时生效,其他策略类型不支持

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object
type = object
type = object · requires: ocoParams
type = object · requires: trailingStopParams
type = object · requires: icebergParams
type = object · requires: twapParams
Properties for tpsl:
止盈止损(`type=tpsl`) 为已有仓位设置止盈和/或止损保护,当市场价格(或标记价格)达到设置的触发价格时,系统自动为您提交限价单或市价单以平仓。
tpslMode
​string

止盈止损模式 full全部仓位止盈止损 partial部分仓位止盈止损 如不填写,默认值为full全部止盈止损

qty
​string

委托数量 tpslMode=partial时必填,单位为base coin

reduceOnly
​string

是否只减仓 yes是 no否

tpTriggerBy
​string

止盈触发类型 market市场价格 mark标记价格 如不填写,默认值为market市场价格

slTriggerBy
​string

止损触发类型 market市场价格 mark标记价格 如不填写,默认值为market市场价格

takeProfit
​string

止盈触发价格

stopLoss
​string

止损触发价格

tpOrderType
​string

止盈触发的策略单类型 limit 限价单 market 市价单 如不填写,默认值为market

slOrderType
​string

止损触发的策略单类型 limit 限价单 market 市价单 如不填写,默认值为market

tpLimitPrice
​string

止盈策略单执行价格 仅限价单tpOrderType=limit时有效,市价单忽略该参数

slLimitPrice
​string

止损策略单执行价格 仅限价单slOrderType=limit时有效,市价单忽略该参数

创建策略单 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

策略订单id

clientOid
​string

自定义策略订单id

POST/api/v3/trade/place-strategy-order
curl https://api.bitget.com/api/v3/trade/place-strategy-order \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "category": "category", "symbol": "symbol", "type": "type", "side": "side", "posSide": "posSide", "qty": "qty", "clientOid": "clientOid" }'
Example Request Body
{ "category": "category", "symbol": "symbol", "type": "type", "side": "side", "posSide": "posSide", "qty": "qty", "clientOid": "clientOid" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1695806875837, "data": { "clientOid": "121211212122", "orderId": "121211212122" } }
json
application/json

修改策略单

POST
https://api.bitget.com
/api/v3/trade/modify-strategy-order

限频规则: 10次/秒/UID

修改策略单

  • 限频规则: 10次/秒/UID
  • 需要统一账户交易读写权限

修改策略单 › Request Parameters

orderId
​string · required

策略订单id orderId和clientOid二者必填其一 如同时传入orderId及clientOid,则orderId先级更高,忽略clientOid入参

qty
​string · required

委托数量 部分止盈止损模式下可修改,单位为base coin

clientOid
​string

自定义策略订单id orderId和clientOid二者必填其一 如同时传入orderId及clientOid,则orderId先级更高,忽略clientOid入参

tpTriggerBy
​string

止盈触发类型 market市场价格 mark标记价格

slTriggerBy
​string

止损触发类型 market市场价格 mark标记价格

takeProfit
​string

止盈触发价格

stopLoss
​string

止损触发价格

tpOrderType
​string

止盈触发的策略单类型 limit 限价单 market 市价单

slOrderType
​string

止损触发的策略单类型 limit 限价单 market 市价单

tpLimitPrice
​string

止盈策略单执行价格 仅限价单tpOrderType=limit时可修改

slLimitPrice
​string

止损策略单执行价格 仅限价单slOrderType=limit时可修改

triggerBy
​string

计划委托触发价格类型 market市场价格 mark标记价格

triggerPrice
​string

计划委托触发价格 仅限价单triggerOrderType=limit时可修改

triggerOrderType
​string

计划委托订单类型 limit限价单 market市价单

triggerOrderPrice
​string

计划委托执行价格 仅限价单triggerOrderType=limit时可修改

修改策略单 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

策略订单id

clientOid
​string

自定义策略订单id

POST/api/v3/trade/modify-strategy-order
curl https://api.bitget.com/api/v3/trade/modify-strategy-order \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "orderId": "orderId", "clientOid": "clientOid", "qty": "qty", "tpTriggerBy": "tpTriggerBy", "slTriggerBy": "slTriggerBy", "takeProfit": "takeProfit", "stopLoss": "stopLoss", "tpOrderType": "tpOrderType", "slOrderType": "slOrderType", "tpLimitPrice": "tpLimitPrice", "slLimitPrice": "slLimitPrice", "triggerBy": "triggerBy", "triggerPrice": "triggerPrice", "triggerOrderType": "triggerOrderType", "triggerOrderPrice": "triggerOrderPrice" }'
Example Request Body
{ "orderId": "orderId", "clientOid": "clientOid", "qty": "qty", "tpTriggerBy": "tpTriggerBy", "slTriggerBy": "slTriggerBy", "takeProfit": "takeProfit", "stopLoss": "stopLoss", "tpOrderType": "tpOrderType", "slOrderType": "slOrderType", "tpLimitPrice": "tpLimitPrice", "slLimitPrice": "slLimitPrice", "triggerBy": "triggerBy", "triggerPrice": "triggerPrice", "triggerOrderType": "triggerOrderType", "triggerOrderPrice": "triggerOrderPrice" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1695806875837, "data": { "clientOid": "121211212122", "orderId": "121211212122" } }
json
application/json

撤销策略单

POST
https://api.bitget.com
/api/v3/trade/cancel-strategy-order

限频规则: 10次/秒/UID

撤销策略单 对于iceberg/twap委托,撤销母订单会同时撤销其所有未成交子订单;对于oco委托,撤销其中一笔委托会同时撤销另一笔委托。

  • 限频规则: 10次/秒/UID
  • 需要统一账户交易读写权限

撤销策略单 › Request Parameters

orderId
​string · required

策略订单id orderId和clientOid二者必填其一 如同时传入orderId及clientOid,则orderId先级更高,忽略clientOid入参

clientOid
​string

自定义策略订单id orderId和clientOid二者必填其一 如同时传入orderId及clientOid,则orderId先级更高,忽略clientOid入参

撤销策略单 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
code
​string

状态码

msg
​string

状态消息

requestTime
​string

时间戳

POST/api/v3/trade/cancel-strategy-order
curl https://api.bitget.com/api/v3/trade/cancel-strategy-order \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "orderId": "orderId", "clientOid": "clientOid" }'
Example Request Body
{ "orderId": "orderId", "clientOid": "clientOid" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1695806875837, "data": null }
json
application/json

获取当前策略单

GET
https://api.bitget.com
/api/v3/trade/unfilled-strategy-orders

限频规则: 20次/秒/UID

获取当前策略单

  • 限频规则: 20次/秒/UID
  • 需要统一账户交易只读/读写权限

获取当前策略单 › Request Parameters

category
​string · required

产品类型 spot 现货 margin 杠杆 usdt-futures U本位合约 coin-futures 币本位合约 usdc-futures USDC合约

type
​string

策略类型 tpsl止盈止损 trigger计划委托 oco OCO trailing_stop追踪委托 iceberg冰山委托 twap分时委托

获取当前策略单 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object[]

订单列表

orderId
​string

策略订单id

clientOid
​string

自定义策略订单id

category
​string

产品类型 USDT-FUTURES U本位合约 COIN-FUTURES 币本位合约 USDC-FUTURES USDC合约

symbol
​string

交易对名称 例如:BTCUSDT

qty
​string

委托数量

posSide
​string

交易方向 long 多仓 short 空仓

status
​string

策略订单状态 pending 等待执行 success 已执行 failed 执行失败 cancelled 已撤销 submitting 下单中

tpTriggerBy
​string

止盈触发类型 market市场价格 mark标记价格

slTriggerBy
​string

止损触发类型 market市场价格 mark标记价格

takeProfit
​string

止盈触发价格

stopLoss
​string

止损触发价格

tpOrderType
​string

止盈触发的策略单类型 limit 限价单 market 市价单

slOrderType
​string

止损触发的策略单类型 limit 限价单 market 市价单

tpLimitPrice
​string

止盈策略单执行价格

slLimitPrice
​string

止损策略单执行价格

triggerBy
​string

计划委托触发价格类型 market市场价格 mark标记价格

triggerPrice
​string

计划委托触发价格

triggerOrderType
​string

计划委托订单类型 limit限价单 market市价单

triggerOrderPrice
​string

计划委托执行价格

​object

OCO参数列表 当type=oco时返回

​object

追踪止盈止损参数列表 当type=trailing_stop时返回

​object

冰山委托参数列表 当type=iceberg时返回

​object

分时委托参数列表 当type=twap时返回

createdTime
​string

订单创建时间 Unix毫秒时间戳,例如1690196141868

updatedTime
​string

订单更新时间 Unix毫秒时间戳,例如1690196141868

GET/api/v3/trade/unfilled-strategy-orders
curl 'https://api.bitget.com/api/v3/trade/unfilled-strategy-orders?category=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1730186730084, "data": [ { "orderId": "111111111111111111", "clientOid": "111111111111111111", "category": "USDT-FUTURES", "symbol": "BTCUSDT", "qty": "0.01", "posSide": "long", "status": "pending", "tpTriggerBy": "market", "slTriggerBy": "market", "takeProfit": "110000", "stopLoss": "90000", "tpOrderType": "market", "slOrderType": "market", "tpLimitPrice": "91000", "slLimitPrice": "111000", "triggerBy": "market", "triggerPrice": "100000", "triggerOrderType": "limit", "triggerOrderPrice": "100500", "createdTime": "1730186725663", "updatedTime": "1730186725691" } ] }
json
application/json

获取历史策略单

GET
https://api.bitget.com
/api/v3/trade/history-strategy-orders

限频规则: 20次/秒/UID

查询历史策略单

  • 限频规则: 20次/秒/UID
  • 需要统一账户交易只读/读写权限

获取历史策略单 › Request Parameters

category
​string · required

产品类型 spot 现货 margin 杠杆 usdt-futures U本位合约 coin-futures 币本位合约 usdc-futures USDC合约

type
​string

策略类型 tpsl止盈止损 trigger计划委托 oco OCO trailing_stop追踪委托 iceberg冰山委托 twap分时委托

startTime
​string

开始时间戳 Unix时间戳的毫秒数格式,如 1597026383085

  • 默认查询时间为近30天
  • 开始和结束的最大时间间隔为90天
endTime
​string

结束时间戳 Unix时间戳的毫秒数格式,如 1597026383085

  • 默认查询时间为近30天
  • 开始和结束的最大时间间隔为90天
limit
​string

每页条目数 最大100,默认100

cursor
​string

分页游标 用于翻页,首次查询不传,查询第二页及后面的数据时,取上一次查询返回的最小orderId,结果会返回小于该值的数据

获取历史策略单 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

订单列表

cursor
​string

下一页游标 把该值作为下次请求的cursor参数,可获取下一页数据

GET/api/v3/trade/history-strategy-orders
curl 'https://api.bitget.com/api/v3/trade/history-strategy-orders?category=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1730186730084, "data": { "list": [ { "orderId": "111111111111111111", "clientOid": "111111111111111111", "category": "USDT-FUTURES", "symbol": "BTCUSDT", "qty": "0.01", "posSide": "long", "status": "success", "tpTriggerBy": "market", "slTriggerBy": "market", "takeProfit": "110000", "stopLoss": "90000", "tpOrderType": "market", "slOrderType": "market", "tpLimitPrice": "91000", "slLimitPrice": "111000", "triggerBy": "market", "triggerPrice": "100000", "triggerOrderType": "limit", "triggerOrderPrice": "100500", "createdTime": "1730186725663", "updatedTime": "1730186725691" } ], "cursor": "1233319323918499840" } }
json
application/json

获取历史策略子订单

GET
https://api.bitget.com
/api/v3/trade/strategy-sub-orders

查询策略生成的终态历史子订单

  • 限频规则: 10次/秒/UID
  • 需要统一账户交易只读/读写权限

获取历史策略子订单 › Request Parameters

orderId
​string · required

策略订单ID

limit
​string

每页条目数 最大100,默认100

cursor
​string

分页游标 用于翻页,首次查询不传,查询第二页及后面的数据时,取上一次查询返回的最小orderId,结果会返回小于该值的数据

获取历史策略子订单 › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

子订单列表

cursor
​integer

下一页游标 把该值作为下次请求的cursor参数,可获取下一页数据

GET/api/v3/trade/strategy-sub-orders
curl 'https://api.bitget.com/api/v3/trade/strategy-sub-orders?orderId=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1724486400000, "data": { "list": [ { "subOrderId": "1234567890123456789", "subClientOid": "myOrder001", "category": "USDT-FUTURES", "symbol": "BTCUSDT", "price": "60000", "qty": "0.01", "cumExecQty": "0.01", "avgPrice": "60001", "side": "buy", "posSide": "long", "status": "filled", "createdTime": "1724486400000", "updatedTime": "1724486401000" } ], "cursor": 1234567890123456800 } }
json
application/json

仓位管理网格交易