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/account/max-open-available

限频规则: 5次/秒/UID

获取最大可开可用

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

获取最大可开可用 › Request Parameters

category
​string · required

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

symbol
​string · required

交易对名称 例如:BTCUSDT

orderType
​string · required

订单类型 limit: 限价单 market: 市价单

side
​string · required

交易方向 buy 买 sell 卖

price
​string

下单价格 订单类型为限价单limit时,该字段必填

size
​string

下单数量 基础币

autoBorrow
​string

自动借币开关
yes 开启
no 关闭(默认)
仅用于现货下单。开启后,若得到币不支持借贷、消耗币支持借贷,则在消耗币可用余额不足时,系统将自动借入消耗币,补足委托所需金额。

获取最大可开可用 › Response Parameters

200

Successful response

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

可用 现货/杠杆 side=buy 时代表计价币数量 side=sell时代表基础币数量 合约代表计价币数量

maxOpen
​string

最大可开
side=buy 时代表计价币数量 side=sell时代表基础币数量
杠杆有值;现货在开启自动借币(autoBorrow)时也有值

buyOpenCost
​string

买入时以输入的size计算开仓所需的计价币数量 只有合约有值

sellOpenCost
​string

卖出时以输入的size计算开仓所需的计价币数量 只有合约有值

maxBuyOpen
​string

买入最大可开 以账户余额计算的基础币数量 只有合约有值

maxSellOpen
​string

卖出最大可开 以账户余额计算的基础币数量 只有合约有值

maxBuyAvailable
​string

最大可买

maxSellAvailable
​string

最大可卖

POST/api/v3/account/max-open-available
curl https://api.bitget.com/api/v3/account/max-open-available \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "category": "category", "symbol": "symbol", "orderType": "orderType", "side": "side", "price": "price", "size": "size", "autoBorrow": "autoBorrow" }'
Example Request Body
{ "category": "category", "symbol": "symbol", "orderType": "orderType", "side": "side", "price": "price", "size": "size", "autoBorrow": "autoBorrow" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1741851607871, "data": { "available": "52.008255", "maxOpen": "", "buyOpenCost": "", "sellOpenCost": "", "maxBuyOpen": "", "maxSellOpen": "", "maxBuyAvailable": "", "maxSellAvailable": "" } }
json
application/json

一键平仓

POST
https://api.bitget.com
/api/v3/trade/close-positions

限频规则: 5次/秒/UID

支持把当前仓位按产品类型或者持仓方向以市价进行平仓,可能会有滑点

API Broker返佣标识:

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

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

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

一键平仓 › Request Parameters

category
​string · required

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

symbol
​string

交易对名称 例如:BTCUSDT 如果不填此参数,会平掉对应的产品类型下的所有仓位

posSide
​string

持仓方向 long 多仓 short 空仓 如填此参数 则只会平对应方向下仓位

一键平仓 › Response Parameters

200

Successful response

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

列表

>orderId
​string

订单ID

>clientOid
​string

自定义订单ID

>msg
​string

失败原因

>code
​string

错误码

POST/api/v3/trade/close-positions
curl https://api.bitget.com/api/v3/trade/close-positions \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "category": "category", "symbol": "symbol", "posSide": "posSide" }'
Example Request Body
{ "category": "category", "symbol": "symbol", "posSide": "posSide" }
json
Example Responses
{ "code": "00000", "data": { "list": [ { "orderId": "111111111111111111", "clientOid": "111111111111111111", "code": "24056", "msg": "notExisted" } ] }, "msg": "success", "requestTime": 1627293504612 }
json
application/json

仓位转移

POST
https://api.bitget.com
/api/v3/account/move-positions

限频规则: 1次/秒/UID

支持母子账户互转及子账户间移仓:

  1. 母账户向子账户移仓
  2. 子账户向母账户移仓
  3. 子账户向子账户移仓(需隶属于相同母账户)

