更新日志
- 更新子母账户接口:
- 新增响应参数
isManagedSubAccount
和isAssetManagementSubAccount
于接口GET /sapi/v1/sub-account/list
以支持查询子账户是否是托管子账户或资产管理子账户
- 新增响应参数
**2022-2-17**
以下更新于2月 24, 2022 08:00 AM UTC生效
- 更新钱包接口:
GET /sapi/v1/accountSnapshot
接口查询范围缩短为仅支持查询最近一个月数据,即startTime不支持选定最近1个月之外的时间。
**2022-2-09**
- 新增钱包接口:
POST /sapi/v1/asset/dust-btc
以获取可以转换成BNB的小额资产
**2022-1-25**
- 自1月 28, 2022 4:00 AM UTC起,您需要使用开通
允许现货和杠杆交易
权限的API Key调用以下接口:POST /sapi/v1/asset/dust
小额资产转换POST /sapi/v1/lending/daily/purchase
申购币安宝活期产品POST /sapi/v1/lending/daily/redeem
赎回币安宝活期产品POST /sapi/v1/lending/customizedFixed/purchase
申购币安宝定期/活动产品POST /sapi/v1/lending/positionChanged
币安宝定期/活动持仓转活期持仓POST /sapi/v1/bswap/liquidityAdd
币安挖矿添加流动性POST /sapi/v1/bswap/liquidityRemove
币安挖矿移除流动性POST /sapi/v1/bswap/swap
币安挖矿交易POST /sapi/v1/bswap/claimRewards
币安挖矿领取奖励
**2022-1-21**
- 新增币安码接口:
POST /sapi/v1/giftcard/createCode
以支持创建币安码POST /sapi/v1/giftcard/redeemCode
以支持兑现币安码GET /sapi/v1/giftcard/verify
以支持验证币安码
**2022-1-4**
新增矿池接口:
GET /sapi/v1/mining/payment/uid
以获取矿池账户收益列表
新增币安挖矿接口:
GET /sapi/v1/bswap/unclaimedRewards
以查询未领取的奖励数量POST /sapi/v1/bswap/claimRewards
以领取奖励GET /sapi/v1/bswap/claimedHistory
以获取已领取奖励记录
**2021-12-30**
更新杠杆接口:
- 获取杠杆利率历史接口
GET /sapi/v1/margin/interestRateHistory
移除参数limit
,查询时间间隔更改为最大1个月
- 获取杠杆利率历史接口
更新钱包接口:
- 由于矿池钱包合并于资金账户钱包,用户万向划转接口
POST /sapi/v1/asset/transfer
的以下划转类型 MAIN_MINING, MINING_MAIN, MINING_UMFUTURE, MARGIN_MINING,和 MINING_MARGIN将于 1月 05, 2022 08:00 AM UTC 停止使用
- 由于矿池钱包合并于资金账户钱包,用户万向划转接口
**2021-12-29**
- 移除交易对类型枚举
- 新增权限枚举
**2021-12-24**
- 更新子母账户接口:
- 新增传参
clientTranId
于子母账户万能划转接口POST /sapi/v1/sub-account/universalTransfer
和查询子母账户万能划转历史接口GET /sapi/v1/sub-account/universalTransfer
以支持用户自定义划转id
- 新增传参
**2021-12-03**
新增杠杆接口:
- 新增接口
GET /sapi/v1/margin/crossMarginData
以获取全仓杠杆利率及限额 - 新增接口
GET /sapi/v1/margin/isolatedMarginData
以获取逐仓杠杆利率及限额 - 新增接口
GET /sapi/v1/margin/isolatedMarginTier
以获取逐仓档位信息
- 新增接口
新增NFT接口:
- 新增接口
GET /sapi/v1/nft/history/transactions
以支持用户查询NFT资金流水历史记录 - 新增接口
GET /sapi/v1/nft/history/deposit
以支持用户查询NFT充值历史记录 - 新增接口
GET /sapi/v1/nft/history/withdraw
以支持用户查询NFT提现历史记录 - 新增接口
GET /sapi/v1/nft/user/getAsset
以支持用户查询NFT资产
- 新增接口
**2021-11-30**
新增闪兑接口:
- 新增接口
GET /sapi/v1/convert/tradeFlow
以支持用户查询闪兑交易历史记录
- 新增接口
更新返佣接口:
- 新增接口
GET /sapi/v1/rebate/taxQuery
以支持用户查询现货返佣历史记录
- 新增接口
**2021-11-19**
新增Pay接口:
- 新增接口
GET /sapi/v1/pay/transactions
以支持用户查询Pay交易历史记录
- 新增接口
更新钱包接口:
- 新增响应参数
info
于接口GET /sapi/v1/capital/withdraw/history
以显示提币失败原因
- 新增响应参数
**2021-11-18**
以下更新于11月 25, 2021 08:00 AM UTC生效
- 更新钱包接口:
GET /sapi/v1/accountSnapshot
接口查询范围缩短为仅支持查询最近半年内的数据,即startTime不支持选定最近6个月之外的时间。若您没有传入startTime和endTime,则默认返回最近7天的数据
**2021-11-17**
- 以下接口将于11月 17, 2021 13:00 PM UTC停止使用:
POST /sapi/v1/account/apiRestrictions/ipRestriction
以支持用户为API Key开启或关闭IP白名单POST /sapi/v1/account/apiRestrictions/ipRestriction/ipList
以支持用户为API Key添加IP白名单地址列表GET /sapi/v1/account/apiRestrictions/ipRestriction
以支持用户为API Key查询IP白名单DELETE /sapi/v1/account/apiRestrictions/ipRestriction/ipList
以支持用户为API Key删除IP白名单地址列表
**2021-11-16**
- 新增子母账户接口:
POST /sapi/v1/sub-account/subAccountApi/ipRestriction
以支持母账户为子账户API Key开启或关闭IP白名单POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList
以支持母账户为子账户API Key添加IP白名单地址列表GET /sapi/v1/sub-account/subAccountApi/ipRestriction
以支持母账户为子账户API Key查询IP白名单DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList
以支持母账户为子账户API Key删除IP白名单地址列表
**2021-11-09**
- 新增钱包接口:
POST /sapi/v1/account/apiRestrictions/ipRestriction
以支持用户为API Key开启或关闭IP白名单POST /sapi/v1/account/apiRestrictions/ipRestriction/ipList
以支持用户为API Key添加IP白名单地址列表GET /sapi/v1/account/apiRestrictions/ipRestriction
以支持用户为API Key查询IP白名单DELETE /sapi/v1/account/apiRestrictions/ipRestriction/ipList
以支持用户为API Key删除IP白名单地址列表
**2021-11-08**
- 新增质押借币接口:
- 新增查询质押借币资金流水接口
GET /sapi/v1/loan/income
以支持用户查询质押借币资金流水历史
- 新增查询质押借币资金流水接口
**2021-11-05**
- 更新钱包接口:
- 新增参数
walletType
于提币接口POST /sapi/v1/capital/withdraw/apply
以支持用户选择从现货钱包
或资金钱包
进行提币
- 新增参数
**2021-11-04**
以下更新于11月 11, 2021 08:00 AM UTC生效
- 更新接口:
GET /sapi/v1/asset/transfer
GET /sapi/v1/futures/transfer
接口查询范围缩短为仅支持查询最近半年内的数据,即startTime不支持选定最近6个月之外的时间。若您没有传入startTime和endTime,则默认返回最近7天的数据
**2021-11-01**
- 新增接口
GET /api/v3/rateLimit/order
- 回传用户在当前时间区间内的下单总数
- 此接口的权重为 20
**2021-10-22**
- 钱包接口更新:
- 新增划转类型
MAIN_FUNDING
,FUNDING_MAIN
,FUNDING_UMFUTURE
,UMFUTURE_FUNDING
,MARGIN_FUNDING
,FUNDING_MARGIN
,FUNDING_CMFUTURE
andCMFUTURE_FUNDING
于用户万向划转接口POST /sapi/v1/asset/transfer
和GET /sapi/v1/asset/transfer
以支持资金账户和现货账户,杠杆全仓账户,U本位合约账户,币本位合约账户之间相互划转 - 由于C2C账户,币安支付、币安卡等业务合并至资金账户,用户万向划转接口
POST /sapi/v1/asset/transfer
和GET /sapi/v1/asset/transfer
的以下划转类型MAIN_C2C
,C2C_MAIN
,C2C_UMFUTURE
,C2C_MINING
,UMFUTURE_C2C
,MINING_C2C
,MARGIN_C2C
,C2C_MARGIN
,MAIN_PAY
和PAY_MAIN
将于11月 04, 2021 08:00 AM UTC 停止使用
- 新增划转类型
**2021-10-14**
- 以下杠杆账户接口更新返回数据的时间范围,
startTime
与endTime
时间跨度不能超过30天,如果不传时间参数默认返回最近7天数据,如果archived
参数为true
,则默认返回6个月以前的最后7天数据:GET /sapi/v1/margin/transfer
GET /sapi/v1/margin/loan
GET /sapi/v1/margin/repay
GET /sapi/v1/margin/isolated/transfer
GET /sapi/v1/margin/interestHistory
**2021-09-18**
- 新增币安挖矿接口:
- 新增接口
GET /sapi/v1/bswap/poolConfigure
以支持查询币对池的配置信息 - 新增接口
GET /sapi/v1/bswap/addLiquidityPreview
以支持查询添加流动性的试算 - 新增接口
GET /sapi/v1/bswap/removeLiquidityPreview
以查询移除流动性的试算
- 新增接口
**2021-09-17**
- 访问限制介绍中新增
/api/*
和/sapi/*
相关接口限频说明
**2021-09-08**
新增以下杠杆账户接口支持杠杆逐仓账户启用限制:
- 新增接口
DELETE /sapi/v1/margin/isolated/account
以支持杠杆逐仓账户停用 - 新增接口
POST /sapi/v1/margin/isolated/account
以支持杠杆逐仓账户启用 - 新增接口
GET /sapi/v1/margin/isolated/accountLimit
以查询杠杆逐仓账户上限
- 新增接口
查询杠杆逐仓账户信息接口
GET /sapi/v1/margin/isolated/account
响应加入字段 "enabled" 判断账户是否启用
**2021-09-03**
- 更新钱包接口:
sameAddress
表示需要输入memo的币种depositDust
表示最小可上帐金额specialWithdrawTips
表示提现时的特殊说明
**2021-08-27**
- 更新钱包接口:
- 新增参数
withdrawOrderId
于GET /sapi/v1/capital/withdraw/history
以支持查询指定withdrawOrderId
的提币历史记录 - 新增响应内容
unlockConfirm
于GET /sapi/v1/capital/deposit/hisrec
以支持查询解锁需要的网络确认次数
- 新增参数
**2021-08-23**
- 新增杠杆账户 OCO 接口:
POST /sapi/v1/margin/order/oco
DELETE /sapi/v1/margin/orderList
GET /sapi/v1/margin/orderList
GET /sapi/v1/margin/allOrderList
GET /sapi/v1/margin/openOrderList
用法与现货账户 OCO 相同
**2021-08-20**
- 更新钱包接口:
- 新增参数
fromSymbol
,toSymbol
和新增划转类型ISOLATEDMARGIN_MARGIN
,MARGIN_ISOLATEDMARGIN
,ISOLATEDMARGIN_ISOLATEDMARGIN
于接口POST /sapi/v1/asset/transfer
和GET /sapi/v1/asset/transfer
以支持杠杆逐仓钱包与杠杆全仓钱包之前相互划转
- 新增参数
**2021-08-12**
- GET
api/v3/myTrades
添加新的参数orderId
**2021-08-05**
- 新增C2C接口:
GET /sapi/v1/c2c/orderMatch/listUserOrderHistory
以查询用户C2C交易历史记录
**2021-08-05**
- 币安宝接口更新:
GET /sapi/v1/lending/union/purchaseRecord
GET /sapi/v1/lending/union/redemptionRecord
GET /sapi/v1/lending/union/interestHistory
以上接口查询范围更改为:仅支持startTime
和endTime
查询最大间隔为30天,若startTime
和 endTime
均未发送,则默认返回最近30天记录
**2021-07-29**
- 子母账户接口更新:
GET /sapi/v1/sub-account/transfer/subUserHistory
如果startTime
和endTime
均未发送,默认只返回最近30天数据
**2021-07-27**
- 新增法币接口:
GET /sapi/v1/fiat/orders
以查询用户法币充值和提币历史记录GET /sapi/v1/fiat/payments
以查询用户法币支付(买卖)历史记录
**2021-07-16**
- 新增钱包接口:
GET /sapi/v1/account/apiRestrictions
以查询用户API Key权限
**2021-07-09**
- 新增钱包接口:
POST /sapi/v1/asset/get-funding-asset
以查询资金账户资产,目前支持查询的业务为:Binance Pay, Binance Card, Binance Gift Card, Stock Token
**2021-06-24**
- 钱包接口更新:
GET /sapi/v1/capital/withdraw/history
现有的limit
参数增加默认值1000,最大值1000的限制GET /sapi/v1/capital/deposit/hisrec
现有的limit
参数增加默认值1000,最大值1000的限制
**2021-06-17**
- 币安宝接口更新:
GET /sapi/v1/lending/daily/product/list
增加新参数current
和size
**2021-06-15**
- 新增子母账户接口:
POST /sapi/v1/managed-subaccount/deposit
以支持投资人账户为托管子账户充值资产(仅投资人账户方使用)GET /sapi/v1/managed-subaccount/asset
以支持投资人账户查询托管子账户资产(仅投资人账户方使用)POST /sapi/v1/managed-subaccount/withdraw
以支持投资人账户为托管子账户提币资产(仅投资人账户方使用)
**2021-06-04**
从 八月 01, 2021 02:00 AM UTC 开始,以下WAPI接口将停止使用:
GET /wapi/v3/systemStatus.html
POST /wapi/v3/withdraw.html
GET /wapi/v3/depositHistory.html
GET /wapi/v3/withdrawHistory.html
GET /wapi/v3/depositAddress.html
GET /wapi/v3/accountStatus.html
GET /wapi/v3/apiTradingStatus.html
GET /wapi/v3/userAssetDribbletLog.html
GET /wapi/v3/assetDetail.html
GET /wapi/v3/tradeFee.html
GET /wapi/v3/sub-account/list.html
GET /wapi/v3/sub-account/transfer/history.html
POST /wapi/v3/sub-account/transfer.html
GET /wapi/v3/sub-account/assets.html
目前WAPI已从API文档中移除,为了保证您的所有交易策略顺利执行,强烈建议所有API用户尽快更新交易程序,替换成现有的SAPI接口
**2021-05-26**
- 更新钱包接口:
- 用户万向划转接口
POST /sapi/v1/asset/transfer
和GET /sapi/v1/asset/transfer
新增划转类型MAIN_PAY
,PAY_MAIN
以支持现货和支付账户之间相互划转
- 用户万向划转接口
**2021-05-12**
- 在文档中添加接口的数据来源说明
- 在每个接口中添加相应的数据源
- GET
api/v3/exchangeInfo
现在支持单或多交易对查询
**2021-04-28**
从 May 15, 2021 08:00 UTC 开始, 以下创建逐仓杠杆账户接口将关闭:
POST /sapi/v1/margin/isolated/create
后续,用户可通过逐仓杠杆账户划转 POST /sapi/v1/margin/isolated/transfer
直接完成逐仓杠杆账户的创建与交易准备,无需调用接口创建账户
**2021-04-26**
从 April 28, 2021 00:00 UTC 开始,下面接口的权重有如下变动:
GET /api/v3/order
权重改为 2GET /api/v3/openOrders
权重改为 3GET /api/v3/allOrders
权重改为 10GET /api/v3/orderList
权重改为 2GET /api/v3/openOrderList
权重改为 3GET /api/v3/account
权重改为 10GET /api/v3/myTrades
权重改为 10GET /api/v3/exchangeInfo
权重改为 10
**2021-04-08**
- 子母账户接口更新:
GET /sapi/v1/sub-account/futures/accountSummary
和GET /sapi/v2/sub-account/futures/accountSummary
接口返回字段asset
更新为以USD计价的资产汇总,即子账户USDT,BUSD等保证金总和
**2021-04-02**
- 新增钱包接口:
GET /sapi/v1/system/status
以获取系统状态GET /sapi/v1/account/status
以获取账户状态GET /sapi/v1/account/apiTradingStatus
以获取账户API交易状态GET /sapi/v1/asset/dribblet
以获取小额资产转换BNB历史GET /sapi/v1/asset/assetDetail
以获取上架资产详情GET /sapi/v1/asset/tradeFee
以获取交易手续费率查询
- 新增子母账户接口:
GET /sapi/v3/sub-account/assets
以查询子账户资产
**2021-04-01**
- 子母账户接口更新:
GET /sapi/v1/sub-account/transfer/subUserHistory
新增返回字段fromAccountType
和toAccountType
为用户转出账户类型和转入账户类型
**2021-03-31**
- 子母账户接口更新:
GET /wapi/v3/sub-account/transfer/history.html
新增参数fromEmail
和toEmail
,原有参数email
将默认查询fromEmail
的记录
**2021-03-08**
- 新增子母账户接口:
POST /sapi/v1/sub-account/virtualSubAccount
以支持母账户创建虚拟子账户GET /sapi/v1/sub-account/list
以支持查询子账户列表POST /sapi/v1/sub-account/blvt/enable
以支持为子账户开通杠杆代币
**2021-03-05**
- 新增杠杆接口:
GET /sapi/v1/margin/interestRateHistory
以支持杠杆利率历史查询
**2021-02-08**
- 新增合约接口:
GET /sapi/v2/futures/loan/wallet
混合保证金钱包 V2 接口,以支持 BUSD 借款查询GET /sapi/v2/futures/loan/configs
混合保证金信息 V2 接口,以支持 BUSD 借款查询GET /sapi/v2/futures/loan/calcAdjustLevel
计算调整后的混合保证金质押率 V2 接口,以支持 BUSD 借款查询GET /sapi/v2/futures/loan/calcMaxAdjustAmount
可供调整混合保证金质押率的最大额 V2 接口,以支持 BUSD 借款质押率的调整POST /sapi/v2/futures/loan/adjustCollateral
调整混合保证金质押率 V2 接口,以支持 BUSD 借款质押率的调整
- 更新合约接口:
GET /sapi/v1/futures/loan/adjustCollateral/history
混合保证金调整质押率历史接口,加入参数与响应字段loanCoin
以支持 BUSD 借款查询GET /sapi/v1/futures/loan/liquidationHistory
混合保证金强平历史历史接口,加入参数与响应字段loanCoin
以支持 BUSD 借款查询
**2021-02-04**
- 更新钱包接口:
- 用户万向划转接口
POST /sapi/v1/asset/transfer
和GET /sapi/v1/asset/transfer
新增划转类型MARGIN_MINING
,MINING_MARGIN
,MARGIN_C2C
,C2C_MARGIN
,MARGIN_CMFUTURE
,CMFUTURE_MARGIN
以支持全仓杠杆,矿池,C2C,币本位合约账户间划转。
- 用户万向划转接口
**2021-01-15**
- 杠杆交易添加新接口
DELETE /sapi/v1/margin/openOrders
- 此接口便于用户撤销单一交易对的所有挂单, 包括OCO的挂单。
**2021-01-10**
矿池接口
GET /sapi/v1/mining/payment/list
新增可选参数pageSize
矿池接口
GET /sapi/v1/mining/payment/list
新增返回字段:- "type" 表示收益类型
- "hashTransfer" 表示已转让算力
- "transferAmount" 表示已转让收益
新增矿池接口:
GET /sapi/v1/mining/payment/other
GET /sapi/v1/mining/hash-transfer/config/details
GET /sapi/v1/mining/hash-transfer/config/details/list
GET /sapi/v1/mining/hash-transfer/profit/details
POST /sapi/v1/mining/hash-transfer/config
POST /sapi/v1/mining/hash-transfer/config/cancel
**2021-01-01**
USER DATA STREAM
- 移除
outboundAccountInfo
事件.
**2020-12-30**
- 新增钱包接口:
POST /sapi/v1/asset/transfer
用户万向划转接口,以支持现货,全仓杠杆,合约,C2C,矿池账户间划转。GET /sapi/v1/asset/transfer
以支持查询用户万向划转历史记录。
**2020-12-22**
- 新增子母账户接口:
GET /sapi/v1/sub-account/sub/transfer/history
以支持查询子母账户现货资金划转历史。
**2020-12-11**
- 更新合约混合保证金接口:
- 接口
GET /sapi/v1/futures/loan/wallet
新增返回参数interestFreeLimit
表示混合保证金总免息额度,interestFreeLimitUsed
表示占用混合保证金免息额度。 - 接口
GET /sapi/v1/futures/loan/interestHistory
新增返回参数interestFreeLimitUsed
表示占用混合保证金免息额度。
- 接口
**2020-12-04**
- 更新杠杆代币接口:
- 接口
GET /sapi/v1/blvt/tokenInfo
新增返回参数currentBaskets
(包括symbol
,amount
,notionalValue
),purchaseFeePct
申购费率,dailyPurchaseLimit
每日申购数量上限,redeemFeePct
赎回费率,dailyRedeemLimit
每日赎回数量上限。
- 接口
- 新增杠杆代币接口:
GET /sapi/v1/blvt/userLimit
以查询用户每日申购赎回限额。
**2020-12-02**
- 新增子母账户接口:
GET /sapi/v2/sub-account/futures/account
以支持查询子账户USDT合约和币本位合约账户详情。GET /sapi/v2/sub-account/futures/accountSummary
以支持查询子账户USDT合约和币本位合约账户汇总。GET /sapi/v2/sub-account/futures/positionRisk
以支持查询子账户USDT合约和币本位合约持仓信息。
**2020-12-01**
- 更新杠杆交易接口:
POST /sapi/v1/margin/order
加入参数quoteOrderQty
支持"报价总额市价单"。
**2020-11-27**
为了优化性能,除了当前的api.binance.com
,新加了一些API的集群。如果访问api.binance.com
有性能问题,也可以尝试访问:
**2020-11-16**
- 更新杠杆接口加入
archived
参数以支持查询6个月以前数据:GET /sapi/v1/margin/loan
GET /sapi/v1/margin/repay
GET /sapi/v1/margin/interestHistory
**2020-11-13**
- 新增子母账户接口:
POST /sapi/v1/sub-account/universalTransfer
以支持子母账户,现货和合约账户之间相互划转。GET /sapi/v1/sub-account/universalTransfer
以查询划转记录。
**2020-11-10**
- 新增BNB抵扣开关接口:
POST /sapi/v1/bnbBurn
BNB现货交易和杠杆利息抵扣开关。GET /sapi/v1/bnbBurn
获取BNB抵扣开关状态。
**2020-11-09**
- 新增返回字段
tranId
于子母账户接口:GET /sapi/v1/sub-account/futures/internalTransfer
GET /sapi/v1/sub-account/transfer/subUserHistory
**2020-11-03**
更新合约接口:
- 接口
GET /sapi/v1/futures/loan/repay/history
新增返回参数repayType
(NORMAL
为混合保证金普通还款,COLLATERAL
为抵押物还款),price
(抵押物还款兑换比率),repayCollateral
(还款所用抵押物数量)。 - 接口
GET /sapi/v1/futures/loan/wallet
新增返回参数totalInterest
(混合保证金总利息),principalForInterest
(混合保证金计息本金),interest
(混合保证金利息)。 - 接口
GET /sapi/v1/futures/loan/configs
新增返回参数interestRate
(混合保证金利率),interestGracePeriod
(混合保证金免息天数)。
- 接口
新增合约接口:
- 接口
GET /sapi/v1/futures/loan/collateralRepayLimit
以查询混合保证金抵押物还款上下限。 - 接口
GET /sapi/v1/futures/loan/collateralRepay
以获取混合保证金抵押物还款兑换比率。 - 接口
POST /sapi/v1/futures/loan/collateralRepay
混合保证金以抵押物还款。 - 接口
GET /sapi/v1/futures/loan/collateralRepayResult
以查询混合保证金以抵押物还款结果。 - 接口
GET /sapi/v1/futures/loan/interestHistory
以查询混合保证金利息收取历史。
- 接口
**2020-10-14**
- 合约接口更新:
POST /sapi/v1/futures/loan/borrow
与GET /sapi/v1/futures/loan/borrow/history
返回新字段borrowId
为用户混合保证金借款唯一 ID。POST /sapi/v1/futures/loan/repay
与GET /sapi/v1/futures/loan/repay/history
返回新字段repayId
为用户混合保证金还款唯一 ID。
**2020-10-10**
- 子母账户接口
POST /sapi/v1/sub-account/futures/transfer
新增划转类型type
以支持子账户现货账户和币本位合约账户间相互划转。
**2020-09-30**
- 杠杆账户接口更新:
GET /sapi/v1/margin/maxBorrowable
返回新字段borrowLimit
为用户账户借贷限额。
**2020-09-28**
- 新增币安宝接口:
POST /sapi/v1/lending/positionChanged
以支持定期/活动持仓转成活期持仓。
- 以下币安宝接口,lendingType里参数
ACTIVITY
替换REGULAR
以代表币安宝活动产品:GET /sapi/v1/lending/project/list
POST /sapi/v1/lending/customizedFixed/purchase
GET /sapi/v1/lending/project/position/list
GET /sapi/v1/lending/union/purchaseRecord
GET /sapi/v1/lending/union/interestHistory
**2020-09-23**
- 新增币安挖矿接口:
- 接口
GET /sapi/v1/bswap/pools
以从某个资金池移除流动性。 - 接口
GET /sapi/v1/bswap/liquidity
以获取流动资金池具体信息。 - 接口
POST /sapi/v1/bswap/liquidityAdd
以添加流动性。 - 接口
POST /sapi/v1/bswap/liquidityRemove
以移除流动性。 - 接口
GET /sapi/v1/bswap/liquidityOps
以获取流动性操作记录。 - 接口
GET /sapi/v1/bswap/quote
以获取报价。 - 接口
POST /sapi/v1/bswap/swap
以交易。 - 接口
GET /sapi/v1/bswap/swap
以获取交易记录。
- 接口
**2020-09-16**
新增杠杆代币接口:
- 接口
GET /sapi/v1/blvt/tokenInfo
以查询杠杆代币信息。 - 接口
POST /sapi/v1/blvt/subscribe
以申购代币。 - 接口
GET /sapi/v1/blvt/subscribe/record
以查询申购代币记录。 - 接口
POST /sapi/v1/blvt/redeem
以赎回代币。 - 接口
GET /sapi/v1/blvt/redeem/record
以查询赎回代币记录。
- 接口
以下杠杆代币功能请使用合约接口:
- 杠杆代币历史净值K线接口。
- WebSocket 杠杆代币信息更新和净值K线更新
**2020-09-09**
用户数据 STREAM
outboundAccountInfo
事件不再推荐使用。outboundAccountInfo
事件以后会被删除(具体时间未定) 请使用outboundAccountPosition
事件.outboundAccountInfo
只推送余额不为0,以及余额刚变成0的资产。
**2020-09-03**
- 新增子母账户接口
POST /sapi/v1/sub-account/futures/internalTransfer
以执行子账户合约资金直接划转。 - 新增子母账户接口
GET /sapi/v1/sub-account/futures/internalTransfer
以查询子账户合约资金直接划转历史。
**2020-09-01**
- 子母账户接口
GET /sapi/v1/sub-account/spotSummary
返回内容中新增字段masterAccountTotalAsset
以获取BTC计价的母账户资产。
**2020-08-27**
- 新增接口
GET /sapi/v1/sub-account/spotSummary
以获取BTC计价的子账户现货资产汇总。
**2020-08-26**
- 逐仓杠杆接口
GET /sapi/v1/margin/isolated/account
新增可选参数symbols
, 以支持查询至多5个指定symbol的杠杆逐仓资产。
**2020-07-28**
逐仓杠杆相关接口
以下接口新增可选参数"isIsolated", 并在返回内容中新增字段 "symbol":
POST /sapi/v1/margin/loan
POST /sapi/v1/margin/repay
以下接口新增可选参数"isIsolated", 并在返回内容中新增字段 "isIsolated":
POST /sapi/v1/margin/order
DELETE /sapi/v1/margin/order
GET /sapi/v1/margin/order
GET /sapi/v1/margin/openOrders
GET /sapi/v1/margin/allOrders
GET /sapi/v1/margin/myTrades
以下接口新增可选参数"isolatedSymbol", 并在返回内容中新增字段 "isolatedSymbol":
GET /sapi/v1/margin/loan
GET /sapi/v1/margin/repay
GET /sapi/v1/margin/interestHistory
接口
GET /sapi/v1/margin/forceLiquidationRec
新增可选参数"isolatedSymbol", 并在返回内容中新增字段 "isIsolated"以下接口新增可选参数"isolatedSymbol":
GET /sapi/v1/margin/maxBorrowable
GET /sapi/v1/margin/maxTransferable
新增以下逐仓杠杆功能接口:
POST /sapi/v1/margin/isolated/create
POST /sapi/v1/margin/isolated/transfer
GET /sapi/v1/margin/isolated/transfer
GET /sapi/v1/margin/isolated/account
GET /sapi/v1/margin/isolated/pair
GET /sapi/v1/margin/isolated/allPairs
新增以下接口,管理逐仓杠杆账户listenKey:
POST /sapi/v1/userDataStream/isolated
PUT /sapi/v1/userDataStream/isolated
DELETE /sapi/v1/userDataStream/isolated
**2020-07-20**
- 接口
GET /sapi/v1/margin/allOrders
参数"limit"的可传最大值更新为500.
**2020-07-17**
- 接口
GET /sapi/v1/margin/allOrders
增加访问限制为每个IP最多每分钟60次
**2020-07-13**
- 新增合约混合保证金相关的SAPI接口:
POST /sapi/v1/futures/loan/borrow
GET /sapi/v1/futures/loan/borrow/history
POST /sapi/v1/futures/loan/repay
GET /sapi/v1/futures/loan/repay/history
GET /sapi/v1/futures/loan/wallet
GET /sapi/v1/futures/loan/configs
GET /sapi/v1/futures/loan/calcAdjustLevel
GET /sapi/v1/futures/loan/calcMaxAdjustAmount
POST /sapi/v1/futures/loan/adjustCollateral
GET /sapi/v1/futures/loan/adjustCollateral/history
GET /sapi/v1/futures/loan/liquidationHistory
**2020-06-28**
- 服务于合约的相关SAPI接口内容转移至本文档:
POST /sapi/v1/futures/transfer
GET /sapi/v1/futures/transfer
**2020-05-06**
- 新增矿池接口:
GET /sapi/v1/mining/pub/algoList
GET /sapi/v1/mining/pub/coinList
GET /sapi/v1/mining/worker/detail
GET /sapi/v1/mining/worker/list
GET /sapi/v1/mining/payment/list
GET /sapi/v1/mining/statistics/user/status
GET /sapi/v1/mining/statistics/user/list
**2020-05-03**
- 杠杆交易部分接口的新的请求限制
- 涉及的接口:
POST /sapi/v1/margin/transfer
POST /sapi/v1/margin/loan
POST /sapi/v1/margin/repay
- 限制为每2秒一次。
- 超过限制的请求会收到HTTP Status Code
429
。
- 涉及的接口:
**2020-05-01**
- 从2020-05-01 UTC 00:00开始, 所有交易对都会有最多200个挂单的限制, 体现在过滤器MAX_NUM_ORDERS上.
- 已经存在的挂单不会被移除或者撤销。
- 单交易对(
symbol
)的挂单数量达到或超过200的账号, 无法在此交易对上下新的订单, 除非挂单数量低于200。 - OCO订单在被触发成
LIMIT
订单, 或者被触发成STOP_LOSS
(或者STOP_LOSS_LIMIT
)前, 被认为是2个挂单量. 一旦OCO订单被触发, 就只被算作一个挂单。
**2020-04-25**现货 API
- 添加新字段
permissions
- 这个字段定义了对于账户、交易对(
symbol
)的交易权限。 permissions
是个enum数组, 可能的值:SPOT
MARGIN
- 在未来的版本(v4)中,
permissions
将会在GET api/v3/exchangeInfo
中替换isSpotTradingAllowed
和isMarginTradingAllowed
。 - 如果账户想在一个交易对下做交易, 账户和交易对必须同时拥有对应的权限。
- 这个字段定义了对于账户、交易对(
- 接口
GET api/v3/exchangeInfo
的更新- 添加新字段
permissions
。 - 添加新字段
quoteAssetPrecision
。此字段和quotePrecision
重复。在未来的版本(v4)中quotePrecision
会被移除。
- 添加新字段
- 接口
GET api/v3/account
的更新- 添加新字段
permissions
。
- 添加新字段
- 添加新接口
DELETE api/v3/openOrders
- 此接口便于用户撤销单一交易对的所有挂单, 包括OCO的挂单。
- 如果交易对处于
BREAK
或者HALT
状态, 挂单也可以被撤销。
OutboundAccountInfo
消息会显示一个新字段P
, 用来显示账户的交易权限。
**2020-04-23**
WEB SOCKET 连接限制
- Websocket服务器每秒最多接受5个消息。消息包括:
- PING帧
- PONG帧
- JSON格式的消息, 比如订阅, 断开订阅.
- 如果用户发送的消息超过限制,连接会被断开连接。反复被断开连接的IP有可能被服务器屏蔽。
- 单个连接最多可以订阅 1024 个Streams。
**2020-04-16**
币安宝接口
GET /sapi/v1/lending/daily/token/position
返回内容新增字段:todayPurchasedAmount
表示用户今日申购的活期产品数量
新增以下币安宝接口用以支持灵活定期产品:
GET /sapi/v1/lending/project/list
POST /sapi/v1/lending/customizedFixed/purchase
GET /sapi/v1/lending/project/position/list
**2020-04-02**
- 接口
GET /sapi/v1/capital/config/getall
返回内容新增字段:minConfirm
表示资产上账所需的最小确认数unLockConfirm
表示资产解锁需所需确认数
**2020-03-24**
添加过滤器
MAX_POSITION
.这个过滤器定义账户允许的基于
base asset
的最大仓位。一个用户的仓位可以定义为如下资产的总和:base asset
的可用余额base asset
的锁定余额- 所有处于open的买单的数量总和
如果用户的仓位大于最大的允许仓位,买单会被拒绝。
**2020-03-13**
- 新增可选参数
transactionFeeFlag
于以下提币接口:POST /sapi/v1/capital/withdraw/apply
POST /wapi/v3/withdraw.html
**2020-02-05**
- 新增子账户相关接口:
POST /sapi/v1/sub-account/futures/transfer
: 对子账户实施futures账户划转POST /sapi/v1/sub-account/margin/transfer
: 对子账户实施margin账户划转POST /sapi/v1/sub-account/transfer/subToSub
: 向兄弟子账户划转POST /sapi/v1/sub-account/transfer/subToMaster
: 向母账户划转GET /sapi/v1/sub-account/transfer/subUserHistory
: 子账户获取自身划转历史
**2020-01-15**
接口
POST /wapi/v3/withdraw.html
新增参数withdrawOrderId
: 用户自定义提币id接口
GET /wapi/v3/withdrawHistory.html
返回内容新增字段withdrawOrderId
: 该笔提币的用户自定义id
**2019-12-25**
新增币安宝接口:
GET /sapi/v1/lending/daily/product/list
GET /sapi/v1/lending/daily/userLeftQuota
POST /sapi/v1/lending/daily/purchase
GET /sapi/v1/lending/daily/userRedemptionQuota
POST /sapi/v1/lending/daily/redeem
GET /sapi/v1/lending/daily/token/position
GET /sapi/v1/lending/union/account
GET /sapi/v1/lending/union/purchaseRecord
GET /sapi/v1/lending/union/redemptionRecord
GET /sapi/v1/lending/union/interestHistory
新增请求时间间隔于以下接口
GET /sapi/v1/capital/withdraw/history
,
GET /wapi/v3/withdrawHistory.html
,
GET /sapi/v1/capital/deposit/hisrec
and
GET /wapi/v3/depositHistory.html
:
- 新增接口用以获取账户每日资产快照:
GET /sapi/v1/accountSnapshot
**2019-11-30**
接口
POST /sapi/v1/margin/order (HMAC SHA256)
新增参数sideEffectType
,可选内容如下:NO_SIDE_EFFECT
: 普通交易订单;MARGIN_BUY
: 自动借款交易订单;AUTO_REPAY
: 自动还款交易订单.
New field
marginBuyBorrowAmount
andmarginBuyBorrowAsset
inFULL
response toPOST /sapi/v1/margin/order (HMAC SHA256)
**2019-11-28**
- 新增SAPI接口用以关闭账户站内划转功能:
POST /sapi/v1/account/disableFastWithdrawSwitch (HMAC SHA256)
- 新增SAPI接口用以开启账户站内划转功能:
POST /sapi/v1/account/enableFastWithdrawSwitch (HMAC SHA256)
**2019-11-22**
- "报价总额市价单"作为新的市价单方式已在各交易对投入使用。
- "报价总额市价单" 允许用户在市价单
MARKET
中设置总的购买投入金额或卖出预计回收金额quoteOrderQty
。 - "报价总额市价单"不会突破
LOT_SIZE
的限制规则; 报单会按给定的quoteOrderQty
尽可能接近地被执行。 - 以
BNBBTC
交易对为例:- On the
BUY
side, the order will buy as many BNB asquoteOrderQty
BTC can. - 买单: 给定
quoteOrderQty
的BTC会被用来市价买入尽可能多的BNB。 - On the
SELL
side, the order will sell as much BNB as needed to receivequoteOrderQty
BTC. - 卖单: 持有BNB会被尽可能多地以市价卖出以获取给定
quoteOrderQty
的BTC。
- On the
- "报价总额市价单" 允许用户在市价单
**2019-11-19**
GET /sapi/v1/sub-account/margin/account
返回内容新增:marginTradeCoeffVo
其中包括forceLiquidationBar
: 强平风险率;marginCallBar
: 补仓风险率;normalBar
: 初始风险率
**2019-11-13**Rest API
- "api/v3/exchangeInfo" 新增内容:
quoteOrderQtyMarketAllowed
baseCommissionPrecision
quoteCommissionPrecision
MARKET
orders (市价单)新增可选参数:quoteOrderQty
指定买入或卖出的报价数量,不可与quantity
(数量)同时使用.- 能够有效配合该参数使用
MARKET
orders(市价单)的确切时间和进一步详细信息将由后续声明予以通告。
- 能够有效配合该参数使用
- 所有订单查询接口增加新的返回内容:
origQuoteOrderQty
(e.g. GET api/v3/allOrders)
错误代码更新: -1128
- 发送
OCO
订单中有stopLimitPrice
但是没有stopLimitTimeInForce
,将会受到错误信息:
- 发送
错误代码更新: -1003, 明确了使用请求权重作为限制而不是请求数量。
v1 接口将被弃用:
2020年一季度末,以下接口将被移除。目前文档已经将这些接口更新为v3版本。
- GET api/v1/depth
- GET api/v1/historicalTrades
- GET api/v1/aggTrades
- GET api/v1/klines
- GET api/v1/ticker/24hr
- GET api/v1/ticker/price
- GET api/v1/exchangeInfo
- POST api/v1/userDataStream
- PUT api/v1/userDataStream
- GET api/v1/ping
- GET api/v1/time
- GET api/v1/ticker/bookTicker
以下接口将不会移植到v3版本,请使用新接口予以替换
旧的 V1 接口 | 新的 V3 接口 |
---|---|
GET api/v1/ticker/allPrices | GET api/v3/ticker/price |
GET api/v1/ticker/allBookTickers | GET api/v3/ticker/bookTicker |
事件
executionReport
(订单更新)更新内容:- 如果 C 值为空, 将返回
null
, 而不是"null"
. - 新增返回值 Q, 表示
quoteOrderQty
.
- 如果 C 值为空, 将返回
新增事件类型
balanceUpdate
(余额更新)- 当资金存入或从帐户中提取时,发生余额更新。
- WSS 现在支持实时订阅和取消数据流。
**2019-11-08**
- 新增以下sapi接口用以管理子账户的杠杆与期货:
GET /sapi/v1/sub-account/status (HMAC SHA256)
POST /sapi/v1/sub-account/margin/enable (HMAC SHA256)
GET /sapi/v1/sub-account/margin/account (HMAC SHA256)
GET /sapi/v1/sub-account/margin/accountSummary (HMAC SHA256)
POST /sapi/v1/sub-account/futures/enable (HMAC SHA256)
GET /sapi/v1/sub-account/futures/account (HMAC SHA256)
GET /sapi/v1/sub-account/futures/accountSummary (HMAC SHA256)
GET /sapi/v1/sub-account/futures/positionRisk (HMAC SHA256)
**2019-11-04**
- 新增管理子账户充值功能相关的sapi接口
GET /sapi/v1/capital/deposit/subAddress (HMAC SHA256))
: 获取子账户充值地址。GET /sapi/v1/capital/deposit/subHisrec (HMAC SHA256))
: 获取子账户充值记录。
**2019-10-29**
- 新增钱包提币功能相关的sapi接口
POST /sapi/v1/capital/withdraw/apply (HMAC SHA256)
: 提币。Get /sapi/v1/capital/withdraw/history (HMAC SHA256)
: 获取提币历史(支持多网络)。
**2019-10-14**
- 新增钱包功能相关的sapi接口
GET /sapi/v1/capital/config/getall (HMAC SHA256)
: 获取针对用户的所有币种信息。GET /sapi/v1/capital/deposit/hisrec (HMAC SHA256)
: 获取充值历史(支持多网络)。GET /sapi/v1/capital/deposit/address (HMAC SHA256)
: 获取充值地址(支持多网络).
**2019-10-11**
POST /wapi/v3/withdraw.html
,增加参数network
,支持多网络提币。
**2019-09-09**
- 新增bookTicker行情流:
<symbol>@bookTicker
与!bookTicker
.
**2019-09-03**
- 更新频率达到100ms的更快的 order book 信息流选项:
<symbol>@depth@100ms
和<symbol>@depth#@100ms
Websocket Market Streams
增加Update Speed
更新速度
**2019-08-16**
10000
限额
的接口已被临时删除: GET api/v1/depth在2017年第四季度,以下接口已被弃用并将其从API文档中删除。 从此版本开始,以下接口已从API中永久删除。 对于原始变更日志如有遗漏,我们深表歉意:
- GET api/v1/order
- GET api/v1/openOrders
- POST api/v1/order
- DELETE api/v1/order
- GET api/v1/allOrders
- GET api/v1/account
- GET api/v1/myTrades
在此存储库的文档中描述的流、接口、参数、有效负载等均被 官方认证 且 得到支持。 任何其他流、接口、参数或有效负载等的使用不受支持, 自行使用的风险将由您自己承担,没有任何保证。
**2019-09-15**Rest API
新订单类型: OCO ("One Cancels the Other")
一个 OCO 有 2 个订单: (在财务术语中也称为 legs)
STOP_LOSS
或STOP_LOSS_LIMIT
legLIMIT_MAKER
leg
价格限制:
SELL Orders
: 限价 > 成交价>止损价BUY Orders
: 限价<成交价<止损价- 如前所述,价格必须"横跨"交易品种的最后交易价格。 例如:如果最后价格是10:
- 卖出OCO的限制价格必须大于10,止损价格小于10。
- 买入OCO的限制价格必须小于10,止损价格大于10。
数量限制:
- 两个 legs 的数量必须相同。
- 但是,
ICEBERG
的数量不必相同。
执行顺序:
- 如果触发了
LIMIT_MAKER
,则在取消止损leg之前将首先执行限价支路。 - 如果市场价格移动到将触发"STOP_LOSS"或"STOP_LOSS_LIMIT",则在执行"STOP_LOSS"支路之前,限价单支路将被取消。
- 如果触发了
取消一个 OCO 订单
- 取消任一订单的 leg 将取消整个 OCO 订单.
- 可通过
orderListId
或listClientOrderId
取消整个 OCO 订单。
OCO的新枚举:
ListStatusType
RESPONSE
- 当ListStatus响应失败的操作时使用。 (下单或取消订单)EXEC_STARTED
- 在下订单列表或列表状态更新时使用。ALL_DONE
- 当订单清单完成执行且不再有效时使用。
ListOrderStatus
EXECUTING
- 在下订单列表或列表状态更新时使用。ALL_DONE
- 当订单清单完成执行且不再有效时使用。REJECT
- 当ListStatus响应失败的操作时使用。 (下单或取消订单)
ContingencyType
OCO
- 指定订单列表的类型。
新的接口:
- POST api/v3/order/oco
- DELETE api/v3/orderList
- GET api/v3/orderList
recvWindow
cannot exceed 60000.New
intervalLetter
values for headers:- SECOND => S
- MINUTE => M
- HOUR => H
- DAY => D
新标头"X-MBX-USED-WEIGHT-(intervalNum)(intervalLetter)"将为(intervalNum)(intervalLetter)速率限制器提供您当前使用的请求权重。 例如,如果设置了一分钟的请求速率权重限制器,则响应中将获得一个"X-MBX-USED-WEIGHT-1M"标头。 旧标头X-MBX-USED-WEIGHT仍将返回,并代表一分钟请求速率权重限制的当前使用权重。
新标头"X-MBX-ORDER-COUNT-(intervalNum)(intervalLetter)"会在任何有效的订单位置上更新,并跟踪该间隔的当前订单数; 拒绝/不成功的订单不保证在响应中具有
X-MBX-ORDER-COUNT-**
标头。- 例如: "X-MBX-ORDER-COUNT-1S"用于"每1秒钟的订单",
X-MBX-ORDER-COUNT-1D
用于"每1天的订单"
- 例如: "X-MBX-ORDER-COUNT-1S"用于"每1秒钟的订单",
GET api / v1 / depth现在支持
limit
5000和10000; 权重分别是50和100。GET api / v1 / exchangeInfo具有一个新参数" ocoAllowed"。
executionReport
事件现在包含具有`orderListId``的"g"; 对于非OCO订单,它将设置为-1。- 新事件类型
listStatus
;listStatus
是在更新任何OCO订单时发送的。 - 新事件类型
outboundAccountPosition
; 每当帐户余额发生变化时,就会发送outboundAccountPosition
,并包含可能导致余额发生变化的事件(存款,提款,交易,下单或取消)更改的资产。
- -1131 BAD_RECV_WINDOW
recvWindow
必须小于 60000
- -1099未被找到,被认证或被授权 *替换错误代码-1999
- OCO_BAD_ORDER_PARAMS
- 其中一个订单的参数不正确。
- OCO_BAD_PRICES
- 订单价格之间的关系不正确。
- UNSUPPORTED_ORD_OCO
- 此交易对不支持OCO订单。
**2019-03-12**Rest API
- X-MBX-USED-WEIGHT标头已添加到Rest API响应中。
- Retry-After标头已添加到Rest API 418和429响应中。
- 取消Rest API时,如果交易对的"状态"不是" TRADING",则现在可以返回"errorCode" -1013或-2011。
api/v1/depth
不再具有被忽略和为空的[[]`。api/v3/myTrades
现在返回quoteQty
; 价格*交易数量。
<symbol>@depth
和<symbol>@depthX
流不再具有被忽略且为空的"[]"。
- 匹配引擎稳定性/可靠性改进。
- Rest API性能改进。
**2018-11-13**Rest API
- 现在可以在限制交易期间通过Rest API取消订单。
- 新的过滤器:
PERCENT_PRICE
,MARKET_LOT_SIZE
,MAX_NUM_ICEBERG_ORDERS
。 - 添加了
RAW_REQUESTS
速率限制。 限制取决于X
分钟内的请求数量(不考虑重量)。 - 无交易对查询的
/api/v3/ticker/price
权重增加到2。 /api/v3/ticker/bookTicker
对于无符号查询增加了2的权重。DELETE /api/v3/order
现在将返回订单最终状态的执行报告。MIN_NOTIONAL
过滤器有两个新参数:applyToMarket
(过滤器是否应用于MARKET订单)avgPriceMins
(平均价格的分钟数)。
intervalNum
已添加到/api/v1/exchangeInfo
限制中。intervalNum
描述间隔的数量。 例如:intervalNum
5,带有interval
分钟,表示"每5分钟"。
[过去5分钟所有订单的数量*价格求和] / 过去5分钟所有订单的数量
如果最近5分钟内没有交易,则以5分钟窗口外发生的第一笔交易为准。 例如,如果最后一次交易是在20分钟前,则该交易的价格为5分钟的平均值。
如果代码上没有交易,则没有平均价格,因此无法下达市价单。对于在MIN_NOTIONAL过滤器上启用了applyToMarket的新交易对,除非有至少一笔交易,才能下达市价单。
当前的平均价格可以在这里查看:
https://api.binance.com/api/v3/avgPrice?symbol=<symbol>
例如:https://api.binance.com/api/v3/avgPrice?symbol=BNBUSDT
- 将"最后报价资产交易量"(作为变量" Y")添加到执行报告中。 代表
lastPrice
lastQty
(L
*l
)。
**2018-07-18**Rest API
- 新的过滤器:
ICEBERG_PARTS
post api/v3/order
为newOrderRespType`的新默认值。 ACK,RESULT或FULL; "MARKET"和"LIMIT"订单类型默认为"FULL",所有其他订单默认为"ACK"。- POST api/v3 order
RESULT
和FULL
响应现在具有"cummulativeQuoteQty" - GET/api/v3/ openOrders的交易对权重减少到40。
- GET/api/v3/ ticker / 24hr,且交易对权重未降低至40。
- GET/api/v1/ trades的最大交易量增加到1000。
- GET/api/v1/ historicalTrades的最大交易量增加到1000。
- GET/api/v1/ aggTrades的最大总交易量增加到1000。
- GET/api/v1/ klines的最大总交易量增加到1000。
- 剩余的API订单查询现在返回
updateTime
,它代表订单的最后更新时间; time是订单创建时间。 - 订单查找接口现在将返回"cummulativeQuoteQty"。如果"cummulativeQuoteQty"小于0,则表示该时间该数据不可用。
- REQUESTS速率限制类型更改为REQUEST_WEIGHT。从逻辑上讲,此限制始终是请求权重,并且其先前的名称引起混乱。
- 在订单响应和执行报告中添加了"cummulativeQuoteQty"字段(作为变量"Z")。 表示已花费(使用"买入"订单)或已收到(使用"卖出"订单)的"报价"的累计金额。 历史订单在该字段中的值将小于0,这表明该数据目前不可用。 "cummulativeQuoteQty"除以"cummulativeQty"将得出订单的平均价格。
O
(订单创建时间)添加到执行报告中
**2018-01-23**
- GET/api/v1/ historicalTrades权重降低到5
- GET/api/v1/ aggTrades权重降至1
- GET/api/v1/ klines权重降至1
- GET/api/v1/ticker / 24hr,所有交易品种的权重降低到交易交易品种的数量/ 2
- GET/api/v3/ allOrders权重降低到5
- GET/api/v3/ myTrades权重降低到5
- GET/api/v3/帐户权重降低到5
- GET/api/v1/深度限制= 500重量减少到5
- GET/api/v1/深度限制= 1000重量减少到10
- -1003错误消息已更新,可将用户定向到websocket
**2018-01-20**
- GET/api/v1/ticker / 24hr单个符号权重降至1
- GET/api/v3/ openOrders所有交易对权重下降至交易交易品种数量/ 2
- GET/api/v3/allOrders权重降低到15
- GET/api/v3/ myTrades权重降低到15
- GET/api/v3/订单权重降至1
- myTrades现在将返回自交易/清洗交易的双方
**2018-01-14**
- GET/api/v1/aggTrades权重更改为2
- GET/api/v1/klines权重更改为2
- GET/api/v3/订单权重更改为2
- GET/api/v3/ allOrders权重更改为20
- GET/api/v3/帐户权重更改为20
- GET/api/v3/ myTrades权重更改为20
- GET/api/v3/ historicalTrades权重更改为20
介绍
#
API Key 设置- 很多接口需要API Key才可以访问. 请参考这个页面来设置API Key.
- 设置API Key的同时,为了安全,建议设置IP访问白名单.
- 永远不要把你的API key/secret告诉给任何人
#
API Key 权限设置- 新创建的API的默认权限是
只读
。 - 如果需要通过API提款, 需要在UI修改权限, 选中
允许提现
。
#
账户#
现货账户新注册的币安账号都会有一个现货(SPOT
)账号。
#
杠杆账户为了开设杠杆(MARGIN
)账户, 可以参考Binance杠杆交易账户设置指南
#
现货测试网用户可以使用现货的测试网来体验SPOT
交易. 现在只能通过API来交易。
更多信息请参考现货测试网。
#
API 代码库#
Python connector一个轻量级的Python代码库,提供让用户直接调用API的方法。支持所有现货的接口。
https://github.com/binance/binance-connector-python
#
Node.js connector一个轻量级的代码库,提供Node.js用户直接调用API的方法。支持所有现货的接口。
https://github.com/binance/binance-connector-node
#
Ruby connector一个轻量级的代码库,提供Ruby用户直接调用API的方法。支持所有现货的接口。
https://github.com/binance/binance-connector-ruby
#
DotNET connector一个轻量级的代码库,提供C#用户直接调用API的方法。支持所有现货的接口。
https://github.com/binance/binance-connector-dotnet
#
Java connector一个轻量级的代码库,提供Java用户直接调用API的方法。支持所有现货的接口。
https://github.com/binance/binance-connector-java
#
Postman Collections现在你可以通过Postman collection
来快速体验、使用API接口。
如果想了解更多如何使用Postman,请访问: Binance API Postman
#
Swagger一个基于OpenAPI规范的RESTful API接口定义的YAML文件,还有便于交互的 Swagger UI 页面。
https://github.com/binance/binance-api-swagger
#
联系我们- 币安API电报群
- 咨询关于API或者Websockets性能方面的问题.
- 咨询文档中没有提及的API问题.
- 币安开发者社区
- 咨询关于API/Websockets代码实现,或者任何API/Websockets的问题.
- 币安客服
- 咨询关于账户,钱包,2FA等.
基本信息
#
API 基本信息- 接口可能需要用户的 API Key,如何创建API-KEY请参考这里
- 本篇列出接口的baseurl: https://api.binance.com
- 如果上面的baseURL访问有性能问题,请访问下面的API集群:
- 所有接口的响应都是 JSON 格式。
- 响应中如有数组,数组元素以时间升序排列,越早的数据越提前。
- 所有时间、时间戳均为UNIX时间,单位为毫秒。
#
HTTP 返回代码- HTTP
4XX
错误码用于指示错误的请求内容、行为、格式。问题在于请求者。 - HTTP
403
错误码表示违反WAF限制(Web应用程序防火墙)。 - HTTP
429
错误码表示警告访问频次超限,即将被封IP。 - HTTP
418
表示收到429后继续访问,于是被封了。 - HTTP
5XX
错误码用于指示Binance服务侧的问题。
#
接口错误代码- 使用接口
/api/v3
, 以及/sapi/v1/margin
时, 每个接口都有可能抛出异常;
API 与 SAPI 的错误代码返回形式如下:
- 具体的错误码及其解释在 错误代码.
#
接口的基本信息GET
方法的接口, 参数必须在query string
中发送。POST
,PUT
, 和DELETE
方法的接口,参数可以在内容形式为application/x-www-form-urlencoded
的query string
中发送,也可以在request body
中发送。 如果你喜欢,也可以混合这两种方式发送参数。- 对参数的顺序不做要求。
- 但如果同一个参数名在query string和request body中都有,query string中的会被优先采用。
#
访问限制#
访问限制基本信息以下 是
intervalLetter
作为头部值:- SECOND => S
- MINUTE => M
- HOUR => H
- DAY => D
在
/api/v3/exchangeInfo
rateLimits
数组中包含与交易的有关RAW_REQUESTS,REQUEST_WEIGHT和ORDERS速率限制相关的对象。这些在限制种类 (rateLimitType)
下的枚举定义
部分中进一步定义。违反任何一个速率限制时,将返回429。
#
IP 访问限制- 每个请求将包含一个
X-MBX-USED-WEIGHT-(intervalNum)(intervalLetter)
的头,其中包含当前IP所有请求的已使用权重。 - 每一个接口均有一个相应的权重(weight),有的接口根据参数不同可能拥有不同的权重。越消耗资源的接口权重就会越大。
- 收到429时,您有责任停止发送请求,不得滥用API。
- 收到429后仍然继续违反访问限制,会被封禁IP,并收到418错误码
- 频繁违反限制,封禁时间会逐渐延长,从最短2分钟到最长3天。
Retry-After
的头会与带有418或429的响应发送,并且会给出以秒为单位的等待时长(如果是429)以防止禁令,或者如果是418,直到禁令结束。- 访问限制是基于IP的,而不是API Key
###下单频率限制
- 每个成功的下单回报将包含一个
X-MBX-ORDER-COUNT-(intervalNum)(intervalLetter)
的头,其中包含当前账户已用的下单限制数量。 - 当下单数超过限制时,会收到带有429但不含
Retry-After
头的响应。请检查GET api/v3/exchangeInfo
的下单频率限制 (rateLimitType = ORDERS) 并等待封禁时间结束。 - 被拒绝或不成功的下单并不保证回报中包含以上头内容。
- 下单频率限制是基于每个账户计数的。
#
WEB SOCKET 连接限制- Websocket服务器每秒最多接受5个消息。消息包括:
- PING帧
- PONG帧
- JSON格式的消息, 比如订阅, 断开订阅.
- 如果用户发送的消息超过限制,连接会被断开连接。反复被断开连接的IP有可能被服务器屏蔽。
- 单个连接最多可以订阅 1024 个Streams。
#
/api/ 与 /sapi/ 接口限频说明/api/*
接口和 /sapi/*
接口采用两套不同的访问限频规则, 两者互相独立。
/api/*
的接口相关:- 按IP和按UID(account)两种模式分别统计, 两者互相独立。
- 以
/api/*
开头的接口按IP限频,且所有接口共用每分钟1200限制。 - 每个请求将包含一个
X-MBX-USED-WEIGHT-(intervalNum)(intervalLetter)
的头,包含当前IP所有请求的已使用权重。 - 每个成功的下单回报将包含一个
X-MBX-ORDER-COUNT-(intervalNum)(intervalLetter)
的头,其中包含当前账户已用的下单限制数量。
/sapi/*
的接口相关:- 按IP和按UID(account)两种模式分别统计, 两者互相独立。
- 以
/sapi/*
开头的接口采用单接口限频模式。按IP统计的权重单接口权重总额为每分钟12000;按照UID统计的单接口权重总额是每分钟180000。 - 每个接口会标明是按照IP或者按照UID统计, 以及相应请求一次的权重值。
- 按照IP统计的接口, 请求返回头里面会包含
X-SAPI-USED-IP-WEIGHT-1M=<value>
, 包含当前IP所有请求已使用权重。 - 按照UID统计的接口, 请求返回头里面会包含
X-SAPI-USED-UID-WEIGHT-1M=<value>
, 包含当前账户所有已用的UID权重。
#
数据来源- 因为API系统是异步的, 所以返回的数据有延时很正常, 也在预期之中。
- 在每个接口中,列出了其数据的来源,可以用于理解数据的时效性。
系统一共有3个数据来源,按照更新速度的先后排序。排在前面的数据最新,在后面就有可能存在延迟。
- 撮合引擎 - 表示数据来源于撮合引擎
- 缓存 - 表示数据来源于内部或者外部的缓存
- 数据库 - 表示数据直接来源于数据库
#
接口鉴权类型- 每个接口都有自己的鉴权类型,鉴权类型决定了访问时应当进行何种鉴权。
- 鉴权类型会在本文档中各个接口名称旁声明,如果没有特殊声明即默认为
NONE
。 - 如果需要 API-keys,应当在HTTP头中以
X-MBX-APIKEY
字段传递。 - API-keys 与 secret-keys 是大小写敏感的。
- API-keys可以被配置为只拥有访问一些接口的权限。 例如, 一个 API-key 仅可用于发送交易指令, 而另一个 API-key 则可访问除交易指令外的所有路径。
- 默认 API-keys 可访问所有鉴权路径.
鉴权类型 | 描述 |
---|---|
NONE | 不需要鉴权的接口 |
TRADE | 需要有效的 API-Key 和签名 |
MARGIN | 需要有效的 API-Key 和签名 |
USER_DATA | 需要有效的 API-Key 和签名 |
USER_STREAM | 需要有效的 API-Key |
MARKET_DATA | 需要有效的 API-Key |
TRADE
,MARGIN
和USER_DATA
接口是 签名(SIGNED)接口.
#
SIGNED (TRADE、USER_DATA AND MARGIN) Endpoint security- 调用
SIGNED
接口时,除了接口本身所需的参数外,还需要在query string
或request body
中传递signature
, 即签名参数。 - 签名使用
HMAC SHA256
算法. API-KEY所对应的API-Secret作为HMAC SHA256
的密钥,其他所有参数作为HMAC SHA256
的操作对象,得到的输出即为签名。 签名
大小写不敏感.- "totalParams"定义为与"request body"串联的"query string"。
#
时间同步安全- 签名接口均需要传递
timestamp
参数,其值应当是请求发送时刻的unix时间戳(毫秒)。 - 服务器收到请求时会判断请求中的时间戳,如果是5000毫秒之前发出的,则请求会被认为无效。这个时间空窗值可以通过发送可选参数
recvWindow
来定义。
逻辑伪代码如下:
关于交易时效性 互联网状况并不完全稳定可靠,因此你的程序本地到币安服务器的时延会有抖动。这是我们设置recvWindow
的目的所在,如果你从事高频交易,对交易时效性有较高的要求,可以灵活设置recvWindow
以达到你的要求。
#
POST /api/v3/order 的示例以下是在linux bash环境下使用 echo openssl 和curl工具实现的一个调用接口下单的示例 apikey、secret仅供示范
Key | Value |
---|---|
apiKey | vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A |
secretKey | NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j |
参数 | 取值 |
---|---|
symbol | LTCBTC |
side | BUY |
type | LIMIT |
timeInForce | GTC |
quantity | 1 |
price | 0.1 |
recvWindow | 5000 |
timestamp | 1499827319559 |
#
示例 1: 所有参数通过 request body 发送Example 1
HMAC SHA256 signature:
curl command:
- requestBody:
symbol=LTCBTC
&side=BUY
&type=LIMIT
&timeInForce=GTC
&quantity=1
&price=0.1
&recvWindow=5000
×tamp=1499827319559
#
示例 2: 所有参数通过 query string 发送Example 2
HMAC SHA256 signature:
curl command:
- queryString:
symbol=LTCBTC
&side=BUY
&type=LIMIT
&timeInForce=GTC
&quantity=1
&price=0.1
&recvWindow=5000
×tamp=1499827319559
#
示例 3: 混合使用 query string 和 request bodyExample 3
HMAC SHA256 signature:
curl command:
- queryString:
symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC
- requestBody:
quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559
请注意,签名与示例3不同。 "GTC"和"quantity = 1"之间没有&。
#
公开 API 参数#
术语这里的术语适用于全部文档,建议特别是新手熟读,也便于理解。
base asset
指一个交易对的交易对象,即写在靠前部分的资产名, 比如BTCUSDT
,BTC
是base asset
。quote asset
指一个交易对的定价资产,即写在靠后部分的资产名, 比如BTCUSDT
,USDT
是quote asset
。
#
枚举定义交易对状态 (状态 status):
- PRE_TRADING 交易前
- TRADING 交易中
- POST_TRADING 交易后
- END_OF_DAY
- HALT
- AUCTION_MATCH
- BREAK
交易对类型:
- SPOT 现货
- MARGIN 杠杆
- LEVERAGED 杠杆代币
- TRD_GRP_002 交易组 002
订单状态 (状态 status):
状态 | 描述 |
---|---|
NEW | 订单被交易引擎接受 |
PARTIALLY_FILLED | 部分订单被成交 |
FILLED | 订单完全成交 |
CANCELED | 用户撤销了订单 |
PENDING_CANCEL | 撤销中(目前并未使用) |
REJECTED | 订单没有被交易引擎接受,也没被处理 |
EXPIRED | 订单被交易引擎取消, 比如 LIMIT FOK 订单没有成交 市价单没有完全成交 强平期间被取消的订单 交易所维护期间被取消的订单 |
OCO 状态 (状态类型集 listStatusType):
状态 | 描述 |
---|---|
RESPONSE | 当ListStatus响应失败的操作时使用。 (订单完成或取消订单) |
EXEC_STARTED | 当已经下单或者订单有更新时 |
ALL_DONE | 当订单执行结束或者不在激活状态 |
OCO 订单状态 (订单状态集 listOrderStatus):
状态 | 描述 |
---|---|
EXECUTING | 当已经下单或者订单有更新时 |
ALL_DONE | 当订单执行结束或者不在激活状态 |
REJECT | 当订单状态响应失败(订单完成或取消订单) |
指定订单的类型
- OCO 选择性委托订单
订单类型 (orderTypes, type):
关于订单类型的类型,可以参考这里详细说明
- LIMIT 限价单
- MARKET 市价单
- STOP_LOSS 止损单
- STOP_LOSS_LIMIT 限价止损单
- TAKE_PROFIT 止盈单
- TAKE_PROFIT_LIMIT 限价止盈单
- LIMIT_MAKER 限价只挂单
订单返回类型 (newOrderRespType):
- ACK
- RESULT
- FULL
订单方向 (方向 side):
- BUY 买入
- SELL 卖出
有效方式 (timeInForce):
这里定义了订单多久能够失效
Status | Description |
---|---|
GTC | 成交为止 undefined 订单会一直有效,直到被成交或者取消。 |
IOC | 无法立即成交的部分就撤销 undefined 订单在失效前会尽量多的成交。 |
FOK | 无法全部立即成交就撤销 undefined 如果无法全部成交,订单会失效。 |
K线间隔:
m -> 分钟; h -> 小时; d -> 天; w -> 周; M -> 月
- 1m
- 3m
- 5m
- 15m
- 30m
- 1h
- 2h
- 4h
- 6h
- 8h
- 12h
- 1d
- 3d
- 1w
- 1M
限制种类 (rateLimitType)
REQUEST_WEIGHT
ORDERS
RAW_REQUESTS
REQUEST_WEIGHT 单位时间请求权重之和上限
ORDERS 单位时间下单次数限制
RAW_REQUESTS 单位时间请求次数上限
限制间隔 (interval)
- SECOND 秒
- MINUTE 分
- DAY 天
#
过滤器过滤器,即Filter,定义了一系列交易规则。 共有两类,分别是针对交易对的过滤器symbol filters
,和针对整个交易所的过滤器 exchange filters
#
交易对过滤器#
PRICE_FILTER 价格过滤器/exchangeInfo 响应中的格式:
价格过滤器
用于检测订单中 price
参数的合法性。包含以下三个部分:
minPrice
定义了price
/stopPrice
允许的最小值。maxPrice
定义了price
/stopPrice
允许的最大值。tickSize
定义了price
/stopPrice
的步进间隔,即price必须等于minPrice+(tickSize的整数倍)
以上每一项均可为0,为0时代表这一项不再做限制。
逻辑伪代码如下:
price
>=minPrice
price
<=maxPrice
- (
price
-minPrice
) %tickSize
== 0
#
PERCENT_PRICE 价格振幅过滤器/exchangeInfo 响应中的格式:
PERCENT_PRICE
过滤器基于先前交易的平均值来定义价格的有效范围。
avgPriceMins
是计算平均价格的分钟数。 0表示使用最后的价格。
为了通过"价格百分比","价格"必须符合以下条件:
price
<=weightedAveragePrice
*multiplierUp
price
> =weightedAveragePrice
*multiplierDown
#
LOT_SIZE 订单尺寸/exchangeInfo 响应中的格式:
Lots是拍卖术语,LOT_SIZE
过滤器对订单中的 quantity
也就是数量参数进行合法性检查。包含三个部分:
minQty
表示quantity
/icebergQty
允许的最小值。maxQty
表示quantity
/icebergQty
允许的最大值。stepSize
表示quantity
/icebergQty
允许的步进值。
逻辑伪代码如下:
quantity
>=minQty
quantity
<=maxQty
- (
quantity
-minQty
) %stepSize
== 0
#
MIN_NOTIONAL 最小名义价值(成交额)/exchangeInfo 响应中的格式:
MIN_NOTIONAL过滤器定义了交易对订单所允许的最小名义价值(成交额)。
订单的名义价值是价格
数量
。
如果是高级订单(比如止盈止损订单STOP_LOSS_LIMIT
),名义价值会按照stopPrice
quantity
来计算。
如果是冰山订单,名义价值会按照price
* icebergQty
来计算。
applyToMarket
确定 MIN_NOTIONAL
过滤器是否也将应用于MARKET
订单。
由于MARKET
订单没有价格,因此会在最后avgPriceMins
分钟内使用平均价格。
avgPriceMins
是计算平均价格的分钟数。 0表示使用最后的价格。
#
ICEBERG_PARTS 冰山订单拆分数/exchangeInfo 响应中的格式:
ICEBERG_PARTS
代表冰山订单最多可以拆分成多少个小订单。
计算方法为 向上取整(qty / icebergQty)
。
#
MARKET_LOT_SIZE 市价订单尺寸*/exchangeInfo 响应中的格式:
MARKET_LOT_SIZE
过滤器为交易对上的MARKET
订单定义了数量
(即拍卖中的"手数")规则。 共有3部分:
minQty
定义了允许的最小quantity
。maxQty
定义了允许的最大数量。stepSize
定义了可以增加/减少数量的间隔。
为了通过market lot size
,quantity
必须满足以下条件:
quantity
>=minQty
quantity
<=maxQty
- (
quantity
-minQty
) %stepSize
== 0
#
MAX_NUM_ORDERS 最多订单数/exchangeInfo 响应中的格式:
定义了某个交易对最多允许的挂单数量(不包括已关闭的订单)
普通订单与条件订单均计算在内
#
MAX_NUM_ALGO_ORDERS 最多条件单数/exchangeInfo 响应中的格式:
MAX_NUM_ALGO_ORDERS
过滤器定义允许账户在交易对上开设的"algo"订单的最大数量。
"Algo"订单是STOP_LOSS
,STOP_LOSS_LIMIT
,TAKE_PROFIT
和TAKE_PROFIT_LIMIT
止盈止损单。
#
MAX_NUM_ICEBERG_ORDERS 最多冰山单数MAX_NUM_ICEBERG_ORDERS
过滤器定义了允许在交易对上开设账户的ICEBERG
订单的最大数量。
ICEBERG
订单是icebergQty大于0的任何订单。.
/exchangeInfo 响应中的格式:
#
MAX_POSITION 过滤器这个过滤器定义账户允许的基于base asset
的最大仓位。一个用户的仓位可以定义为如下资产的总和:
base asset
的可用余额base asset
的锁定余额- 所有处于open的买单的数量总和
如果用户的仓位大于最大的允许仓位,买单会被拒绝。
/exchangeInfo 响应中的格式:
#
交易所级别过滤器#
EXCHANGE_MAX_NUM_ORDERS 最多订单数/exchangeInfo 响应中的格式:
EXCHANGE_MAX_NUM_ORDERS
过滤器定义了允许在交易对上开设账户的最大订单数。
请注意,此过滤器同时计算"algo"订单和常规订单。
#
EXCHANGE_MAX_ALGO_ORDERS 交易最大ALGO订单数/exchangeInfo 响应中的格式:
EXCHANGE_MAX_ALGO_ORDERS
过滤器定义了允许在交易上开设账户的"algo"订单的最大数量。
"Algo"订单是STOP_LOSS
,STOP_LOSS_LIMIT
,TAKE_PROFIT
和TAKE_PROFIT_LIMIT
订单。
钱包接口
#
系统状态(System)响应
GET /sapi/v1/system/status
获取系统状态。
权重(IP): 1
#
获取所有币信息 (USER_DATA)获取针对用户的所有(Binance支持充提操作的)币种信息。
响应
GET /sapi/v1/capital/config/getall (HMAC SHA256)
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
查询每日资产快照 (USER_DATA)响应
或
或
GET /sapi/v1/accountSnapshot (HMAC SHA256)
权重(IP): 2400
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
type | STRING | YES | "SPOT", "MARGIN", "FUTURES" |
startTime | LONG | NO | |
endTime | LONG | NO | |
limit | INT | NO | min 7, max 30, default 7 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 查询时间范围最大不得超过30天
- 仅支持查询最近 1 个月数据
- 若startTime和endTime没传,则默认返回最近7天数据
#
关闭站内划转 (USER_DATA)响应
POST /sapi/v1/account/disableFastWithdrawSwitch (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
注意:
此请求会关闭您账户的站内快速划转。您需要为api-key开通"trade"权限才能发送此请求。
#
开启站内划转 (USER_DATA)响应
POST /sapi/v1/account/enableFastWithdrawSwitch (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 此请求会开启您账户的站内快速划转。您需要为api-key开通"trade"权限才能发送此请求。
- 开启以后, 如果收款方为币安账户地址,转账费用为0, 速度快, 不需要提交上链请求。
#
提币 (USER_DATA)响应
POST /sapi/v1/capital/withdraw/apply (HMAC SHA256)
Submit a withdraw request.
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
coin | STRING | YES | |
withdrawOrderId | STRING | NO | 自定义提币ID |
network | STRING | NO | 提币网络 |
address | STRING | YES | 提币地址 |
addressTag | STRING | NO | 某些币种例如 XRP,XMR 允许填写次级地址标签 |
amount | DECIMAL | YES | 数量 |
transactionFeeFlag | BOOLEAN | NO | 当站内转账时免手续费, true : 手续费归资金转入方; false : 手续费归资金转出方; . 默认 false . |
name | STRING | NO | 地址的备注,填写该参数后会加入该币种的提现地址簿。地址簿上限为20,超出后会造成提现失败。地址中的空格需要encode成%20 |
walletType | INTEGER | NO | 表示出金使用的钱包,0为现货钱包,1为资金钱包,默认为现货钱包 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 如果不发送
network
, 将按该币种默认网络返回结果; - 可以在接口
Get /sapi/v1/capital/config/getall (HMAC SHA256)
的返回值中某币种的networkList
获取network
网络字段和isDefault
是否为默认网络。
#
获取充值历史(支持多网络) (USER_DATA)响应
GET /sapi/v1/capital/deposit/hisrec (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
coin | STRING | NO | |
status | INT | NO | 0(0:pending,6: credited but cannot withdraw, 1:success) |
startTime | LONG | NO | 默认当前时间90天前的时间戳 |
endTime | LONG | NO | 默认当前时间戳 |
offset | INT | NO | 默认:0 |
limit | INT | NO | 默认:1000,最大1000 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 请注意
startTime
与endTime
的默认时间戳,保证请求时间间隔不超过90天. - 同时提交
startTime
与endTime
间隔不得超过90天.
#
获取提币历史 (支持多网络) (USER_DATA)响应
GET /sapi/v1/capital/withdraw/history (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
coin | STRING | NO | |
withdrawOrderId | STRING | NO | |
status | INT | NO | 0(0:已发送确认Email,1:已被用户取消 2:等待确认 3:被拒绝 4:处理中 5:提现交易失败 6 提现完成) |
offset | INT | NO | |
limit | INT | NO | 默认:1000, 最大:1000 |
startTime | LONG | NO | 默认当前时间90天前的时间戳 |
endTime | LONG | NO | 默认当前时间戳 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 支持多网络提币前的历史记录可能不会返回
network
字段. - 请注意
startTime
与endTime
的默认时间戳,保证请求时间间隔不超过90天. - 同时提交
startTime
与endTime
间隔不得超过90天.
#
获取充值地址 (支持多网络) (USER_DATA)响应
GET /sapi/v1/capital/deposit/address (HMAC SHA256)
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
coin | STRING | YES | |
network | STRING | NO | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 如果不发送
network
, 将按该币种默认网络返回结果; - 可以在接口
Get /sapi/v1/capital/config/getall (HMAC SHA256)
的返回值中某币种的networkList
获取network
网络字段和isDefault
是否为默认网络。
#
账户状态 (USER_DATA)响应
GET /sapi/v1/account/status
获取账户状态详情。
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
账户API交易状态(USER_DATA)响应
GET /sapi/v1/account/apiTradingStatus (HMAC SHA256)
获取 api 账户交易状态详情。
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
小额资产转换BNB历史 (USER_DATA)响应
GET /sapi/v1/asset/dribblet (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
startTime | LONG | NO | |
endTime | LONG | NO | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 只返回最近100条记录
- 只返回 2020/12/01 之后记录
#
获取可以转换成BNB的小额资产 (USER_DATA)响应
POST /sapi/v1/asset/dust-btc (HMAC SHA256)
获取可以转换成 BNB 的小额资产列表.
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
小额资产转换 (USER_DATA)响应
POST /sapi/v1/asset/dust (HMAC SHA256)
把小额资产转换成 BNB.
权重(UID): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | ARRAY | YES | 正在转换的资产。 例如:asset = BTC&asset = USDT |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 您需要为API Key开通
允许现货和杠杆交易
权限才能发送此请求
#
资产利息记录 (USER_DATA)响应
GET /sapi/v1/asset/assetDividend (HMAC SHA256)
获取资产利息记录。
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | NO | |
startTime | LONG | NO | |
endTime | LONG | NO | |
limit | INT | NO | Default 20, max 500 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
上架资产详情 (USER_DATA)响应
GET /sapi/v1/asset/assetDetail (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | NO | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 充提币信息,建议查询
GET /sapi/v1/capital/config/getall
获取详情。
#
交易手续费率查询 (USER_DATA)响应
GET /sapi/v1/asset/tradeFee (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | NO | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
用户万向划转 (USER_DATA)响应:
POST /sapi/v1/asset/transfer (HMAC SHA256)
您需要开通api key 允许万向划转
权限来调用此接口。
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
type | ENUM | YES | |
asset | STRING | YES | |
amount | DECIMAL | YES | |
fromSymbol | STRING | NO | |
toSymbol | STRING | NO | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
fromSymbol
必须要发送,当类型为 ISOLATEDMARGIN_MARGIN 和 ISOLATEDMARGIN_ISOLATEDMARGINtoSymbol
必须要发送,当类型为 MARGIN_ISOLATEDMARGIN 和 ISOLATEDMARGIN_ISOLATEDMARGIN目前支持的type划转类型:
- MAIN_UMFUTURE 现货钱包转向U本位合约钱包
- MAIN_CMFUTURE 现货钱包转向币本位合约钱包
- MAIN_MARGIN 现货钱包转向杠杆全仓钱包
- UMFUTURE_MAIN U本位合约钱包转向现货钱包
- UMFUTURE_MARGIN U本位合约钱包转向杠杆全仓钱包
- CMFUTURE_MAIN 币本位合约钱包转向现货钱包
- MARGIN_MAIN 杠杆全仓钱包转向现货钱包
- MARGIN_UMFUTURE 杠杆全仓钱包转向U本位合约钱包
- MARGIN_CMFUTURE 杠杆全仓钱包转向币本位合约钱包
- CMFUTURE_MARGIN 币本位合约钱包转向杠杆全仓钱包
- ISOLATEDMARGIN_MARGIN 杠杆逐仓钱包转向杠杆全仓钱包
- MARGIN_ISOLATEDMARGIN 杠杆全仓钱包转向杠杆逐仓钱包
- ISOLATEDMARGIN_ISOLATEDMARGIN 杠杆逐仓钱包转向杠杆逐仓钱包
- MAIN_FUNDING 现货钱包转向资金钱包
- FUNDING_MAIN 资金钱包转向现货钱包
- FUNDING_UMFUTURE 资金钱包转向U本位合约钱包
- UMFUTURE_FUNDING U本位合约钱包转向资金钱包
- MARGIN_FUNDING 杠杆全仓钱包转向资金钱包
- FUNDING_MARGIN 资金钱包转向杠杆全仓钱包
- FUNDING_CMFUTURE 资金钱包转向币本位合约钱包
- CMFUTURE_FUNDING 币本位合约钱包转向资金钱包
#
查询用户万向划转历史 (USER_DATA)响应:
GET /sapi/v1/asset/transfer (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
type | ENUM | YES | |
startTime | LONG | NO | |
endTime | LONG | NO | |
current | INT | NO | 默认 1 |
size | INT | NO | 默认 10, 最大 100 |
fromSymbol | STRING | NO | |
toSymbol | STRING | NO | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
fromSymbol
必须要发送,当类型为 ISOLATEDMARGIN_MARGIN 和 ISOLATEDMARGIN_ISOLATEDMARGINtoSymbol
必须要发送,当类型为 MARGIN_ISOLATEDMARGIN 和 ISOLATEDMARGIN_ISOLATEDMARGIN- 仅支持查询最近半年(6个月)数据
- 若
startTime
和endTime
没传,则默认返回最近7天数据
#
资金账户 (USER_DATA)响应
POST /sapi/v1/asset/get-funding-asset (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | NO | |
needBtcValuation | STRING | NO | true or false |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 目前仅支持查询以下业务资产:Binance Pay, Binance Card, Binance Gift Card, Stock Token
#
查询用户API Key权限 (USER_DATA)响应
GET /sapi/v1/account/apiRestrictions (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
子母账户接口
#
创建虚拟子账户(适用主账户)响应:
POST /sapi/v1/sub-account/virtualSubAccount (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
subAccountString | STRING | YES | 请输入字符串,我们将为您创建一个虚拟邮箱进行注册 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 该请求会为您的母账户生成一个虚拟子账户
- 您需要为母账户apikey开通"允许现货及杠杆交易" 权限调用此接口
#
查询子账户列表(适用主账户)响应:
GET /sapi/v1/sub-account/list (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | NO | Sub-account email | |
isFreeze | STRING | NO | true or false |
page | INT | NO | 默认: 1 |
limit | INT | NO | 默认: 1, 最大: 200 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
查询子账户现货资金划转历史 (适用主账户)响应:
GET /sapi/v1/sub-account/sub/transfer/history (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
fromEmail | STRING | NO | Sub-account email |
toEmail | STRING | NO | Sub-account email |
startTime | LONG | NO | |
endTime | LONG | NO | |
page | INT | NO | 默认: 1 |
limit | INT | NO | 默认: 500 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- fromEmail 和 toEmail 不可以同时发送
- 若 fromEmail 和 toEmail 都未传,默认返回fromEmail 为母账户的记录。
#
查询子账户合约资金划转历史 (适用主账户)响应
GET /sapi/v1/sub-account/futures/internalTransfer (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
futuresType | LONG | YES | 1:USDT合约,2: 币本位合约 |
startTime | LONG | NO | 默认返回100天内历史记录 |
endTime | LONG | NO | 默认返回100天内历史记录 |
page | INT | NO | 默认值: 1 |
limit | INT | NO | 默认值: 50, 最大值:500 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
执行子账户合约资金划转 (适用主账户)响应
POST /sapi/v1/sub-account/futures/internalTransfer (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
fromEmail | STRING | YES | 发送者邮箱 备注 |
toEmail | STRING | YES | 接收者邮箱 备注 |
futuresType | LONG | YES | 1:USDT合约, 2: 币本位合约 |
asset | STRING | YES | |
amount | DECIMAL | YES | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 每个母账户每分钟上限2000次
#
查询子账户资产 (适用主账户)响应
GET /sapi/v3/sub-account/assets (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
查询子账户现货资产汇总 (适用主账户)响应:
获取BTC计价的子账户现货资产汇总。
GET /sapi/v1/sub-account/spotSummary (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | NO | 子账户邮箱 | |
page | LONG | NO | 分页,默认 1 |
size | LONG | NO | 单页条目数, 默认 10, 最大 20 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
获取子账户充值地址 (适用主账户)响应
GET /sapi/v1/capital/deposit/subAddress (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
coin | STRING | YES | |
network | STRING | NO | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
获取子账户充值记录 (适用主账户)响应
GET /sapi/v1/capital/deposit/subHisrec (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
coin | STRING | NO | |
status | INT | NO | 0(0:pending,6: credited but cannot withdraw, 1:success) |
startTime | LONG | NO | |
endTime | LONG | NO | |
limit | INT | NO | |
offset | INT | NO | default:0 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
查询子账户Margin/Futures状态 (适用主账户)响应
GET /sapi/v1/sub-account/status (HMAC SHA256)
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | NO | 子账户邮箱 备注 | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 如果不提交子账户email,返回所有子账户情况。
##为子账户开通Margin (适用主账户)
响应
POST /sapi/v1/sub-account/margin/enable (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
##查询子账户Margin账户详情 (适用主账户)
响应
GET /sapi/v1/sub-account/margin/account (HMAC SHA256)
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
##查询子账户Margin账户汇总 (适用主账户)
响应
GET /sapi/v1/sub-account/margin/accountSummary (HMAC SHA256)
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
##为子账户开通Futures (适用主账户)
响应
POST /sapi/v1/sub-account/futures/enable (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
##查询子账户Futures账户详情 (适用主账户)
响应
GET /sapi/v1/sub-account/futures/account (HMAC SHA256)
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
##查询子账户Futures账户汇总 (适用主账户)
响应
GET /sapi/v1/sub-account/futures/accountSummary (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | |
timestamp | LONG | YES |
##查询子账户合约持仓信息 (仅适用主账户)
响应
GET /sapi/v1/sub-account/futures/positionRisk (HMAC SHA256)
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
子账户Futures划转 (仅适用主账户)响应
POST /sapi/v1/sub-account/futures/transfer (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
asset | STRING | YES | 划转资产, e.g., USDT |
amount | DECIMAL | YES | 划转数量 |
type | INT | YES | 1: 由子账户的现货账户划转至其USDT本位合约账户; 2: 由子账户的USDT本位合约账户划转至其现货账户; 3:由子账户现货账户划转至其COIN本位合约账户;4: 由子账户COIN本位合约账户划转至其现货账户 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
子账户Margin划转 (仅适用主账户)响应
POST /sapi/v1/sub-account/margin/transfer (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
asset | STRING | YES | 划转资产, e.g., USDT |
amount | DECIMAL | YES | 划转数量 |
type | INT | YES | 1: 由子账户的现货账户划转至其杠杆账户; 2: 由子账户的杠杆账户划转至其现货账户 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
向共同主账户下的子账户主动划转 (仅适用子账户)响应
POST /sapi/v1/sub-account/transfer/subToSub (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
toEmail | STRING | YES | 接收者子邮箱地址 备注 |
asset | STRING | YES | |
amount | DECIMAL | YES | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
向主账户主动划转 (仅适用子账户)响应
POST /sapi/v1/sub-account/transfer/subToMaster (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | YES | |
amount | DECIMAL | YES | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
查询子账户划转历史 (仅适用子账户)响应
GET /sapi/v1/sub-account/transfer/subUserHistory (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | NO | 如不提供,返回所有asset 划转记录 |
type | INT | NO | 1: transfer in, 2: transfer out; 如不提供,返回transfer out方向划转记录 |
startTime | LONG | NO | |
endTime | LONG | NO | |
limit | INT | NO | 默认值: 500 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 如果startTime和endTime均未发送,默认只返回最近30天数据
#
子母账户万能划转 (适用主账户)响应
POST /sapi/v1/sub-account/universalTransfer (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
fromEmail | STRING | NO | |
toEmail | STRING | NO | |
fromAccountType | STRING | YES | "SPOT","USDT_FUTURE","COIN_FUTURE" |
toAccountType | STRING | YES | "SPOT","USDT_FUTURE","COIN_FUTURE" |
clientTranId | STRING | NO | 不可重复 |
asset | STRING | YES | |
amount | DECIMAL | YES | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 需要开启母账户apikey“允许子母账户划转”权限。
- 若 fromEmail 未传,默认从母账户转出。
- 若 toEmail 未传,默认转入母账户。
- 该划转接口不支持合约账户间直接划转。
#
查询子母账户万能划转历史 (适用主账户)响应
GET /sapi/v1/sub-account/universalTransfer (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
fromEmail | STRING | NO | |
toEmail | STRING | NO | |
clientTranId | STRING | NO | |
startTime | LONG | NO | |
endTime | LONG | NO | |
page | INT | NO | 默认 1 |
limit | INT | NO | 默认 500, 最大 500 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
- 本查询接口只可以单边查询,fromEmail 和 toEmail 不能同时传入。
- 若 fromEmail 和 toEmail 都未传,默认返回 fromEmail 为母账户的划转记录。
- 只可查询最近30天的记录。
##查询子账户Futures账户详情V2 (适用主账户)
响应
USDT Margined Futures:
COIN Margined Futures:
GET /sapi/v2/sub-account/futures/account (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
futuresType | INT | YES | 1:USDT Margined Futures, 2:COIN Margined Futures |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
##查询子账户Futures账户汇总V2 (适用主账户)
响应
USDT Margined Futures:
COIN Margined Futures:
GET /sapi/v2/sub-account/futures/accountSummary (HMAC SHA256)
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
futuresType | INT | YES | 1:USDT Margined Futures, 2:COIN Margined Futures |
page | INT | NO | default:1 |
limit | INT | NO | default:10, max:20 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
##查询子账户合约持仓信息V2 (仅适用主账户)
响应
USDT Margined Futures:
COIN Margined Futures:
GET /sapi/v2/sub-account/futures/positionRisk (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | 子账户邮箱 备注 | |
futuresType | INT | YES | 1:USDT Margined Futures, 2:COIN Margined Futures |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
为子账户开通杠杆代币 (适用母账户)响应
POST /sapi/v1/sub-account/blvt/enable (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | Sub-account email | |
enableBlvt | BOOLEAN | YES | Only true for now |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
为子账户API Key开启/关闭IP白名单 (适用母账户)响应:
POST /sapi/v1/sub-account/subAccountApi/ipRestriction (HMAC SHA256)
权重(UID): 3000
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | Sub-account email | |
subAccountApiKey | STRING | YES | |
ipRestrict | BOOLEAN | YES | true or false |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
为子账户API Key添加IP白名单 (适用母账户)响应:
POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList (HMAC SHA256)
您需要确保已经使用这个接口POST /sapi/v1/sub-account/subAccountApi/ipRestriction
开启了ip白名单功能,才可添加ip地址
权重(UID): 3000
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | Sub-account email | |
subAccountApiKey | STRING | YES | |
ipAddress | STRING | YES | 可批量添加,用逗号分隔。单API Key最多可添加30个 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
查询子账户API Key IP白名单 (适用母账户)响应:
GET /sapi/v1/sub-account/subAccountApi/ipRestriction (HMAC SHA256)
权重(UID): 3000
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | Sub-account email | |
subAccountApiKey | STRING | YES | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
删除子账户API Key IP白名单 (适用母账户)响应:
DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList (HMAC SHA256)
权重(UID): 3000
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | Sub-account email | |
subAccountApiKey | STRING | YES | |
ipAddress | STRING | YES | 可批量删除,用逗号分隔 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
投资人账户为托管子账户充值资产 (适用投资人母账户)响应
POST /sapi/v1/managed-subaccount/deposit (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
toEmail | STRING | YES | |
asset | STRING | YES | |
amount | DECIMAL | YES | |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
投资人账户查询托管子账户资产 (适用投资人母账户)响应
GET /sapi/v1/managed-subaccount/asset (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
STRING | YES | ||
recvWindow | LONG | NO | |
timestamp | LONG | YES |
#
投资人账户为托管子账户提币资产 (适用投资人母账户)响应
POST /sapi/v1/managed-subaccount/withdraw (HMAC SHA256)
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
fromEmail | STRING | YES | |
asset | STRING | YES | |
amount | DECIMAL | YES | |
transferDate | LONG | NO | 提币会自动发生在选择的日期(UTC0),如果没有选择日期,提币会立即生效 |
recvWindow | LONG | NO | |
timestamp | LONG | YES |
行情接口
#
测试服务器连通性响应
GET /api/v3/ping
测试能否联通 Rest API。
权重(IP): 1
参数:
NONE
数据源: 缓存
#
获取服务器时间响应
GET /api/v3/time
测试能否联通 Rest API 并 获取服务器时间。
权重(IP): 1
参数:
NONE
数据源: 缓存
#
交易规范信息响应
GET /api/v3/exchangeInfo
获取交易规则和交易对信息。
权重(IP): 10
参数:
有三种用法
用法 | 举例 |
---|---|
不需要交易对 | curl -X GET "https://api.binance.com/api/v3/exchangeInfo" |
单个交易对 | curl -X GET "https://api.binance.com/api/v3/exchangeInfo?symbol=BNBBTC" |
多个交易对 | curl -X GET "https://api.binance.com/api/v3/exchangeInfo?symbols=%5B%22BNBBTC%22,%22BTCUSDT%22%5D" or curl -g GET 'https://api.binance.com/api/v3/exchangeInfo?symbols=["BTCUSDT","BNBBTC"]' |
数据源: 缓存
#
深度信息响应
GET /api/v3/depth
权重(IP):
基于限制调整:
限制 | 权重 |
---|---|
5, 10, 20, 50, 100 | 1 |
500 | 5 |
1000 | 10 |
5000 | 50 |
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
limit | INT | NO | 默认 100; 最大 5000. 可选值:[5, 10, 20, 50, 100, 500, 1000, 5000] |
数据源: 缓存
#
近期成交列表响应
GET /api/v3/trades
获取近期成交
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
limit | INT | NO | 默认 500; 最大值 1000. |
数据源: 缓存
#
查询历史成交 (MARKET_DATA)响应
GET /api/v3/historicalTrades
获取历史成交。
权重(IP): 5
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
limit | INT | NO | 默认 500; 最大值 1000. |
fromId | LONG | NO | 从哪一条成交id开始返回. 缺省返回最近的成交记录。 |
数据源: 数据库
#
近期成交(归集)响应
GET /api/v3/aggTrades
归集交易与逐笔交易的区别在于,同一价格、同一方向、同一时间的trade会被聚合为一条
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
fromId | LONG | NO | 从包含fromId的成交id开始返回结果 |
startTime | LONG | NO | 从该时刻之后的成交记录开始返回结果 |
endTime | LONG | NO | 返回该时刻为止的成交记录 |
limit | INT | NO | 默认 500; 最大 1000. |
- 如果发送startTime和endTime,间隔必须小于一小时。
- 如果没有发送任何筛选参数(fromId, startTime,endTime),默认返回最近的成交记录
数据源: 数据库
#
K线数据响应
GET /api/v3/klines
每根K线代表一个交易对。
每根K线的开盘时间可视为唯一ID
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
interval | ENUM | YES | 详见枚举定义:K线间隔 |
startTime | LONG | NO | |
endTime | LONG | NO | |
limit | INT | NO | 默认 500; 最大 1000. |
- 如果未发送 startTime 和 endTime ,默认返回最近的交易。
数据源: 数据库
#
当前平均价格响应
GET /api/v3/avgPrice
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES |
数据源: 缓存
#
24hr 价格变动情况响应
OR
GET /api/v3/ticker/24hr
24 小时滚动窗口价格变动数据。 请注意,不携带symbol参数会返回全部交易对数据,不仅数据庞大,而且权重极高
权重(IP):
1 单一交易对;
40 交易对参数缺失;
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | NO |
- 请注意,不携带symbol参数会返回全部交易对数据
数据源: 缓存
#
最新价格响应
OR
GET /api/v3/ticker/price
获取交易对最新价格
权重(IP):
1 单一交易对;
2 交易对参数缺失;
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | NO |
- 不发送交易对参数,则会返回所有交易对信息
数据源: 缓存
#
当前最优挂单响应
OR
GET /api/v3/ticker/bookTicker
返回当前最优的挂单(最高买单,最低卖单)
权重(IP):
1 单一交易对;
2 交易对参数缺失;
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | NO |
- 不发送交易对参数,则会返回所有交易对信息
数据源: 缓存
Websocket 行情推送
- 本篇所列出的所有wss接口的baseurl为: wss://stream.binance.com:9443
- Streams有单一原始 stream 或组合 stream
- 单一原始 streams 格式为 /ws/\<streamName>
- 组合streams的URL格式为 /stream?streams=\<streamName1>/\<streamName2>/\<streamName3>
- 订阅组合streams时,事件payload会以这样的格式封装: {"stream":"\<streamName>","data":\<rawPayload>}
- stream名称中所有交易对均为 小写
- 每个到 stream.binance.com 的链接有效期不超过24小时,请妥善处理断线重连。
- 每3分钟,服务端会发送ping帧,客户端应当在10分钟内回复pong帧,否则服务端会主动断开链接。允许客户端发送不成对的pong帧(即客户端可以以高于10分钟每次的频率发送pong帧保持链接)。
#
实时订阅/取消数据流- 以下数据可以通过websocket发送以实现订阅或取消订阅数据流。示例如下。
- 响应内容中的
id
是无符号整数,作为往来信息的唯一标识。 - 如果相应内容中的
result
为null
,表示请求发送成功。
#
订阅一个信息流响应
请求
"method": "SUBSCRIBE",
"params":
[
"btcusdt@aggTrade",
"btcusdt@depth"
],
"id": 1
}
#
取消订阅一个信息流响应
请求
{
"method": "UNSUBSCRIBE",
"params":
[
"btcusdt@depth"
],
"id": 312
}
#
已订阅信息流响应
请求
{
"method": "LIST_SUBSCRIPTIONS",
"id": 3
}
#
设定属性当前,唯一可以设置的属性是设置是否启用combined
("组合")信息流。
当使用/ws/
("原始信息流")进行连接时,combined属性设置为false
,而使用 /stream/
进行连接时则将属性设置为true
。
响应
请求
{
"method": "SET_PROPERTY",
"params":
[
"combined",
true
],
"id": 5
}
#
检索属性响应
请求
{
"method": "GET_PROPERTY",
"params":
[
"combined"
],
"id": 2
}
###错误信息
错误信息 | 描述 |
---|---|
{"code": 0, "msg": "Unknown property"} | SET_PROPERTY 或 GET_PROPERTY 中应用的参数无效 |
{"code": 1, "msg": "Invalid value type: expected Boolean", "id": '%s'} | 仅接受true 或false |
{"code": 2, "msg": "Invalid request: property name must be a string"} | 提供的属性名无效 |
{"code": 2, "msg": "Invalid request: request ID must be an unsigned integer"} | 参数id 未提供或id 值是无效类型 |
{"code": 2, "msg": "Invalid request: unknown variant %s, expected one of SUBSCRIBE , UNSUBSCRIBE , LIST_SUBSCRIPTIONS , SET_PROPERTY , GET_PROPERTY at line 1 column 28"} | 错字提醒,或提供的值不是预期类型 |
{"code": 2, "msg": "Invalid request: too many parameters"} | 数据中提供了不必要参数 |
{"code": 2, "msg": "Invalid request: property name must be a string"} | 未提供属性名 |
{"code": 2, "msg": "Invalid request: missing field method at line 1 column 73"} | 数据未提供method |
{"code":3,"msg":"Invalid JSON: expected value at line %s column %s"} | JSON 语法有误. |
#
归集交易流Payload:
归集交易 stream 推送交易信息,是对单一订单的集合。
Stream 名称: <symbol>@aggTrade
Update Speed: 实时
#
逐笔交易Payload:
Stream Name: <symbol>@trade
逐笔交易推送每一笔成交的信息。成交,或者说交易的定义是仅有一个吃单者与一个挂单者相互交易
#
K线 StreamsPayload:
K线stream逐秒推送所请求的K线种类(最新一根K线)的更新。
Stream Name: <symbol>@kline_<interval>
Update Speed: 2000ms
K线图间隔参数:
m -> 分钟; h -> 小时; d -> 天; w -> 周; M -> 月
- 1m
- 3m
- 5m
- 15m
- 30m
- 1h
- 2h
- 4h
- 6h
- 8h
- 12h
- 1d
- 3d
- 1w
- 1M
#
按 Symbol 的精简TickerPayload:
按Symbol刷新的最近24小时精简ticker信息
Stream 名称: <symbol>@miniTicker
Update Speed: 1000ms
#
全市场所有Symbol的精简TickerPayload:
同上,只是推送所有交易对.需要注意的是,只有更新的ticker才会被推送.
Stream名称: !miniTicker@arr
Update Speed: 1000ms
#
按Symbol的完整TickerPayload:
每秒推送单个交易对的过去24小时滚动窗口标签统计信息。
Stream 名称: <symbol>@ticker
Update Speed: 1000ms
#
全市场所有交易对的完整TickerPayload:
Stream Name: !ticker@arr
Update Speed: 1000ms
推送全市场所有交易对刷新的24小时完整ticker信息。需要注意的是,没有更新的ticker不会被推送。
#
按Symbol的最优挂单信息Payload:
实时推送指定交易对最优挂单信息
Stream Name: <symbol>@bookTicker
Update Speed: 实时
#
全市场最优挂单信息Payload:
实时推送所有交易对最优挂单信息
Stream Name: !bookTicker
Update Speed: 实时
#
有限档深度信息Payload:
每秒或每100毫秒推送有限档深度信息。levels表示几档买卖单信息, 可选 5/10/20档
Stream Names: <symbol>@depth<levels>
或 <symbol>@depth<levels>@100ms
.
Update Speed: 1000ms 或 100ms
#
增量深度信息Payload:
每秒或每100毫秒推送orderbook的变化部分(如果有)
Stream Name: <symbol>@depth
或 <symbol>@depth@100ms
Update Speed: 1000ms 或 100ms
#
如何正确在本地维护一个orderbook副本- 订阅 wss://stream.binance.com:9443/ws/bnbbtc@depth
- 开始缓存收到的更新。同一个价位,后收到的更新覆盖前面的。
- 访问Rest接口 https://api.binance.com/api/v3/depth?symbol=BNBBTC&limit=1000 获得一个1000档的深度快照
- 将目前缓存到的信息中
u
<= 步骤3中获取到的快照中的lastUpdateId
的部分丢弃(丢弃更早的信息,已经过期)。 - 将深度快照中的内容更新到本地orderbook副本中,并从websocket接收到的第一个
U
<=lastUpdateId
+1 且u
>=lastUpdateId
+1 的event开始继续更新本地副本。 - 每一个新event的
U
应该恰好等于上一个event的u
+1,否则可能出现了丢包,请从step3重新进行初始化。 - 每一个event中的挂单量代表这个价格目前的挂单量绝对值,而不是相对变化。
- 如果某个价格对应的挂单量为0,表示该价位的挂单已经撤单或者被吃,应该移除这个价位。
现货账户和交易接口
#
测试下单 (TRADE)响应
POST /api/v3/order/test (HMAC SHA256)
用于测试订单请求,但不会提交到撮合引擎
权重: 1
参数:
同于 POST /api/v3/order
数据源: 缓存
#
下单 (TRADE)Response ACK:
Response RESULT:
Response FULL:
POST /api/v3/order (HMAC SHA256)
发送下单。
权重(UID): 1 权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
side | ENUM | YES | 详见枚举定义:订单方向 |
type | ENUM | YES | 详见枚举定义:订单类型 |
timeInForce | ENUM | NO | 详见枚举定义:有效方式 |
quantity | DECIMAL | NO | |
quoteOrderQty | DECIMAL | NO | |
price | DECIMAL | NO | |
newClientOrderId | STRING | NO | 客户自定义的唯一订单ID。 如果未发送,则自动生成 |
stopPrice | DECIMAL | NO | 仅 STOP_LOSS , STOP_LOSS_LIMIT , TAKE_PROFIT , 和TAKE_PROFIT_LIMIT 需要此参数。 |
icebergQty | DECIMAL | NO | 仅使用 LIMIT , STOP_LOSS_LIMIT , 和 TAKE_PROFIT_LIMIT 创建新的 iceberg 订单时需要此参数 |
newOrderRespType | ENUM | NO | 设置响应JSON。 ACK,RESULT或FULL; "MARKET"和" LIMIT"订单类型默认为"FULL",所有其他订单默认为"ACK"。 |
recvWindow | LONG | NO | 赋值不能大于 60000 |
timestamp | LONG | YES |
基于订单 type
不同,强制要求某些参数:
类型 | 强制要求的参数 |
---|---|
LIMIT | timeInForce , quantity , price |
MARKET | quantity or quoteOrderQty |
STOP_LOSS | quantity , stopPrice |
STOP_LOSS_LIMIT | timeInForce , quantity , price , stopPrice |
TAKE_PROFIT | quantity , stopPrice |
TAKE_PROFIT_LIMIT | timeInForce , quantity , price , stopPrice |
LIMIT_MAKER | quantity , price |
其他信息:
LIMIT_MAKER
是LIMIT
订单,如果它们立即匹配并成为吃单方将被拒绝。- 当触发
stopPrice
时,STOP_LOSS
和TAKE_PROFIT
将执行MARKET
订单。 - 任何
LIMIT
或LIMIT_MAKER
类型的订单都可以通过发送icebergQty
而成为iceberg
订单。 - 任何带有
icebergQty
的订单都必须将timeInForce
设置为GTC
。 - 使用
quantity
的市价单MARKET
明确的是用户想用市价单买入或卖出的数量。- 比如在
BTCUSDT
上下一个市价单,quantity
用户指明能够买进或者卖出多少BTC。
- 比如在
- 使用
quoteOrderQty
的市价单MARKET
明确的是通过买入(或卖出)想要花费(或获取)的报价资产数量; 此时的正确报单数量将会以市场流动性和quoteOrderQty
被计算出来。- 以
BTCUSDT
为例,quoteOrderQty=100
:
- 以
- 使用
quoteOrderQty
的市价单MARKET
不会突破LOT_SIZE
的限制规则; 报单会按给定的quoteOrderQty
尽可能接近地被执行。 - 除非之前的订单已经成交, 不然设置了相同的
newClientOrderId
订单会被拒绝。
MARKET版本和LIMIT版本针对市场价格触发订单价格规则:
- 价格高于市价:
止损``买入
,获利``卖出
- 价格低于市价:
止损``卖出
,获利``买入
关于 newOrderRespType的三种选择
- Response ACK: 返回速度最快,不包含成交信息,信息量最少
- Response RESULT:返回速度居中,返回吃单成交的少量信息
- Response FULL: 返回速度最慢,返回吃单成交的详细信息
数据源: 撮合引擎
#
撤销订单 (TRADE)响应
DELETE /api/v3/order (HMAC SHA256)
取消有效订单。
权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
orderId | LONG | NO | |
origClientOrderId | STRING | NO | |
newClientOrderId | STRING | NO | 用户自定义的本次撤销操作的ID(注意不是被撤销的订单的自定义ID)。如无指定会自动赋值。 |
recvWindow | LONG | NO | 赋值不得大于 60000 |
timestamp | LONG | YES |
orderId
或 origClientOrderId
必须至少发送一个
#
撤销单一交易对的所有挂单 (TRADE)Response:
DELETE /api/v3/openOrders
撤销单一交易对下所有挂单, 包括OCO的挂单。
权重(IP): 1
参数:
Name | Type | Mandatory | Description |
---|---|---|---|
symbol | STRING | YES | |
recvWindow | LONG | NO | 不能大于 60000 |
timestamp | LONG | YES |
数据源: 撮合引擎
#
查询订单 (USER_DATA)响应
GET /api/v3/order (HMAC SHA256)
查询订单状态。
权重(IP): 2
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
orderId | LONG | NO | |
origClientOrderId | STRING | NO | |
recvWindow | LONG | NO | 赋值不得大于 60000 |
timestamp | LONG | YES |
注意:
- 至少需要发送
orderId
与origClientOrderId
中的一个 - 某些订单中
cummulativeQuoteQty
<0,是由于这些订单是cummulativeQuoteQty功能上线之前的订单。
数据源: 数据库
#
当前挂单 (USER_DATA)响应
GET /api/v3/openOrders (HMAC SHA256)
获取交易对的所有当前挂单, 请小心使用不带交易对参数的调用。
权重(IP):
3 单一交易对;
40 交易对参数缺失;
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | NO | |
recvWindow | LONG | NO | 赋值不得大于 60000 |
timestamp | LONG | YES |
- 不带symbol参数,会返回所有交易对的挂单
数据源: 数据库
#
查询所有订单 (USER_DATA)响应
GET /api/v3/allOrders (HMAC SHA256)
获取所有帐户订单; 有效,已取消或已完成。
权重(IP): 10 带有symbol
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
orderId | LONG | NO | |
startTime | LONG | NO | |
endTime | LONG | NO | |
limit | INT | NO | 默认 500; 最大 1000. |
recvWindow | LONG | NO | 赋值不得大于 60000 |
timestamp | LONG | YES |
注意:
- 如设置
orderId
, 订单量将 >=orderId
。否则将返回最新订单。 - 一些历史订单
cummulativeQuoteQty
< 0, 是指数据此时不存在。 - 如果设置
startTime
和endTime
,orderId
就不需要设置。
数据源: 数据库
#
OCO下单(TRADE)响应
POST /api/v3/order/oco (HMAC SHA256)
发送新 OCO 订单。
权重(UID): 2 权重(IP): 1
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
listClientOrderId | STRING | NO | 整个orderList的唯一ID |
side | ENUM | YES | 详见枚举定义:订单方向 |
quantity | DECIMAL | YES | |
limitClientOrderId | STRING | NO | 限价单的唯一ID |
price | DECIMAL | YES | |
limitIcebergQty | DECIMAL | NO | |
stopClientOrderId | STRING | NO | 止损/止损限价单的唯一ID |
stopPrice | DECIMAL | YES | |
stopLimitPrice | DECIMAL | NO | 如果提供,须配合提交stopLimitTimeInForce |
stopIcebergQty | DECIMAL | NO | |
stopLimitTimeInForce | ENUM | NO | 有效值 GTC /FOK /IOC |
newOrderRespType | ENUM | NO | 详见枚举定义:订单返回类型 |
recvWindow | LONG | NO | 不能大于 60000 |
timestamp | LONG | YES |
其他信息:
- 价格限制:
SELL
: 限价 > 最新成交价 >触发价BUY
: 限价 < 最新成交价 < 触发价
- 数量限制:
- 两个 legs 必须具有同样的数量。
ICEBERG
数量不必相同
- 下单rate
- 一个
OCO
订单被算成2个普通订单.
- 一个
数据源: 撮合引擎
#
取消 OCO 订单(TRADE)Response:
DELETE /api/v3/orderList (HMAC SHA256)
取消整个订单列表。
权重(IP): 1
参数
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
orderListId | LONG | NO | orderListId 或 listClientOrderId 必须被提供 |
listClientOrderId | STRING | NO | orderListId 或 listClientOrderId 必须被提供 |
newClientOrderId | STRING | NO | 用户自定义的本次撤销操作的ID(注意不是被撤销的订单的自定义ID)。如无指定会自动赋值。 |
recvWindow | LONG | NO | 不能大于 60000 |
timestamp | LONG | YES |
其他注意点:
- 取消单个 leg 将取消整个 OCO 订单。
数据源: 撮合引擎
#
查询 OCO (USER_DATA)响应
GET /api/v3/orderList (HMAC SHA256)
根据提供的可选参数检索特定的OCO。
权重(IP): 2
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
orderListId | LONG | NO | orderListId 或 origClientOrderId 必须提供一个。 |
origClientOrderId | STRING | NO | orderListId 或 origClientOrderId 必须提供一个。 |
recvWindow | LONG | NO | 赋值不得大于 60000 |
timestamp | LONG | YES |
数据源: 数据库
#
查询所有 OCO (USER_DATA)响应
GET /api/v3/allOrderList (HMAC SHA256)
根据提供的可选参数检索所有的OCO。
权重(IP): 10
参数
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
fromId | LONG | NO | 提供该项后, startTime 和 endTime 都不可提供 |
startTime | LONG | NO | |
endTime | LONG | NO | |
limit | INT | NO | 默认值: 500; 最大值: 1000 |
recvWindow | LONG | NO | 赋值不能超过 60000 |
timestamp | LONG | YES |
数据源: 数据库
#
查询 OCO 挂单 (USER_DATA)响应
GET /api/v3/openOrderList (HMAC SHA256)
权重(IP): 3
参数
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | 赋值不能大于 60000 |
timestamp | LONG | YES |
数据源: 数据库
#
账户信息 (USER_DATA)响应
GET /api/v3/account (HMAC SHA256)
获取当前账户信息。
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | 赋值不能大于 60000 |
timestamp | LONG | YES |
数据源: 缓存 => 数据库
#
账户成交历史 (USER_DATA)响应
GET /api/v3/myTrades (HMAC SHA256)
获取账户指定交易对的成交历史
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES | |
orderId | LONG | NO | 必须要和参数symbol 一起使用. |
startTime | LONG | NO | |
endTime | LONG | NO | |
fromId | LONG | NO | 起始Trade id。 默认获取最新交易。 |
limit | INT | NO | 默认 500; 最大 1000. |
recvWindow | LONG | NO | 赋值不能超过 60000 |
timestamp | LONG | YES |
注意:
- 如果设定
fromId
, 获取订单 >=fromId
. 否则返回最近订单。
数据源: 数据库
#
查询目前下单数 (TRADE)响应
GET /api/v3/rateLimit/order
获取用户在当前时间区间内的下单总数。
权重(IP): 20
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
recvWindow | LONG | NO | 赋值不得大于 60000 |
timestamp | LONG | YES |
数据源: 缓存
杠杆账户和交易接口
#
全仓杠杆账户划转 (MARGIN)响应
POST /sapi/v1/margin/transfer (HMAC SHA256)
执行现货账户与全仓杠杆账户之间的划转
权重(IP): 600
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | YES | 被划转的资产, 比如, BTC |
amount | DECIMAL | YES | 划转数量 |
type | INT | YES | 1: 主账户向全仓杠杆账户划转 2: 全仓杠杆账户向主账户划转 |
recvWindow | LONG | NO | 赋值不能大于 60000 |
timestamp | LONG | YES |
#
杠杆账户借贷 (MARGIN)响应
POST /sapi/v1/margin/loan (HMAC SHA256)
申请借贷。
权重(UID): 3000
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | YES | |
isIsolated | STRING | NO | 是否逐仓杠杆,"TRUE", "FALSE", 默认 "FALSE" |
symbol | STRING | NO | 逐仓交易对,配合逐仓使用 |
amount | DECIMAL | YES | |
recvWindow | LONG | NO | 赋值不能超过 60000 |
timestamp | LONG | YES |
- 如果 isIsolated = “TRUE”, 表示逐仓借贷,此时 symbol 必填
- 如果isIsolated = “FALSE” 表示全仓借贷
#
杠杆账户归还借贷 (MARGIN)响应
POST /sapi/v1/margin/repay (HMAC SHA256)
获取杠杆账户归还借贷。
权重(UID): 3000
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | YES | |
isIsolated | STRING | NO | 是否逐仓杠杆,"TRUE", "FALSE", 默认 "FALSE" |
symbol | STRING | NO | 逐仓交易对,配合逐仓使用 |
amount | DECIMAL | YES | |
recvWindow | LONG | NO | 赋值不能超过 60000 |
timestamp | LONG | YES |
- 如果 isIsolated = “TRUE”, 表示逐仓还款,此时 symbol 必填
- 如果isIsolated = “FALSE” 表示全仓还款
#
查询杠杆资产 (MARKET_DATA)响应
GET /sapi/v1/margin/asset
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
asset | STRING | YES |
#
查询全仓杠杆交易对 (MARKET_DATA)响应
GET /sapi/v1/margin/pair
权重(IP): 10
参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
symbol | STRING | YES |
#
获取所有杠杆资产信息 (MARKET_DATA)响应
GET /sapi/v1/margin/allAssets
权重(IP): 1
参数:
None
#
获取所有全仓杠杆交易对(MARKET_DATA)响应