该功能仅对白名单用户开放,仅能通过母账户的API Key调用,必须是同一母账户体系,当前仅支持USDT和USDC合约,仅支持全仓模式。 移仓生成的交易不会出现在公有行情的成交中,不产生手续费。 整点前后5分钟不支持移仓,源账户mmr>=80%不支持移仓。移仓前会撤销源账户和目标账户对应合约的订单,移仓价格默认且仅支持标记价格。 用户每日最多可触发100次移仓请求,调用成功算1次,每次移仓请求需间隔30秒,每个移仓请求最多支持10个仓位。 移仓之后的持仓模式和杠杆倍数以目标账户原先的设置为准。

  • 限频规则: 1次/秒/UID
  • 业务限制: 100次/天/UID,请求间隔最少30秒
  • 需要统一账户交易读写权限

仓位转移 › Request Parameters

fromUid
​string · required

移仓发起账户UID 转出仓位的账户 fromUid及toUid需隶属于同一母子账户体系

toUid
​string · required

移仓目标账户UID 接收仓位的账户 fromUid及toUid需隶属于同一母子账户体系

category
​string · required

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

positionList
​string[] · required

仓位列表 单次请求最多10个仓位

>symbol
​string · required

交易对名称 例如:BTCUSDT

>side
​string · required

下单方向 buy/sell 单向模式/双向模式处理逻辑一致 持有多仓时,需传入side=sell进行减仓 持有空仓时,需传入side=buy进行减仓

>qty
​string · required

转移数量 需满足最小数量精度要求

仓位转移 › Response Parameters

200

Successful response

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

发起账户仓位列表

>orderId
​string

目标订单ID

>clientOid
​string

目标订单自定义ID

>code
​string

错误码 开仓产生错误时返回

>msg
​string

错误信息 开仓产生错误时返回

openPosition
​string[]

目标账户仓位结果列表

POST/api/v3/account/move-positions
curl https://api.bitget.com/api/v3/account/move-positions \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "fromUid": "fromUid", "toUid": "toUid", "category": "category", "positionList": [ "string" ], ">symbol": ">symbol", ">side": ">side", ">qty": ">qty" }'
Example Request Body
{ "fromUid": "fromUid", "toUid": "toUid", "category": "category", "positionList": [ "string" ], ">symbol": ">symbol", ">side": ">side", ">qty": ">qty" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1695806875837, "data": { "closePosition": [ { "orderId": "121211212122", "clientOid": "131311313133", "code": "", "msg": "" } ], "openPosition": [ { "orderId": "121211212123", "clientOid": "131311313134", "code": "", "msg": "" } ] } }
json
application/json

获取移仓历史

GET
https://api.bitget.com
/api/v3/account/move-position-history

限频规则: 5次/秒/UID

查询移仓历史记录。仅支持母账户调用。

查询时间范围

如不传endTime,默认查询最近30天数据。最大支持的时间跨度为90天。

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

获取移仓历史 › Request Parameters

category
​string · required

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

symbol
​string

交易对名称 例如:BTCUSDT

startTime
​string

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

endTime
​string

结束时间戳 Unix时间戳的毫秒数格式,如 1597026383185 如不传,默认查询最近30天数据 最大支持的时间跨度为90天

cursor
​string

游标ID 用于分页。首次不传,后续传上次响应结果

limit
​string

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

获取移仓历史 › Response Parameters

200

Successful response

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

移仓历史列表

>category
​string

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

>fromUid
​string

发起账户UID

>toUid
​string

目标账户UID

>orderId
​string

订单ID

>openExecId
​string

开仓成交ID

>closeExecId
​string

平仓成交ID

>symbol
​string

交易对名称 例如:BTCUSDT

>posSide
​string

仓位方向 long 多仓 short 空仓

>qty
​string

转移数量

>price
​string

转移价格

>status
​string

转移状态 processing 处理中 completed 已完成 failed 失败

>createdTime
​string

订单创建时间 Unix毫秒时间戳

>updatedTime
​string

订单更新时间 Unix毫秒时间戳

cursor
​string

分页游标

GET/api/v3/account/move-position-history
curl 'https://api.bitget.com/api/v3/account/move-position-history?category=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1730186348272, "data": { "list": [ { "category": "USDT-FUTURES", "fromUid": "111111111", "toUid": "222222222", "orderId": "121211212122", "openExecId": "343434343434", "closeExecId": "343434343435", "symbol": "BTCUSDT", "posSide": "long", "qty": "0.5", "price": "61000", "status": "completed", "createdTime": "1730181468493", "updatedTime": "1730181468593" } ], "cursor": "1233319323918499840" } }
json
application/json

获取当前仓位

GET
https://api.bitget.com
/api/v3/position/current-position

限频规则: 20次/秒/UID

以交易对、仓位方向,或者产品类型维度获取实时仓位信息

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

获取当前仓位 › Request Parameters

category
​string · required

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

symbol
​string

交易币对 例如:BTCUSDT 如果不传symbol,那么将返回对应产品类型的所有仓位

posSide
​string

仓位方向 long: 多仓 short: 空仓 如果传入此参数,那么仅返回对应仓位方向的仓位信息

获取当前仓位 › Response Parameters

200

Successful response

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

列表

>category
​string

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

>symbol
​string

币对名称

>marginCoin
​string

保证金币种

>posSide
​string

持仓方向 持仓方向 long: 多仓 short:空仓

>positionBalance
​string

仓位保证金数量 (保证金币种) 逐仓模式下反映该仓位的逐仓保证金数量

>available
​string

仓位可用(基础币)

>frozen
​string

仓位冻结(基础币) 平仓单占用

>total
​string

仓位总数量(available + frozen)

>leverage
​string

杠杆倍数

>curRealisedPnl
​string

已实现盈亏 不包含手续费和资金费率

>avgPrice
​string

平均开仓价

>marginMode
​string

保证金模式 crossed 全仓 isolated 逐仓

>positionStatus
​string

仓位执行状态 normal 正常

>holdMode
​string

持仓模式 one_way_mode 单向持仓 hedge_mode 双向持仓

>unrealisedPnl
​string

未实现盈亏 逐仓模式下反映该逐仓仓位的未实现盈亏

>liquidationPrice
​string

预估强平价 小于等于0,代表永不爆仓

>mmr
​string

维持保证金率

>profitRate
​string

收益率

>markPrice
​string

标记价格

>breakEvenPrice
​string

仓位盈亏平衡价

>totalFunding
​string

资金总费用,仓位存续期间,资金费用的累加值,初始值为空,表示还没收取过资金费

>openFeeTotal
​string

开仓已扣除手续费 仓位存续期间扣除的开仓交易手续费

>closeFeeTotal
​string

平仓已扣手续费 仓位存续期间扣除的平仓交易手续费

>cashDividend
​string

现金派息 单位为USDT

>createdTime
​string

仓位创建时间 时间戳 毫秒

>updatedTime
​string

最近更新时间 时间戳 毫秒

GET/api/v3/position/current-position
curl 'https://api.bitget.com/api/v3/position/current-position?category=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1753103840140, "data": { "list": [ { "category": "USDT-FUTURES", "symbol": "BTCUSDT", "marginCoin": "USDT", "holdMode": "hedge_mode", "posSide": "long", "marginMode": "crossed", "positionBalance": "4701531.84941582", "available": "119.2068", "frozen": "0", "total": "119.2068", "leverage": "3", "curRealisedPnl": "0", "avgPrice": "108674", "positionStatus": "normal", "unrealisedPnl": "1124573.04243999", "liquidationPrice": "43099.9", "mmr": "0.015", "profitRate": "0.2391929010498401", "markPrice": "118097", "breakEvenPrice": "109208.6", "totalFunding": "-53076.32433032", "openFeeTotal": "-2842.86603479", "closeFeeTotal": "0", "cashDividend": "0", "createdTime": "1736378720620", "updatedTime": "1753102803148" } ] } }
json
application/json

获取历史仓位

GET
https://api.bitget.com
/api/v3/position/history-position

限频规则: 20次/秒/UID

查询历史90天内持仓列表

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

获取历史仓位 › Request Parameters

category
​string · required

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

symbol
​string

交易对 如:BTCUSDT

startTime
​string

开始时间戳 Unix时间戳的毫秒数格式,如 1597026383085 最大查询范围90天天

endTime
​string

结束时间戳 Unix时间戳的毫秒数格式,如 1597026383085 startTime和endTime间隔不超过30天

limit
​string

每页查询条数 最大100,默认100

cursor
​string

分页游标 用于翻页,首次查询不传,查询第二页及后面的数据时,取上一次查询返回cursor

获取历史仓位 › Response Parameters

200

Successful response

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

列表

>positionId
​string

仓位id

>category
​string

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

>symbol
​string

币对名称 BTCUSDT

>marginCoin
​string

保证金币种

>posSide
​string

仓位方向 long/short

>openPriceAvg
​string

开仓平均价

>closePriceAvg
​string

平仓平均价

>openTotalPos
​string

累计开仓数量

>closeTotalPos
​string

累计平仓数量

>marginMode
​string

保证金模式 crossed 全仓 isolated 逐仓

>holdMode
​string

持仓模式 one_way_mode 单向持仓 hedge_mode 双向持仓

>cumRealisedPnl
​string

已实现盈亏(不包含手续费和资金费用)

>netProfit
​string

净盈亏 (包含扣除手续费和资金费用)

>totalFunding
​string

资金总费用 仓位存续期间,资金费用的累加值,初始值为空,表示还没收取过资金费

>openFeeTotal
​string

开仓已扣除手续费 仓位存续期间扣除的开仓交易手续费

>closeFeeTotal
​string

平仓已扣手续费 仓位存续期间扣除的平仓交易手续费

>cashDividend
​string

现金派息 单位为USDT

>createdTime
​string

仓位创建时间 时间戳 毫秒

>updatedTime
​string

仓位更新时间 时间戳 毫秒

cursor
​string

分页游标

GET/api/v3/position/history-position
curl 'https://api.bitget.com/api/v3/position/history-position?category=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1730186957802, "data": { "list": [ { "positionId": "1111111111111111111", "category": "USDT-FUTURES", "symbol": "EOSUSDT", "marginCoin": "USDT", "holdMode": "one_way_mode", "posSide": "long", "marginMode": "crossed", "openPriceAvg": "1960.001", "closePriceAvg": "1959.999", "openTotalPos": "58", "closeTotalPos": "58", "cumRealisedPnl": "-0.116", "netProfit": "-45.588", "totalFunding": "0", "openFeeTotal": "-22.7360116", "closeFeeTotal": "-22.7359884", "cashDividend": "0", "createdTime": "1729928018076", "updatedTime": "1729929656321" } ], "cursor": "1111111111111111111" } }
json
application/json

获取仓位ADL排名

GET
https://api.bitget.com
/api/v3/position/adlRank

限频规则: 1次/秒/UID

获取合约仓位ADL排名

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

获取仓位ADL排名 › Response Parameters

200

Successful response

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

交易对名称

marginCoin
​string

保证金币种

adlRank
​string

ADL排序 当前仓位在自动减仓序列中的排序。当市场发生自动减仓事件时,值越接近1,您的持仓被减少的概率越大

holdSide
​string

持仓方向 long 多仓 short空仓

GET/api/v3/position/adlRank
curl https://api.bitget.com/api/v3/position/adlRank
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1754035547922, "data": [ { "symbol": "MOVEUSDT", "marginCoin": "USDT", "adlRank": "0.4872", "holdSide": "long" } ] }
json
application/json

获取借币数据

GET
https://api.bitget.com
/api/v3/trade/loan-data

限频规则: 10次/秒/UID

查询统一账户当前的借币数据,包含借币总额、下次扣息时间及各币种负债明细。

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

获取借币数据 › Response Parameters

200

Successful response

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

当前借币总额 单位为USD

interestPaymentTime
​string

下次扣息时间 Unix毫秒时间戳

​object[]

负债币种列表

GET/api/v3/trade/loan-data
curl https://api.bitget.com/api/v3/trade/loan-data
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1751972326323, "data": { "currentLoans": "1000.5", "interestPaymentTime": "1751976000000", "debtCoinList": [ { "coin": "USDT", "debt": "1000.5", "interestFreeAmount": "200", "interestRateNextHour": "0.0001" } ] } }
json
application/json

订单管理策略交易