Skip to main content

更新日志

**2023-05-26**

注意: 所有更改都将逐步推出到我们的所有服务器,并可能需要一周时间才能完成。


**2023-05-24**
  • 以前的市场数据 URL 已不建议使用。请立即更新您的代码,以防止来自我们的服务被中断。
    • 来自 data.binance.com 的 API 市场数据现在可以从 data-api.binance.vision 访问。
    • 来自 data-stream.binance.com 的 Websocket 市场数据现在可以从 data-stream.binance.vision 访问。
  • 新增经典统一账户接口:
    • POST /sapi/v1/portfolio/auto-collection:账户资金归集
    • POST /sapi/v1/portfolio/bnb-transfer:统一账户BNB划转
  • GET /sapi/v1/portfolio/interest-rate已被停用,用户可用GET /sapi/v1/margin/interestRateHistory获取利率信息。

**2023-05-18**
  • 新增钱包接口:
    • POST /sapi/v1/capital/deposit/credit-apply:申请充值到过期地址的一键上账

**2023-05-09**
  • 新增统一账户接口:
    • GET /sapi/v1/portfolio/asset-index-price:查询统一账户资产价格指数
  • 更新钱包接口:
    • POST /sapi/v1/asset/transfer:增加枚举类型MAIN_PORTFOLIO_MARGINPORTFOLIO_MARGIN_MAIN

**2023-04-20**
  • 新增子母账户接口:
    • GET /sapi/v1/managed-subaccount/deposit/address:支持获取投资人之托管子账户充值地址
  • 更新VIP借币接口:
    • GET /sapi/v1/loan/vip/ongoing/orders:增加字段totalCollateralValueAfterHaircutlockedCollateralValue

**2023-04-18**
  • 新增现货策略交易接口:
    • POST /sapi/v1/algo/spot/newOrderTwap 以支持现货策略下单
    • DELETE /sapi/v1/algo/spot/order 以支持现货策略委托撤单
    • GET /sapi/v1/algo/spot/openOrders 以支持查询现货策略当前委托
    • GET /sapi/v1/algo/spot/historicalOrders 以支持查询现货策略历史订单
    • GET /sapi/v1/algo/spot/subOrders 以支持查询现货策略子订单

**2023-03-23**
  • 更新子母账户接口:
    • GET /sapi/v1/managed-subaccount/queryTransLogForInvestor: 响应出参增加字段tranId
    • GET /sapi/v1/managed-subaccount/queryTransLogForTradeParent: 响应出参增加字段tranId
  • 添加子母账户接口:
    • GET /sapi/v1/managed-subaccount/info: 查询托管子账户列表
    • GET /sapi/v1/sub-account/transaction-statistics: 查询子账户交易量统计列表

**2023-03-13**

注意: 所有更改都将逐步推出到我们的所有服务器,并可能需要一周时间才能完成。

  • 某些问题的错误消息已经改进,以便更轻松地进行解决。
情况之前的错误消息新错误消息
由于交易权限被禁用,账户无法下订单或取消订单。This action is disabled on this account.This account may not place or cancel orders.
当配置在交易对上的权限与账户上的权限不匹配时。This symbol is not permitted for this account.
当账户在其没有权限的交易对上下订单时。This symbol is restricted for this account.
symbol 不在 TRADING 时下订单。Unsupported order combination.This order type is not possible in this trading phase.
在不支持 IOCFOK 的交易阶段上使用 timeinForce = IOCFOK 下订单时。Limit orders require GTC for this phase.
  • 更正了查询归档订单的错误消息:

    • 之前,如果查询了一个归档订单(即状态为 CANCELEDEXPIREDexecutedQty == 0 而且最后的更新在 90 天以前),错误消息将是:
      • {"code": -2013,"msg": "Order does not exist."}
    • 现在,错误消息为:
      • {"code": -2026,"msg": "Order was canceled or expired with no executed qty over 90 days ago and has been archived."}
  • API 请求使用 startTimeendTime 的行为:

    • 之前,如果 startTime == endTime,一些请求会失败。
    • 现在,所有接受 startTimeendTime 的 API 请求会允许这些参数相等。这适用于以下接口:
      • Rest API
        • GET /api/v3/aggTrades
        • GET /api/v3/klines
        • GET /api/v3/allOrderList
        • GET /api/v3/allOrders
        • GET /api/v3/myTrades
      • Websocket API
        • trades.aggregate
        • klines
        • allOrderList
        • allOrders
        • myTrades
  • 如果用户的IP地址因违反 IP 速率限制(状态码为 418)而被禁止,那么连接到 WebSocket API 的用户将被断开连接。

虽然以下更改将在发布日期后 大约一周内生效,但是与其相关的文档已经被更改了:

  • 过滤器评估的更改:
    • 之前的行为: LOT_SIZEMARKET_LOT_SIZE 要求 (quantity - minQty) % stepSize == 0.
    • 新行为: 现在已更改为 (quantity % stepSize) == 0。
  • 使用 quoteOrderQtyMARKET 订单的错误修复:
    • 之前的行为: 订单的状态将始终为 FILLED,即使订单没有完全成交。
    • 新行为: 如果订单由于流动性不足而没有完全成交,则订单状态将为 EXPIRED,仅当订单完全成交时状态为 FILLED

现货 API

  • DELETE /api/v3/orderPOST /api/v3/order/cancelReplace 的更改:
    • 新的可选参数 cancelRestrictions,该参数用于决定是否能成功取消状态为 NEWPARTIALLY_FILLED的订单。
    • 如果由于 cancelRestrictions 而取消订单失败,错误将是:
      • {"code": -2011,"msg": "Order was not canceled due to cancel restrictions."}

**2023-02-27**
  • 新增杠杆接口:
    • /sapi/v1/margin/next-hourly-interest-rate: 查询用户币种预估下小时利率
  • 新增统一账户接口:
    • GET /sapi/v1/portfolio/interest-history: 查询统一账户期货负余额收息历史
    • GET /sapi/v1/portfolio/interest-rate: 查询统一账户期货负余额利率水平

**2023-02-21**
  • 修改质押借币接口:
    • POST /sapi/v1/loan/borrow: 参数loanTerm仅可传7或30

**2023-02-17**

WebSocket频率限制变动

Websocket Stream 现在限制每个IP地址、每5分钟可以发送连接请求的上限是300次。


**2023-02-13**
  • 添加子母账户接口:
    • GET /sapi/v4/sub-account/assets: 查询子账户资产

**2023-02-02**
  • 添加杠杆接口:
    • GET /sapi/v1/margin/exchange-small-liability: 查询可小额负债转换的资产
    • POST /sapi/v1/margin/exchange-small-liability: 全仓杠杆小额负债转换
    • GET /sapi/v1/margin/exchange-small-liability-history: 查询全仓杠杆小额负债转换历史
  • 更新钱包接口:
    • 万能划转POST /sapi/v1/asset/transfer支持期权

**2023-01-26**

根据此公告,Self-Trade Prevention 将在 2023-01-26 08:00 UTC 发布。


**2023-01-23**
**2023-01-23**

实际发布日期待定

新功能:Self-Trade Prevention(STP)会添加到系统中。此功能将阻止订单与来自同一账户或者同一 tradeGroupId 账户的订单交易。

请使用现货 REST API 的 GET /api/v3/exchangeInfo 或 Websocket API 的 exchangeInfo 看 STP 的状态。

现货 API

"defaultSelfTradePreventionMode": "NONE",   // selfTradePreventionMode 的默认值"allowedSelfTradePreventionModes": [        // selfTradePrevention 的可用模式    "NONE",    "EXPIRE_TAKER",    "EXPIRE_BOTH",    "EXPIRE_MAKER"]
  • 新的订单状态:EXPIRED_IN_MATCH - 订单由于 STP 触发而过期。
  • 新的接口:
    • GET /api/v3/myPreventedMatches - 获取由于 STP 触发而过期的订单。
  • 新的可选参数 selfTradePreventionMode 已添加到以下的接口:
    • POST /api/v3/order
    • POST /api/v3/order/oco
    • POST /api/v3/cancelReplace
  • 如果有预防自我交易(Prevented Match),所有下单相关的接口会出现新字段:
    • tradeGroupId - 仅当账户配置为 tradeGroupId 时才会出现。
    • preventedQuantity - 被防止交易的订单数量。
    • preventedMatches 数组会有以下的字段:
      • preventedMatchId
      • makerOrderId
      • price
      • takerPreventedQuantity - 仅当 selfTradePreventionMode 设置为 EXPIRE_TAKEREXPIRE_BOTH 时才会出现。
      • makerPreventedQuantity - 仅当 selfTradePreventionMode 设置为 EXPIRE_MAKEREXPIRE_BOTH 时才会出现。
  • 如果订单因 STP 触发而过期,以下查询订单接口的响应中可以出现新的字段 preventedMatchIdpreventedQuantity
    • GET /api/v3/order
    • GET /api/v3/openOrders
    • GET /api/v3/allOrders

Websocket 账户信息推送

  • 新的执行类型:TRADE_PREVENTION
  • executionReport 的新字段(这些字段只会在订单因 STP 触发而过期时出现):
    • u - tradeGroupId
    • v - preventedMatchId
    • U - counterOrderId
    • A - preventedQuantity
    • B - lastPreventedQuantity

**2023-01-13**
  • 以下接口将于1月 13, 2023 6:00 AM UTC停止使用:
    • POST /sapi/v1/sub-account/subAccountApi/ipRestriction 以支持母账户为子账户API Key开启或关闭IP白名单
    • POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList 以支持母账户为子账户API Key添加IP白名单地址列表
  • 添加子母账户接口:
    • GET /sapi/v1/managed-subaccount/fetch-future-asset: Investor can use this api to query managed sub account futures asset details
    • GET /sapi/v1/managed-subaccount/marginAsset: Investor can use this api to query managed sub account margin asset details
  • 添加杠杆账户接口:
    • GET /sapi/v1/margin/crossMarginCollateralRatio: 获取全仓币种质押率信息

**2023-01-05**
  • 添加子母账户接口:
    • GET /sapi/v1/managed-subaccount/queryTransLogForInvestor: 投资人可以根据此接口查询其托管子账户划转记录
    • GET /sapi/v1/managed-subaccount/queryTransLogForTradeParent: 交易团队可以根据此接口查询其托管子账户划转记录

**2022-12-26**
  • 添加钱包接口:
    • GET /sapi/v1/capital/contract/convertible-coins: 查询用户充值/提现时候稳定币与 BUSD 互转的设置
    • POST /sapi/v1/capital/contract/convertible-coins: 修改哪些稳定币可与 BUSD 互相转换

**2022-12-15**
  • 添加新的RSA签名验证方式
    • 添加了有关于如何创建 RSA keys 的信息。
    • 出于安全原因,我们建议在生成 API key 时使用 RSA keys。
    • 我们接受 PKCS#8(BEGIN PUBLIC KEY)。
    • 稍后将添加有关如何上传 RSA public key 的更多详细信息。

**2022-12-13**

REST API

错误代码 -1003 的一些错误消息改动:

  • 之前的错误消息:

Too much request weight used; current limit is %s request weight per %s %s. Please use the websocket for live updates to avoid polling the API.

改成了:

Too much request weight used; current limit is %s request weight per %s. Please use WebSocket Streams for live updates to avoid polling the API.

  • 之前的错误消息:

Way too much request weight used; IP banned until %s. Please use the websocket for live updates to avoid bans.

改成了:

Way too much request weight used; IP banned until %s Please use WebSocket Streams for live updates to avoid bans.


**2022-12-05**

备注: 这些更新正在逐步部署到我们所有的服务器,大约需要一周时间才能完成。

WEBSOCKET

  • !bookTicker2022-12-07 下线。 请改用按 symbol 的最优挂单信息的数据流(<symbol>@bookTicker)。
    • 可以通过一个连接订阅多个 <symbol>@bookTicker 数据流。 (例如wss://stream.binance.com:9443/stream?streams=btcusdt@bookTicker/bnbbtc@bookTicker

REST API

  • 新的错误代码 -1135

    • 如果参数是无效的 JSON 格式,则会出现此错误代码。
  • 新的错误代码 -1108

    • 如果发送的参数的值太长,可能会导致溢出,则会发生此错误。
    • 此错误代码可能出现在以下接口:
      • POST /api/v3/order
      • POST /api/v3/order/cancelReplace
      • POST /api/v3/order/oco
  • GET /api/v3/aggTrades 更新

    • 之前的规则: startTimeendTime 必须结合使用,并且只能相隔一个小时。
    • 新的规则: startTimeendTime 可以单独使用,一个小时的限制已被取消。
      • 仅使用 startTime 时,如果limit的值为N, 将返回从此时间开始的N条交易。
      • 仅使用 endTime 时,如果limit的值为N, 将返回到此时间的N条交易。
      • 如果不提供 limit,无论是组合使用还是单独发送,服务器端点都将使用默认的 limit
  • GET /api/v3/myTrades 更新

    • 修复了在不提供 limit 时, symbol + orderId 组合可以返回交易数量超过 limit 默认值500条的错误

    • 之前的行为: API 将根据发送的参数组合发送特定的错误消息。 例如:

      { "code": -1106, "msg": "Parameter X was sent when not required." }

    • 新的行为: 如果接口不支持可选参数组合,那么服务器会返回一般性的错误:

      { "code": -1128, "msg": "Combination of optional parameters invalid." }

    • 添加一个新的参数组合: symbol + orderId + fromId.

    • 下面的参数组合不再支持:

      • symbol + fromId + startTime
      • symbol + fromId + endTime
      • symbol + fromId + startTime + endTime
    • 当前支持的所有参数组合:

      • symbol
      • symbol + orderId
      • symbol + startTime
      • symbol + endTime
      • symbol + fromId
      • symbol + startTime + endTime
      • symbol+ orderId + fromId

备注: 这些新字段将在发布日期后大约一周出现。

  • GET /api/v3/exchangeInfo 更新
    • 新字段 defaultSelfTradePreventionModeallowedSelfTradePreventionModes
  • 下单,查询订单和撤销订单接口的更新:
    • 响应中会出现新的字段 selfTradePreventionMode
    • 以下接口会受到影响:
      • POST /api/v3/order
      • POST /api/v3/order/oco
      • POST /api/v3/order/cancelReplace
      • GET /api/v3/order
      • DELETE /api/v3/order
      • DELETE /api/v3/orderList
  • GET /api/v3/account 更新
    • 响应中会出现新的字段 requireSelfTradePrevention.
  • 以下接口的响应中会出现新字段 workingTime(指示订单何时添加到了订单薄):
    • POST /api/v3/order
    • GET /api/v3/order
    • POST /api/v3/order/cancelReplace
    • POST /api/v3/order/oco
    • GET /api/v3/order
    • GET /api/v3/openOrders
    • GET /api/v3/allOrders
  • 如果trailingDelta作为参数提供给了TAKE_PROFITTAKE_PROFIT_LIMITSTOP_LOSSSTOP_LOSS_LIMIT的订单,那么下面接口中会出现trailingTime, 用来表示追踪单被激活和跟踪价格变化的时间:
    • POST /api/v3/order
    • GET /api/v3/order
    • GET /api/v3/openOrders
    • GET /api/v3/allOrders
    • POST /api/v3/order/cancelReplace
    • DELETE /api/v3/order
  • 字段 commissionRates 会在 GET /api/v3/acccount 的响应中出现。

USER DATA STREAM

  • eventType executionReport 有新的字段
    • V - selfTradePreventionMode
    • D - trailing_time (追踪单被激活会出现)
    • W - workingTime (如果 isWorking=true 会出现)

**2022-12-02**
  • 新增一个用于访问市场信息的RESTful API URL: https://data.binance.com.
  • 新增一个用于访问市场信息的WebSocket URL: wss://data-stream.binance.com.

**2022-11-29**
  • 添加VIP借币接口:
    • GET /sapi/v1/loan/vip/collateral/account: 查询VIP子账户冻结抵押物金额

**2022-11-22**
  • 新增闪兑接口:
    • GET /sapi/v1/convert/exchangeInfo: 查询可交易的币对的信息,以及它们分别所支持交易金额的上下限。
    • GET /sapi/v1/convert/assetInfo: 查询每个可交易币种的精度信息。
    • POST /sapi/v1/convert/getQuote: 对所需的币对发送获取报价请求。
    • POST /sapi/v1/convert/acceptQuote: 通过 quote ID 来接受报价。
    • GET /sapi/v1/convert/orderStatus: 通过 order ID 来查询订单状态。

**2022-11-18**
  • 新增钱包接口:
    • GET /sapi/v1/asset/ledger-transfer/cloud-mining/queryByPage: 云算力支付和退款历史分页查询
  • 新增子母账户接口:
    • GET /sapi/v1/sub-account/apiRestrictions/ipRestriction/thirdPartyList: 取得子帳戶API key IP三方名單
    • POST /sapi/v2/sub-account/subAccountApi/ipRestriction: 为子账户API Key更新IP白名单

**2022-11-14**
  • 添加VIP借币接口:
    • GET /sapi/v1/loan/vip/ongoing/orders:查询VIP借币借款中订单
    • POST /sapi/v1/loan/vip/repay:VIP借币还款
    • GET /sapi/v1/loan/vip/repay/history:查询VIP借币还款记录历史

**2022-11-02**
  • 更新钱包接口:
    • POST /sapi/v1/capital/withdraw/apply: 权重改至 Weight(UID) 600。

**2022-11-01**
  • 添加质押借币接口:
    • GET /sapi/v1/loan/loanable/data: 获取可借币种的利率和借贷限额。借入限额以美元价值显示。
    • GET /sapi/v1/loan/collateral/data: 获取抵押币种质押率信息和质押限额。质押限额以美元价值显示。
    • GET /sapi/v1/loan/repay/collateral/rate: 获取抵押物还款时,抵押/借贷币种的汇率价格。汇率价格有效时间为8秒。
    • POST /sapi/v1/loan/customize/margin_call: 质押借币自定义补仓质押率,仅可针对进行中订单,自定义补仓质押率。

**2022-10-28**
  • 更新钱包接口:
    • POST /sapi/v1/asset/convert-transfer: 增加 accountType 参数
    • POST /sapi/v1/asset/convert-transfer/queryByPage: 改为 GET 请求方式,增加 clientTranId 参数

**2022-10-15**
  • 添加币安码接口:
    • POST /sapi/v1/giftcard/buyCode:用于购买一个币安码
    • GET /sapi/v1/giftcard/buyCode/token-limit:用来查看你所支付的数字货币,可以购买的面额与数量限制

**2022-09-30**
  • 删除合约混合保证金接口:
    • POST /sapi/v1/futures/loan/borrow
    • POST /sapi/v1/futures/loan/repay
    • GET /sapi/v1/futures/loan/configs
    • GET /sapi/v2/futures/loan/configs
    • GET /sapi/v1/futures/loan/calcAdjustLevel
    • GET /sapi/v2/futures/loan/calcAdjustLevel
    • GET /sapi/v1/futures/loan/calcMaxAdjustAmount
    • GET /sapi/v2/futures/loan/calcMaxAdjustAmount
    • POST /sapi/v1/futures/loan/adjustCollateral
    • POST /sapi/v2/futures/loan/adjustCollateral
    • GET /sapi/v1/futures/loan/collateralRepayLimit
    • GET /sapi/v1/futures/loan/collateralRepay
    • POST /sapi/v1/futures/loan/collateralRepay
    • GET /sapi/v1/futures/loan/collateralRepayResult

**2022-09-30**

!bookTicker的WebSocket推送的变更.

  • 全市场最优挂单信息推送(!bookTicker)计划在2022年11月下线, 具体下线的时间会在后面通告.
  • 请使用按Symbol的最优挂单信息推送(<symbol>@bookTicker).
  • 多个 <symbol>@bookTicker 可以订阅在一个WebSocket连接上.
    • 比如 wss://stream.binance.com:9443/stream?streams=btcusdt@bookTicker/bnbbtc@bookTicker

**2022-09-29**
  • 添加钱包接口:
    • POST /sapi/v1/asset/convert-transfer: 稳定币自动兑换划转
    • POST /sapi/v1/asset/convert-transfer/queryByPage: 稳定币自动兑换划转查询

**2022-09-22**
  • 更新子母账户接口:
    • POST /sapi/v1/sub-account/subAccountApi/ipRestriction:添加一个新的参数 thirdParty
    • POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList:添加一个新的参数 thirdPartyName
    • DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList:添加一个新的参数 thirdPartyName
  • 添加频次限制:
    • GET /sapi/v1/bswap/liquidity:每个账户每个池子最多每秒三次
    • GET /sapi/v1/bswap/quote:每个账户每个池子最多每秒三次
    • POST /sapi/v1/lending/daily/purchase:每个账户最多三秒一次
    • POST /sapi/v1/lending/customizedFixed/purchase:每个账户最多三秒一次
    • POST /sapi/v1/staking/purchase:每个账户最多三秒一次

**2022-09-16**
  • 添加杠杆账户接口:
    • GET /sapi/v1/margin/tradeCoeff:获取用户个人杠杆账户信息汇总

**2022-09-15**
  • 添加质押借币接口:
    • POST /sapi/v1/loan/borrow:借币 - 质押借币借贷
    • GET /sapi/v1/loan/borrow/history:借币 - 查询质押借币历史记录
    • GET/sapi/v1/loan/ongoing/orders:借币 - 查询借款中订单列表
    • POST/sapi/v1/loan/repay:还款 - 质押借币还款
    • GET/sapi/v1/loan/repay/history:还款 - 查询还款记录历史
    • POST/sapi/v1/loan/adjust/ltv:调整质押率 - 质押借币调整质押率
    • GET/sapi/v1/loan/ltv/adjustment/history:调整质押率 - 查询质押率调整历史

**2022-09-15**

这些变动会是滚动发布,可能需要几天才会部署到所有服务器.

  • 接口 GET /api/v3/exchangeInfo 的变动
    • 添加一个新的参数 permissions , 用于查询适用于相应权限的所有交易对.
    • 如果查询时不提供此参数, 则默认值是 ["SPOT","MARGIN","LEVERAGED"].
      • 这表示如果请求 GET /api/v3/exchangeInfo 时候没有任何参数, 则会返回拥有权限是 SPOT, MARGIN, LEVERAGED 的交易对.
      • 如果要查询其他交易权限, 比如TRD_GRP_004等, 需要在查询参数里设置(比如permissions=TRD_GRP_004).
    • 此参数不可以同时和 symbol 或者 symbols 使用.

**2022-09-12**
  • 更新子母账户接口:
    * `GET /sapi/v1/sub-account/subAccountApi/ipRestriction`:
    以支持母账户为子账户API Key查询三方IP白名单

**2022-09-05**
  • 删除期货接口:
    • GET /sapi/v1/futures/loan/wallet

**2022-08-23**

这些变动会是滚动发布,可能需要几天才会部署到所有服务器.

  • 接口 GET /api/v3/tickerGET /api/v3/ticker/24hr 变动
    • 添加新可选参数 type
    • type 可接受的参数值有 FULLMINI
      • FULL 是默认值, 也是原来接口所返回的响应
      • MINI 省略了以下字段: priceChangePercent, weightedAvgPrice, bidPrice, bidQty, askPrice, askQtylastQty
  • 添加新错误代码 -1008
    • 每当服务器的请求超载时都会发送此消息
    • 此错误代码只会在 SPOT API 里出现
  • 接口 GET /api/v3/account 添加新参数 brokered
  • 添加新接口: GET /api/v3/uiKlines
  • 添加新k线间隔: 1s

**2022-08-18**
  • 更新闪兑接口:
    • GET /sapi/v1/convert/tradeFlow: 权重自 Weight(IP) 3000改至 Weight(UID) 3000。

**2022-08-08**

REST API

  • 接口 POST /api/v3/orderPOST /api/v3/order/cancelReplace 变动
    • 添加新可选参数 strategyId 是用于将订单标识为某策略的参数。
    • 添加新可选参数 strategyType 是用于标识在执行的策略。(例如:如果所有订单属于现货网格策略,订单可设置为strategyType=1000000)
  • 接口 POST /api/v3/order/oco 变动
    • 添加新可选参数 limitStrategyId, limitStrategyType, stopStrategyId, stopStrategyType
    • 这些是OCO订单里两个leg的策略元数据
    • limitStrategyTypestopStrategyType 都不能低于 1000000
  • 接口 GET /api/v3/order, GET /api/v3/openOrdersGET /api/v3/allOrders 变动
    • 新增参数 strategyIdstrategyType 必须在下单时填上字段才会在回应JSON里返回
  • 接口 DELETE /api/v3/orderDELETE /api/v3/openOrders 变动
    • 新增参数 strategyIdstrategyType 必须在下单时填上字段才会在回应JSON里返回

USER DATA STREAM

  • eventType executionReport 新增参数
    • j 代表 strategyId
    • J 代表 strategyType
    • 必须在下单时填上字段才会在回应里返回

**2022-08-05**
  • 更新闪兑接口:
    • GET /sapi/v1/convert/tradeFlow: 权重自 Weight(IP) 100改至 Weight(IP) 3000。

**2022-07-21**
  • 添加新统一账户接口:
    • GET /sapi/v1/portfolio/pmLoan 查询统一账户穿仓借贷记录。
    • POST /sapi/v1/portfolio/repay 偿还统一账户穿仓负债。

**2022-07-18**
  • 添加新统一账户接口:
    • GET /sapi/v1/portfolio/collateralRate 获取统一账户资产质押率。

**2022-07-01**
  • 添加新钱包接口:
    • POST /sapi/v3/asset/getUserAsset 获取用户持仓。
  • 添加新杠杆账户接口:
    • GET /sapi/v1/margin/dribblet 查询用户杠杆账户小额资产转换BNB历史信息。
  • 更新闪兑接口:
    • GET /sapi/v1/convert/tradeFlow:权重自3000改至100。
  • 更新杠杆账户接口:
    • GET /sapi/v1/margin/repay: 响应出参增加字段rawAsset,表示原始币种。

**2022-06-20**

接口 GET /api/v3/ticker 变动

  • 权重从每symbol 5 降低到 2.
  • 每次请求最多可以有100个交易对.
    • 如果symbols请求超过100个交易对, 会收到如下错误信息:
    {     "code": -1101,     "msg": "Too many values sent for parameter 'symbols', maximum allowed up to 100."     }
  • 单请求的权重上限为100.
    • 比如,如果请求的交易对超过50个,请求的权重是100.

**2022-06-15**

注意: 此变动不会立刻可用, 会在后面几天上线。

SPOT API

  • 添加新接口 GET /api/v3/ticker
    • 基于 windowSize 返回最近的价格变动。
    • 无需像 GET /api/v3/ticker/24hr 提供symbols参数。
    • 如果不提供 windowSize 参数,默认值是1d
    • 响应和 GET /api/v3/ticker/24hr 相似,但不包括以下数据:prevClosePrice, lastQty, bidPrice, bidQty, askPrice, askQty
  • 添加新接口 POST /api/v3/order/cancelReplace
    • 撤消当前的挂单并在同样的交易对上下新订单。
    • 过滤器会在撤单前做判断。
      • 例如,MAX_NUM_ORDERS 是 10,如果目前挂单也是10,调用 POST /api/v3/order/cancelReplace会失败。撤单与下单的操作都不会被执行。
    • 更新将在几天后上线,升级完毕后才会开启此功能。
  • GET /api/v3/exchangeInfosymbols列表里返回新数据cancelReplaceAllowed
  • 添加新的过滤器 NOTIONAL
    • 基于minNotionalmaxNotional 值来限制名义价值 (price * quantity)
  • 添加新的过滤器 EXCHANGE_MAX_NUM_ICEBERG_ORDERS
    • 账号最大冰山挂单数

WEBSOCKETS

  • 新的symbol ticker流, 可以选择1h 或者 4h时间窗口:
    • 单个交易对: <symbol>@ticker_<window-size>
    • 市场所有交易对: !ticker_<window-size>@arr
**2022-06-02**
  • 更新子母账户接口:
    • GET /sapi/v1/sub-account/sub/transfer/history:fromEmail及toEmail可以是母账户email。

**2022-05-27**
  • 更新法币接口:
    • GET /sapi/v1/fiat/orders: 权重自 UID(3000) 改至 UID(90000)
  • 更新Pay接口:
    • GET /sapi/v1/pay/transactions:参数 名称改变: startTimestamp -> startTime; endTimestamp -> endTime

**2022-05-26**
  • 更新法币接口:
    • GET /sapi/v1/fiat/orders: 权重自 IP(1) 改至 UID(3000)
  • 更新杠杆账户接口: 查询时间范围最大不得超过30天:
    • 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

**2022-05-23**
  • Order Book 深度的变动

    • 之前深度的数量在一些极端情况下会出现负数.
    • 之后深度数量不会溢出, 而是限制在64位的最大值, 这表示深度的数量达到,或者超过了最大值. 最大值和交易对的base asset的精度有关. 比如如果精度是8位小数,最大值则为92,233,720,368.54775807.
    • 原有的深度价位, 在修复上线后, 需要价位上有变动, 才能体现新的修复.
  • 哪里有影响?

    • 现货深度接口
      • GET /api/v3/depth
    • Websocket Streams
      • <symbol>@depth
      • <symbol>@depth@100ms
      • <symbol>@depth<levels>
      • <symbol>@depth<levels>@100ms
  • MAX_POSITION 的更新

    • 如果一个订单的数量(quantity) 可能导致持有仓位溢出, 会触发过滤器 MAX_POSITION.
**2022-05-19**
  • 更新矿池接口參數:
    • GET /sapi/v1/mining/pub/algoListGET /sapi/v1/mining/pub/coinList:不需要参数
  • 新增统一帐户相关错误代码(21xxx): -21001, -21002, -21003

**2022-05-17**
  • GET api/v3/aggTrades 更新
    • 如果同时提供 startTimeendTime, 旧的记录会返回.
  • 如果接口 GET /api/v3/myTrades 中没有提供参数 symbol, 错误消息变为:
{"code": -1102,"msg": "Mandatory parameter 'symbol' was not sent, was empty/null, or malformed." }
  • 下面的接口提供参数 symbols 用于查询多个symbol.

    • GET /api/v3/ticker/24hr
    • GET /api/v3/ticker/price
    • GET /api/v3/ticker/bookTicker
  • 上面接口的权重取决于请求 symbols 的数量, 具体请看下面的列表:

接口Symbols的数量权重
GET /api/v3/ticker/priceAny2
GET /api/v3/ticker/bookTickerAny2
GET /api/v3/ticker/24hr1-201
GET /api/v3/ticker/24hr21-10020
GET /api/v3/ticker/24hr>= 10140
**2022-05-05**
  • 新增Binance Code接口:
    • GET /sapi/v1/giftcard/cryptography/rsa-public-key,以查询RSA public key。
  • 更新Binance Code接口:
    • POST /sapi/v1/giftcard/redeemCode: 新增参数 externalUid。每个外部用户 ID 代表合作伙伴平台上的某个用户。该功能帮助您识别不同用户的兑现行为。

**2022-04-28**
  • 新增Staking接口:
    • GET /sapi/v1/staking/productList 以查询Staking可锁仓产品列表
    • POST /sapi/v1/staking/purchase 以锁仓Staking产品
    • POST /sapi/v1/staking/redeem 以赎回Staking产品
    • GET /sapi/v1/staking/position 以查询Staking产品的持仓
    • GET /sapi/v1/staking/stakingRecord以查询锁仓产品的历史记录
    • POST /sapi/v1/staking/setAutoStaking 以设置Staking产品的自动续期
    • GET /sapi/v1/staking/personalLeftQuota 以查询个人锁仓限额

**2022-04-27**
  • 新增合约策略交易接口:
    • POST /sapi/v1/algo/futures/newOrderTwap 以支持合约Twap策略下单

FAQ: 时间加权平均价格策略(Twap) 介绍


**2022-04-26**
  • 新增接口 GET /sapi/v1/margin/rateLimit/order
    • 回传用户在当前时间区间内的杠杆账户下单总数

**2022-04-20**
  • 新增统一账户接口:
    • GET /sapi/v1/portfolio/account 以支持查询统一账户信息

FAQ: 币安合约统一账户总览

目前仅对特定用户开放此功能,详情:加入统一账户计划


**2022-04-19**
  • 更新币安宝接口:
    • 新增返回参数avgAnnualInterestRate tierAnnualInterestRate 于接口GET /sapi/v1/lending/daily/product/listGET /sapi/v1/lending/daily/token/position以支持查询阶梯利率

**2022-04-13**
  • 新增合约策略交易接口:
    • POST /sapi/v1/algo/futures/newOrderVp 以支持合约vp策略下单
    • DELETE /sapi/v1/algo/futures/order 以支持合约策略委托撤单
    • GET /sapi/v1/algo/futures/openOrders 以支持查询合约策略当前委托
    • GET /sapi/v1/algo/futures/historicalOrders 以支持查询合约策略历史订单
    • GET /sapi/v1/algo/futures/subOrders 以支持查询合约策略子订单

FAQ: 成交量份额参与算法(VP) 介绍


**2022-04-13**

支持追踪止损订单

REST API

  • 现货交易支持追踪止损(Trailing Stop)订单.
    • 追踪止损通过一个新的参数trailingDelta来设置基于市场价的一个自动触发价格.
    • 只适用于订单类型: STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT.
    • 参数trailingDelta的单位为基点(BIPS).
      • 比如一个STOP_LOSS卖单设置trailingDelta为100, 那么订单会在当前市场价格从下单后的最高点下降1%的时候被触发。(100 / 10,000 => 0.01 => 1%)
    • 用于OCO订单的时候, 如果市场变动触发了STOP_LOSS订单, 那么此止损订单变成追踪止损订单.
    • 当参数trailingDeltastopPrice一起使用时, 一旦stopPrice条件被触发,系统会开始追踪当前的价格变动. 从stopPrice价格开始,到基于trailingDelta值之间变动.
    • 如果没有提供stopPrice, 系统开始追踪价格从最新价到基于trailingDelta值之间变动.
  • POST /api/v3/order 变动
    • 添加新可选参数 trailingDelta
  • POST /api/v3/order/test 变动
    • 添加新可选参数 trailingDelta
  • POST /api/v3/order/oco 变动
    • 添加新可选参数 trailingDelta
  • 添加新的过滤器 TRAILING_DELTA
    • 用于限定 trailingDelta 的最大和最小值.

USER DATA STREAM

  • User Data Stream 的executionReport添加新参数
    • "d" 代表trailingDelta

**2022-04-12**

Note: 下面的变更会在后面几天上线.

  • GET api/v3/allOrders 如果没有提供 symbol, 则返回错误信息:
    { "code": -1102, "msg": "Mandatory parameter 'symbol' was not sent, was empty/null, or malformed."}
  • 修复一个错误信息中的拼写错误。 如果账号被禁用了相应的权限(比如提款,交易等), 则服务器返回错误:
    "This action is disabled on this account."
  • 在市场数据(market data)审计中,发现了一些现货的聚合交易数据(aggTrades)中的问题.
    • 丢失的记录已经被补回.
    • 重复的记录被标记成无效,具体的值设置成如下:
      • p = '0' // price
      • q = '0' // qty
      • f = -1 // first_trade_id
      • l = -1 // last_trade_id

**2022-04-08**
**2022-3-29**

以下更新于3月 31, 2022 08:00 AM UTC生效

  • 更新子母账户接口:
    • GET /sapi/v1/sub-account/universalTransfer

接口查询时间窗口缩短为30天;若startTimeendTime没传,则默认返回最近30天数据。


**2022-03-25**
  • 更新子母账户接口:
    • 新增接口 GET /sapi/v1/managed-subaccount/accountSnapshot以支持投资人母账户查询托管子账户资产快照

**2022-03-08**
  • 更新子母账户接口:
    • 新增划转类型MARGIN ,ISOLATED_MARGIN 以及传参symbol于子母账户万能划转接口POST /sapi/v1/sub-account/universalTransfer 以支持母账户现货账户划转到子账户杠杆全仓账户和杠杆逐仓账户

**2022-02-28**
  • 在接口GET /api/v3/exchangeInfo中添加新字段allowTrailingStop.

**2022-02-22****

现货API

  • 现货规则PRICE_FILTER里面的 (price-minPrice) % tickSize == 0 改成 price % tickSize == 0
  • 新添加了一个规则 PERCENT_PRICE_BY_SIDE.
  • 接口 GET api/v3/depth 的变动:
    • limit 原先必须是固定值(比如 5, 10, 20, 50, 100, 500, 1000, 5000), 现在可以是在1-5000之间的任意的正整数, 服务器会返回指定的limit数量。(比如如果设置limit=3, 会返回前3个最好的卖价和买价)
    • 如果limit超过5000, 服务器也最多返回5000条记录.
    • 相应的, 此接口的权重变成:
LimitRequest Weight
1-1001
101-5005
501-100010
1001-500050
  • GET api/v3/aggTrades 接口的变动:
    • 当同时提供参数 startTimeendTime, 最旧的订单会优先返回.

**2022-2-18**
  • 更新子母账户接口:
    • 新增响应参数 isManagedSubAccountisAssetManagementSubAccount 于接口 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_CMFUTUREand CMFUTURE_FUNDING 于用户万向划转接口 POST /sapi/v1/asset/transferGET /sapi/v1/asset/transfer 以支持资金账户和现货账户,杠杆全仓账户,U本位合约账户,币本位合约账户之间相互划转
    • 由于C2C账户,币安支付、币安卡等业务合并至资金账户,用户万向划转接口POST /sapi/v1/asset/transferGET /sapi/v1/asset/transfer 的以下划转类型MAIN_C2C,C2C_MAIN,C2C_UMFUTURE,C2C_MINING,UMFUTURE_C2C,MINING_C2C,MARGIN_C2C,C2C_MARGIN,MAIN_PAYPAY_MAIN 将于11月 04, 2021 08:00 AM UTC 停止使用

**2021-10-14**
  • 以下杠杆账户接口更新返回数据的时间范围,startTimeendTime时间跨度不能超过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`,`depositDust` 和 `specialWithdrawTips`于`GET /sapi/v1/capital/config/getall` 
    sameAddress 表示需要输入memo的币种 depositDust 表示最小可上帐金额 specialWithdrawTips 表示提现时的特殊说明
    * 新增响应内容 `confirmNo`于`GET /sapi/v1/capital/withdraw/history` 以支持查询提现确认数

**2021-08-27**
  • 更新钱包接口:
    • 新增参数 withdrawOrderIdGET /sapi/v1/capital/withdraw/history 以支持查询指定withdrawOrderId的提币历史记录
    • 新增响应内容 unlockConfirmGET /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_MARGINMARGIN_ISOLATEDMARGINISOLATEDMARGIN_ISOLATEDMARGIN 于接口 POST /sapi/v1/asset/transferGET /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

以上接口查询范围更改为:仅支持startTimeendTime查询最大间隔为30天,若startTimeendTime均未发送,则默认返回最近30天记录


**2021-07-29**
  • 子母账户接口更新:
    • GET /sapi/v1/sub-account/transfer/subUserHistory 如果startTimeendTime均未发送,默认只返回最近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 增加新参数 currentsize

**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/transferGET /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 权重改为 2
  • GET /api/v3/openOrders 权重改为 3
  • GET /api/v3/allOrders 权重改为 10
  • GET /api/v3/orderList 权重改为 2
  • GET /api/v3/openOrderList 权重改为 3
  • GET /api/v3/account 权重改为 10
  • GET /api/v3/myTrades 权重改为 10
  • GET /api/v3/exchangeInfo 权重改为 10

**2021-04-08**
  • 子母账户接口更新:
    • GET /sapi/v1/sub-account/futures/accountSummaryGET /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 新增返回字段 fromAccountTypetoAccountType为用户转出账户类型和转入账户类型

**2021-03-31**
  • 子母账户接口更新:
    • GET /wapi/v3/sub-account/transfer/history.html 新增参数 fromEmailtoEmail,原有参数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/transferGET /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(包括 symbolamountnotionalValue ),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 新增返回参数repayTypeNORMAL为混合保证金普通还款,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/borrowGET /sapi/v1/futures/loan/borrow/history 返回新字段 borrowId 为用户混合保证金借款唯一 ID。
    • POST /sapi/v1/futures/loan/repayGET /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-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 中替换 isSpotTradingAllowedisMarginTradingAllowed
    • 如果账户想在一个交易对下做交易, 账户和交易对必须同时拥有对应的权限。
  • 接口 GET api/v3/exchangeInfo 的更新
    • 添加新字段 permissions
    • 添加新字段 quoteAssetPrecision。此字段和 quotePrecision 重复。在未来的版本(v4)中 quotePrecision 会被移除。
  • 接口 GET api/v3/account 的更新
    • 添加新字段 permissions
  • 添加新接口 DELETE api/v3/openOrders
    • 此接口便于用户撤销单一交易对的所有挂单, 包括OCO的挂单。
  • 如果交易对处于 BREAK 或者 HALT 状态, 挂单也可以被撤销。
用户数据 STREAM
  • 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:

    * 默认`startTime`为当前时间起90天前, 默认`endTime`为当前时间;* 请注意`startTime` 与 `endTime` 的默认时间戳,保证请求时间间隔不超过90天;* 同时提交`startTime` 与 `endTime`间隔不得超过90天.
**2019-12-18**
  • 新增接口用以获取账户每日资产快照:
    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 and marginBuyBorrowAsset in FULL response to POST /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 as quoteOrderQty BTC can.
      • 买单: 给定quoteOrderQty的BTC会被用来市价买入尽可能多的BNB。
      • On the SELL side, the order will sell as much BNB as needed to receive quoteOrderQty BTC.
      • 卖单: 持有BNB会被尽可能多地以市价卖出以获取给定quoteOrderQty的BTC。

**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)
    {      "code": -1128,      "msg": "Combination of optional parameters invalid. Recommendation: 'stopLimitTimeInForce' should also be sent."    }
  • 错误代码更新: -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/allPricesGET api/v3/ticker/price
GET api/v1/ticker/allBookTickersGET api/v3/ticker/bookTicker
USER DATA STREAM
  • 事件executionReport(订单更新)更新内容:

    • 如果 C 值为空, 将返回 null, 而不是"null".
    • 新增返回值 Q, 表示 quoteOrderQty.
  • 新增事件类型balanceUpdate(余额更新)

    • 当资金存入或从帐户中提取时,发生余额更新。
WEB SOCKET STREAM
  • 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_LOSSSTOP_LOSS_LIMIT leg
      • LIMIT_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 订单.
      • 可通过orderListIdlistClientOrderId取消整个 OCO 订单。
    • OCO的新枚举:

      1. ListStatusType
        • RESPONSE - 当ListStatus响应失败的操作时使用。 (下单或取消订单)
        • EXEC_STARTED - 在下订单列表或列表状态更新时使用。
        • ALL_DONE - 当订单清单完成执行且不再有效时使用。
      2. ListOrderStatus
        • EXECUTING - 在下订单列表或列表状态更新时使用。
        • ALL_DONE - 当订单清单完成执行且不再有效时使用。
        • REJECT - 当ListStatus响应失败的操作时使用。 (下单或取消订单)
      3. 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天的订单"
  • 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
新的-2011错误内容
  • 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; 价格*交易数量。
Websocket 流
  • <symbol>@depth<symbol>@depthX 流不再具有被忽略且为空的"[]"。
系统改进
  • 匹配引擎稳定性/可靠性改进。
  • Rest API性能改进。

**2018-11-13**Rest API
  • 现在可以在限制交易期间通过Rest API取消订单。
  • 新的过滤器:PERCENT_PRICEMARKET_LOT_SIZEMAX_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分钟"。
平均价格的计算规则解释:
  1. [过去5分钟所有订单的数量*价格求和] / 过去5分钟所有订单的数量

  2. 如果最近5分钟内没有交易,则以5分钟窗口外发生的第一笔交易为准。     例如,如果最后一次交易是在20分钟前,则该交易的价格为5分钟的平均值。

  3. 如果代码上没有交易,则没有平均价格,因此无法下达市价单。对于在MIN_NOTIONAL过滤器上启用了applyToMarket的新交易对,除非有至少一笔交易,才能下达市价单。

  4. 当前的平均价格可以在这里查看: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 orderRESULTFULL响应现在具有"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请参考这里
  • 本篇列出接口的 base URL 有:
  • 上述列表的最后4个接口 (api1-api4) 可能会提供更好的性能,但其稳定性略为逊色。因此,请务必使用最适合您现有配置的那款。
  • 所有接口的响应都是 JSON 格式。
  • 响应中如有数组,数组元素以时间升序排列,越早的数据越提前。
  • 所有时间、时间戳均为UNIX时间,单位为毫秒
  • 对于仅发送公开市场数据的 API,您可以使用 base URL https://data-api.binance.vision
    • GET /api/v3/aggTrades
    • GET /api/v3/avgPrice
    • GET /api/v3/depth
    • GET /api/v3/exchangeInfo
    • GET /api/v3/klines
    • GET /api/v3/ping
    • GET /api/v3/ticker
    • GET /api/v3/ticker/24hr
    • GET /api/v3/ticker/bookTicker
    • GET /api/v3/ticker/price
    • GET /api/v3/time
    • GET /api/v3/trades
    • GET /api/v3/uiKlines

HTTP 返回代码#

  • HTTP 4XX 错误码用于指示错误的请求内容、行为、格式。问题在于请求者。
  • HTTP 403 错误码表示违反WAF限制(Web应用程序防火墙)。
  • HTTP 409 错误码表示重新下单(cancelReplace)的请求部分成功。(比如取消订单失败,但是下单成功了)
  • HTTP 429 错误码表示警告访问频次超限,即将被封IP。
  • HTTP 418 表示收到429后继续访问,于是被封了。
  • HTTP 5XX 错误码用于指示Binance服务侧的问题。

接口错误代码#

  • 使用接口 /api/v3, 以及 /sapi/v1/margin时, 每个接口都有可能抛出异常;

API 与 SAPI 的错误代码返回形式如下:

{  "code": -1121,  "msg": "Invalid symbol."}

接口的基本信息#

  • GET 方法的接口, 参数必须在 query string中发送。
  • POST, PUT, 和 DELETE 方法的接口,参数可以在内容形式为application/x-www-form-urlencodedquery 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) 并等待封禁时间结束。
  • 被拒绝或不成功的下单并不保证回报中包含以上头内容。
  • 下单频率限制是基于每个账户计数的。
  • 用户可以通过接口 GET api/v3/rateLimit/order 来查询当前的下单量.

WEB SOCKET 连接限制#

  • Websocket服务器每秒最多接受5个消息。消息包括:
    • PING帧
    • PONG帧
    • JSON格式的消息, 比如订阅, 断开订阅.
  • 如果用户发送的消息超过限制,连接会被断开连接。反复被断开连接的IP有可能被服务器屏蔽。
  • 单个连接最多可以订阅 1024 个Streams。
  • 每IP地址、每5分钟最多可以发送300次连接请求。

/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, MARGINUSER_DATA 接口是 签名(SIGNED)接口.

SIGNED (TRADE、USER_DATA AND MARGIN) Endpoint security#

  • 调用SIGNED 接口时,除了接口本身所需的参数外,还需要在query stringrequest body中传递 signature, 即签名参数。
  • 签名使用HMAC SHA256算法. API-KEY所对应的API-Secret作为 HMAC SHA256 的密钥,其他所有参数作为HMAC SHA256的操作对象,得到的输出即为签名。
  • 签名 大小写不敏感.
  • "totalParams"定义为与"request body"串联的"query string"。

时间同步安全#

  • 签名接口均需要传递 timestamp参数,其值应当是请求发送时刻的unix时间戳(毫秒)。
  • 服务器收到请求时会判断请求中的时间戳,如果是5000毫秒之前发出的,则请求会被认为无效。这个时间空窗值可以通过发送可选参数 recvWindow来定义。

逻辑伪代码如下:

  if (timestamp < (serverTime + 1000) && (serverTime - timestamp) <= recvWindow)  {    // process request  }   else   {    // reject request  }

关于交易时效性 互联网状况并不完全稳定可靠,因此你的程序本地到币安服务器的时延会有抖动。这是我们设置recvWindow的目的所在,如果你从事高频交易,对交易时效性有较高的要求,可以灵活设置recvWindow以达到你的要求。

POST /api/v3/order 的示例 - HMAC Keys#

以下是在 linux bash 环境下使用 echo openssl 和 curl 工具实现的一个调用接口下单的示例 apikey、secret仅供示范

KeyValue
apiKeyvmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A
secretKeyNhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j
参数取值
symbolLTCBTC
sideBUY
typeLIMIT
timeInForceGTC
quantity1
price0.1
recvWindow5000
timestamp1499827319559

示例 1: 所有参数通过 request body 发送

示例 1

HMAC SHA256 signature:

    $ echo -n "symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1499827319559" | openssl dgst -sha256 -hmac "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j"    (stdin)= c8db56825ae71d6d79447849e617115f4a920fa2acdcab2b053c4b2838bd6b71

curl command:

    (HMAC SHA256)    $ curl -H "X-MBX-APIKEY: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A" -X POST 'https://api.binance.com/api/v3/order' -d 'symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1499827319559&signature=c8db56825ae71d6d79447849e617115f4a920fa2acdcab2b053c4b2838bd6b71'    
  • requestBody:

symbol=LTCBTC
&side=BUY
&type=LIMIT
&timeInForce=GTC
&quantity=1
&price=0.1
&recvWindow=5000
×tamp=1499827319559

示例 2: 所有参数通过 query string 发送

示例 2

HMAC SHA256 signature:

    $ echo -n "symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1499827319559" | openssl dgst -sha256 -hmac "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j"    (stdin)= c8db56825ae71d6d79447849e617115f4a920fa2acdcab2b053c4b2838bd6b71    

curl command:

    (HMAC SHA256)   $ curl -H "X-MBX-APIKEY: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A" -X POST 'https://api.binance.com/api/v3/order?symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1499827319559&signature=c8db56825ae71d6d79447849e617115f4a920fa2acdcab2b053c4b2838bd6b71'    
  • queryString:

symbol=LTCBTC
&side=BUY
&type=LIMIT
&timeInForce=GTC
&quantity=1
&price=0.1
&recvWindow=5000
×tamp=1499827319559

示例 3: 混合使用 query string 和 request body

示例 3

HMAC SHA256 signature:

   $ echo -n "symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTCquantity=1&price=0.1&recvWindow=5000&timestamp=1499827319559" | openssl dgst -sha256 -hmac "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j"    (stdin)= 0fd168b8ddb4876a0358a8d14d0c9f3da0e9b20c5d52b2a00fcf7d1c602f9a77    

curl command:

    (HMAC SHA256)    $ curl -H "X-MBX-APIKEY: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A" -X POST 'https://api.binance.com/api/v3/order?symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC' -d 'quantity=1&price=0.1&recvWindow=5000&timestamp=1499827319559&signature=0fd168b8ddb4876a0358a8d14d0c9f3da0e9b20c5d52b2a00fcf7d1c602f9a77'
  • queryString:

symbol=LTCBTC&side=BUY&type=LIMIT&timeInForce=GTC

  • requestBody:

quantity=1&price=0.1&recvWindow=5000×tamp=1499827319559

请注意,签名与示例3不同。 "GTC"和"quantity = 1"之间没有&。

POST /api/v3/order 的示例 - RSA Keys#

  • 这将逐步介绍如何通过有效的签名发送 payload。
  • 我们接受 PKCS#8 格式的 RSA Key。
  • 要获取 API Key,您需要在您的账户上上传您的 RSA Public Key。

对于这个例子,Private Key 将被引用为test-prv-key.pem

KeyValue
apiKeyCAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ
参数取值
symbolBTCUSDT
sideSELL
typeLIMIT
timeInForceGTC
quantity1
price0.2
recvWindow5000
timestamp1668481559918

有列出参数的签名 payload:

symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2&timestamp=1668481559918&recvWindow=5000

第1步: Payload

将参数列表排列成一个 string。 用 & 分隔每个参数。对于上述参数,签名 payload 如右所示。

第2步: 计算签名

2.1 - 将签名有效负载编码为 ASCII 数据。

第2.2步

 $ echo -n 'symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2&timestamp=1668481559918&recvWindow=5000' | openssl dgst -sha256 -sign ./test-prv-key.pem

2.2 - 使用带有 SHA-256 hash 函数的 RSASSA-PKCS1-v1_5 算法对 payload 进行签名。

第2.3步

$ echo -n 'symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2&timestamp=1668481559918&recvWindow=5000' | openssl dgst -sha256 -sign ./test-prv-key.pem | openssl enc -base64 -AHZ8HOjiJ1s/igS9JA+n7+7Ti/ihtkRF5BIWcPIEluJP6tlbFM/Bf44LfZka/iemtahZAZzcO9TnI5uaXh3++lrqtNonCwp6/245UFWkiW1elpgtVAmJPbogcAv6rSlokztAfWk296ZJXzRDYAtzGH0gq7CgSJKfH+XxaCmR0WcvlKjNQnp12/eKXJYO4tDap8UCBLuyxDnR7oJKLHQHJLP0r0EAVOOSIbrFang/1WOq+Jaq4Efc4XpnTgnwlBbWTmhWDR1pvS9iVEzcSYLHT/fNnMRxFc7u+j3qI//5yuGuu14KR0MuQKKCSpViieD+fIti46sxPTsjSemoUKp0oXA==

2.3 - 将输出编码为 base64 string。

第2.4步

HZ8HOjiJ1s%2FigS9JA%2Bn7%2B7Ti%2FihtkRF5BIWcPIEluJP6tlbFM%2FBf44LfZka%2FiemtahZAZzcO9TnI5uaXh3%2B%2BlrqtNonCwp6%2F245UFWkiW1elpgtVAmJPbogcAv6rSlokztAfWk296ZJXzRDYAtzGH0gq7CgSJKfH%2BXxaCmR0WcvlKjNQnp12%2FeKXJYO4tDap8UCBLuyxDnR7oJKLHQHJLP0r0EAVOOSIbrFang%2F1WOq%2BJaq4Efc4XpnTgnwlBbWTmhWDR1pvS9iVEzcSYLHT%2FfNnMRxFc7u%2Bj3qI%2F%2F5yuGuu14KR0MuQKKCSpViieD%2BfIti46sxPTsjSemoUKp0oXA%3D%3D

2.4 - 由于签名可能包含 /=,这可能会导致发送请求时出现问题。 所以签名必须是 URL 编码的。

第2.5步

 curl -H "X-MBX-APIKEY: CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ" -X POST 'https://api.binance.com/api/v3/order?symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2&timestamp=1668481559918&recvWindow=5000&signature=HZ8HOjiJ1s%2FigS9JA%2Bn7%2B7Ti%2FihtkRF5BIWcPIEluJP6tlbFM%2FBf44LfZka%2FiemtahZAZzcO9TnI5uaXh3%2B%2BlrqtNonCwp6%2F245UFWkiW1elpgtVAmJPbogcAv6rSlokztAfWk296ZJXzRDYAtzGH0gq7CgSJKfH%2BXxaCmR0WcvlKjNQnp12%2FeKXJYO4tDap8UCBLuyxDnR7oJKLHQHJLP0r0EAVOOSIbrFang%2F1WOq%2BJaq4Efc4XpnTgnwlBbWTmhWDR1pvS9iVEzcSYLHT%2FfNnMRxFc7u%2Bj3qI%2F%2F5yuGuu14KR0MuQKKCSpViieD%2BfIti46sxPTsjSemoUKp0oXA%3D%3D'

2.5 - curl 命令

Bash 脚本

#!/usr/bin/env bash
# 设置身份验证:API_KEY="替换成您的 API Key"PRIVATE_KEY_PATH="test-prv-key.pem"
# 设置您的请求:API_METHOD="POST"API_CALL="api/v3/order"API_PARAMS="symbol=BTCUSDT&side=SELL&type=LIMIT&timeInForce=GTC&quantity=1&price=0.2"
# 计算签名:timestamp=$(date +%s000)api_params_with_timestamp="$API_PARAMS&timestamp=$timestamp"signature=$(echo -n "$api_params_with_timestamp" \            | openssl dgst -sha256 -sign "$PRIVATE_KEY_PATH" \            | openssl enc -base64 -A)
# 发送请求:curl -H "X-MBX-APIKEY: $API_KEY" -X "$API_METHOD" \    "https://api.binance.com/$API_CALL?$api_params_with_timestamp" \    --data-urlencode "signature=$signature"

右边有示例 Bash 脚本执行上述类似的步骤.


公开 API 参数#

术语#

这里的术语适用于全部文档,建议特别是新手熟读,也便于理解。

  • base asset 指一个交易对的交易对象,即写在靠前部分的资产名, 比如BTCUSDT, BTCbase asset
  • quote asset 指一个交易对的定价资产,即写在靠后部分的资产名, 比如BTCUSDT, USDTquote asset

枚举定义#

交易对状态 (状态 status):

  • PRE_TRADING 交易前
  • TRADING 交易中
  • POST_TRADING 交易后
  • END_OF_DAY
  • HALT
  • AUCTION_MATCH
  • BREAK

交易对类型:

  • SPOT 现货
  • MARGIN 杠杆
  • LEVERAGED 杠杆代币
  • TRD_GRP_002 交易组 002
  • TRD_GRP_003 交易组 003
  • TRD_GRP_004 交易组 004
  • TRD_GRP_005 交易组 005
  • TRD_GRP_006 交易组 006
  • TRD_GRP_007 交易组 007

订单状态 (状态 status):

状态描述
NEW订单被交易引擎接
PARTIALLY_FILLED部分订单被成交
FILLED订单完全成交
CANCELED用户撤销了订单
PENDING_CANCEL撤销中(目前并未使用)
REJECTED订单没有被交易引擎接受,也没被处理
EXPIRED订单被交易引擎取消,比如:
LIMIT FOK 订单没有成交
市价单没有完全成交
强平期间被取消的订单
交易所维护期间被取消的订单
EXPIRED_IN_MATCH表示订单由于 STP 触发而过期 (e.g. 带有 EXPIRE_TAKER 的订单与订单簿上属于同账户或同 tradeGroupId 的订单撮合)

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):

这里定义了订单多久能够失效

状态描述
GTC成交为止
订单会一直有效,直到被成交或者取消。
IOC无法立即成交的部分就撤销
订单在失效前会尽量多的成交。
FOK无法全部立即成交就撤销
如果无法全部成交,订单会失效。

K线间隔:

s -> 秒; m -> 分钟; h -> 小时; d -> 天; w -> 周; M -> 月

  • 1s
  • 1m
  • 3m
  • 5m
  • 15m
  • 30m
  • 1h
  • 2h
  • 4h
  • 6h
  • 8h
  • 12h
  • 1d
  • 3d
  • 1w
  • 1M

限制种类 (rateLimitType)

REQUEST_WEIGHT

    {      "rateLimitType": "REQUEST_WEIGHT",      "interval": "MINUTE",      "intervalNum": 1,      "limit": 1200    }

ORDERS

    {      "rateLimitType": "ORDERS",      "interval": "SECOND",      "intervalNum": 10,      "limit": 100    },    {      "rateLimitType": "ORDERS",      "interval": "DAY",      "intervalNum": 1,      "limit": 200000    }

RAW_REQUESTS

    {      "rateLimitType": "RAW_REQUESTS",      "interval": "MINUTE",      "intervalNum": 5,      "limit": 5000    }
  • REQUEST_WEIGHT 单位时间请求权重之和上限

  • ORDERS 单位时间下单次数限制

  • RAW_REQUESTS 单位时间请求次数上限

限制间隔 (interval)

  • SECOND 秒
  • MINUTE 分
  • DAY 天

过滤器#

过滤器,即Filter,定义了一系列交易规则。 共有两类,分别是针对交易对的过滤器symbol filters,和针对整个交易所的过滤器 exchange filters

交易对过滤器#

PRICE_FILTER 价格过滤器#

/exchangeInfo 响应中的格式:

  {    "filterType": "PRICE_FILTER",    "minPrice": "0.00000100",    "maxPrice": "100000.00000000",    "tickSize": "0.00000100"  }

价格过滤器 用于检测订单中 price 参数的合法性。包含以下三个部分:

  • minPrice 定义了 price/stopPrice 允许的最小值。
  • maxPrice 定义了 price/stopPrice 允许的最大值。
  • tickSize 定义了 price/stopPrice 的步进间隔,即price必须等于minPrice+(tickSize的整数倍)

以上每一项均可为0,为0时代表这一项不再做限制。

逻辑伪代码如下:

  • price >= minPrice
  • price <= maxPrice
  • price % tickSize == 0

PERCENT_PRICE 价格振幅过滤器#

/exchangeInfo 响应中的格式:

  {    "filterType": "PERCENT_PRICE",    "multiplierUp": "5",    "multiplierDown": "0.2",    "avgPriceMins": 5  }

PERCENT_PRICE过滤器基于先前交易的平均值来定义价格的有效范围。
avgPriceMins是计算平均价格的分钟数。 0表示使用最后的价格。

为了通过"价格百分比","价格"必须符合以下条件:

  • price <=weightedAveragePrice *multiplierUp
  • price> =weightedAveragePrice *multiplierDown

PERCENT_PRICE_BY_SIDE 基于买卖方向的价格振幅过滤器#

ExchangeInfo format:

    {          "filterType": "PERCENT_PRICE_BY_SIDE",          "bidMultiplierUp": "1.2",          "bidMultiplierDown": "0.2",          "askMultiplierUp": "5",          "askMultiplierDown": "0.8",          "avgPriceMins": 1    }

PERCENT_PRICE_BY_SIDE 过滤器定义了基于交易对平均价格的合法价格范围. 取决于BUY或者SELL, 价格范围可能有所不同.
avgPriceMins 是用来计算平均价格的分钟数. 0 表示用最新价(last price).

买向订单需要满足:

  • Order price <= weightedAveragePrice * bidMultiplierUp
  • Order price >= weightedAveragePrice * bidMultiplierDown

卖向订单需要满足:

  • Order Price <= weightedAveragePrice * askMultiplierUp
  • Order Price >= weightedAveragePrice * askMultiplierDown

LOT_SIZE 订单尺寸#

/exchangeInfo 响应中的格式:

  {    "filterType": "LOT_SIZE",    "minQty": "0.00100000",    "maxQty": "100000.00000000",    "stepSize": "0.00100000"  }

Lots是拍卖术语,LOT_SIZE 过滤器对订单中的 quantity 也就是数量参数进行合法性检查。包含三个部分:

  • minQty 表示 quantity/icebergQty 允许的最小值。
  • maxQty 表示 quantity/icebergQty 允许的最大值。
  • stepSize 表示 quantity/icebergQty 允许的步进值。

逻辑伪代码如下:

  • quantity >= minQty
  • quantity <= maxQty
  • quantity % stepSize == 0

MIN_NOTIONAL 最小名义价值(成交额)#

/exchangeInfo 响应中的格式:

  {    "filterType": "MIN_NOTIONAL",    "minNotional": "0.00100000",    "applyToMarket": true,    "avgPriceMins": 5  }

MIN_NOTIONAL过滤器定义了交易对订单所允许的最小名义价值(成交额)。 订单的名义价值是价格数量。 如果是高级订单(比如止盈止损订单STOP_LOSS_LIMIT),名义价值会按照stopPrice quantity来计算。 如果是冰山订单,名义价值会按照price * icebergQty来计算。 applyToMarket确定 MIN_NOTIONAL过滤器是否也将应用于MARKET订单。
由于MARKET订单没有价格,因此会在最后avgPriceMins分钟内使用平均价格。
avgPriceMins是计算平均价格的分钟数。 0表示使用最后的价格。

NOTIONAL 名义价值#

/exchangeInfo 响应中的格式:

{   "filterType": "NOTIONAL",   "minNotional": "10.00000000",   "applyMinToMarket": false,   "maxNotional": "10000.00000000",   "applyMaxToMarket": false,   "avgPriceMins": 5}

名义价值过滤器(NOTIONAL)定义了订单在一个交易对上可以下单的名义价值区间.

applyMinToMarket 定义了 minNotional 是否适用于市价单(MARKET)
applyMaxToMarket 定义了 maxNotional 是否适用于市价单(MARKET).

要通过此过滤器, 订单的名义价值 (单价 x 数量, price * quantity) 需要满足如下条件:

  • price * quantity <= maxNotional
  • price * quantity >= minNotional

对于市价单(MARKET), 用于计算的价格采用的是在 avgPriceMins 定义的时间之内的平均价.
如果 avgPriceMins 为 0, 则采用最新的价格.

ICEBERG_PARTS 冰山订单拆分数#

/exchangeInfo 响应中的格式:

  {    "filterType": "ICEBERG_PARTS",    "limit": 10  }

ICEBERG_PARTS 代表冰山订单最多可以拆分成多少个小订单。
计算方法为 向上取整(qty / icebergQty)

MARKET_LOT_SIZE 市价订单尺寸#

*/exchangeInfo 响应中的格式:

  {    "filterType": "MARKET_LOT_SIZE",    "minQty": "0.00100000",    "maxQty": "100000.00000000",    "stepSize": "0.00100000"  }

MARKET_LOT_SIZE过滤器为交易对上的MARKET订单定义了数量(即拍卖中的"手数")规则。 共有3部分:

  • minQty定义了允许的最小quantity
  • maxQty定义了允许的最大数量。
  • stepSize定义了可以增加/减少数量的间隔。

为了通过market lot sizequantity必须满足以下条件:

  • quantity >= minQty
  • quantity <= maxQty
  • quantity % stepSize == 0

MAX_NUM_ORDERS 最多订单数#

/exchangeInfo 响应中的格式:

  {    "filterType": "MAX_NUM_ORDERS",    "maxNumOrders": 25  }

定义了某个交易对最多允许的挂单数量(不包括已关闭的订单)
普通订单与条件订单均计算在内

MAX_NUM_ALGO_ORDERS 最多条件单数#

/exchangeInfo 响应中的格式:

  {    "filterType": "MAX_NUM_ALGO_ORDERS",    "maxNumAlgoOrders": 5  }

MAX_NUM_ALGO_ORDERS过滤器定义允许账户在交易对上开设的"algo"订单的最大数量。
"Algo"订单是STOP_LOSSSTOP_LOSS_LIMITTAKE_PROFITTAKE_PROFIT_LIMIT止盈止损单。

MAX_NUM_ICEBERG_ORDERS 最多冰山单数#

MAX_NUM_ICEBERG_ORDERS过滤器定义了允许在交易对上开设账户的ICEBERG订单的最大数量。
ICEBERG订单是icebergQty大于0的任何订单。.

/exchangeInfo 响应中的格式:

  {    "filterType": "MAX_NUM_ICEBERG_ORDERS",    "maxNumIcebergOrders": 5  }

MAX_POSITION 过滤器#

这个过滤器定义账户允许的基于base asset的最大仓位。一个用户的仓位可以定义为如下资产的总和:

  1. base asset的可用余额
  2. base asset的锁定余额
  3. 所有处于open的买单的数量总和

如果用户的仓位大于最大的允许仓位,买单会被拒绝。

如果一个订单的数量(quantity) 可能导致持有仓位溢出, 会触发过滤器 MAX_POSITION.

/exchangeInfo 响应中的格式:

{  "filterType": "MAX_POSITION",  "maxPosition": "10.00000000"}

TRAILING_DELTA#

ExchangeInfo format:

    {          "filterType": "TRAILING_DELTA",          "minTrailingAboveDelta": 10,          "maxTrailingAboveDelta": 2000,          "minTrailingBelowDelta": 10,          "maxTrailingBelowDelta": 2000   }

此过滤器定义了参数trailingDelta的最大和最小值.

下追踪止损订单, 需要满足条件:

对于 STOP_LOSS BUY, STOP_LOSS_LIMIT_BUY, TAKE_PROFIT SELLTAKE_PROFIT_LIMIT SELL 订单:

  • trailingDelta >= minTrailingAboveDelta
  • trailingDelta <= maxTrailingAboveDelta

对于 STOP_LOSS SELL, STOP_LOSS_LIMIT SELL, TAKE_PROFIT BUY, 和 TAKE_PROFIT_LIMIT BUY 订单:

  • trailingDelta >= minTrailingBelowDelta
  • trailingDelta <= maxTrailingBelowDelta

交易所级别过滤器#

EXCHANGE_MAX_NUM_ORDERS 最多订单数#

/exchangeInfo 响应中的格式:

  {    "filterType": "EXCHANGE_MAX_NUM_ORDERS",    "maxNumOrders": 1000  }

EXCHANGE_MAX_NUM_ORDERS过滤器定义了允许在交易对上开设账户的最大订单数。
请注意,此过滤器同时计算"algo"订单和常规订单。

EXCHANGE_MAX_ALGO_ORDERS 交易最大ALGO订单数#

/exchangeInfo 响应中的格式:

  {    "filterType": "EXCHANGE_MAX_ALGO_ORDERS",    "maxNumAlgoOrders": 200  }

EXCHANGE_MAX_ALGO_ORDERS过滤器定义了允许在交易上开设账户的"algo"订单的最大数量。
"Algo"订单是STOP_LOSSSTOP_LOSS_LIMITTAKE_PROFITTAKE_PROFIT_LIMIT订单。

EXCHANGE_MAX_NUM_ICEBERG_ORDERS 冰山订单的最大订单数#

此过滤器定义了允许账号持有的最大冰山订单数量.

/exchangeInfo 响应中的格式:

{  "filterType": "EXCHANGE_MAX_NUM_ICEBERG_ORDERS",  "maxNumIcebergOrders": 10000}

钱包接口

系统状态(System)#

响应

{         "status": 0,              // 0: 正常,1:系统维护        "msg": "normal"           // "normal", "system_maintenance"}

GET /sapi/v1/system/status

获取系统状态。

权重(IP): 1

获取所有币信息 (USER_DATA)#

获取针对用户的所有(Binance支持充提操作的)币种信息。

响应

[    {        "coin": "BTC",        "depositAllEnable": true,        "free": "0.08074558",        "freeze": "0.00000000",        "ipoable": "0.00000000",        "ipoing": "0.00000000",        "isLegalMoney": false,        "locked": "0.00000000",        "name": "Bitcoin",        "networkList": [            {                "addressRegex": "^(bnb1)[0-9a-z]{38}$",                "coin": "BTC",                "depositDesc": "Wallet Maintenance, Deposit Suspended", // 仅在充值关闭时返回                "depositEnable": false,                "isDefault": false,                        "memoRegex": "^[0-9A-Za-z\\-_]{1,120}$",                "minConfirm": 1,  // 上账所需的最小确认数                "name": "BEP2",                "network": "BNB",                            "resetAddressStatus": false,                "specialTips": "Both a MEMO and an Address are required to successfully deposit your BEP2-BTCB tokens to Binance.",                "unLockConfirm": 0,  // 解锁需要的确认数                 "withdrawDesc": "Wallet Maintenance, Withdrawal Suspended", // 仅在提现关闭时返回                "withdrawEnable": false,                "withdrawFee": "0.00000220",                "withdrawIntegerMultiple": "0.00000001",                "withdrawMax": "9999999999.99999999",                "withdrawMin": "0.00000440",                "sameAddress": true,  // 是否需要memo                "estimatedArrivalTime": 25,                "busy": false            },            {                "addressRegex": "^[13][a-km-zA-HJ-NP-Z1-9]{25,34}$|^(bc1)[0-9A-Za-z]{39,59}$",                "coin": "BTC",                "depositEnable": true,                "isDefault": true,                "memoRegex": "",                "minConfirm": 1,  // 上账所需的最小确认数                "name": "BTC",                "network": "BTC",                "resetAddressStatus": false,                "specialTips": "",                "unLockConfirm": 0,  // 解锁需要的确认数                "withdrawEnable": true,                "withdrawFee": "0.00050000",                "withdrawIntegerMultiple": "0.00000001",                "withdrawMax": "750",                "withdrawMin": "0.00100000",                "sameAddress": false,                "estimatedArrivalTime": 25,                "busy": false            }        ],        "storage": "0.00000000",        "trading": true,        "withdrawAllEnable": true,        "withdrawing": "0.00000000"    }]

GET /sapi/v1/capital/config/getall (HMAC SHA256)

权重(IP): 10

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES

查询每日资产快照 (USER_DATA)#

响应

{   "code":200, // 200表示返回正确,否则即为错误码   "msg":"", // 与错误码对应的报错信息   "snapshotVos":[      {         "data":{            "balances":[               {                  "asset":"BTC",                  "free":"0.09905021",                  "locked":"0.00000000"               },               {                  "asset":"USDT",                  "free":"1.89109409",                  "locked":"0.00000000"               }            ],            "totalAssetOfBtc":"0.09942700"         },         "type":"spot",         "updateTime":1576281599000      }   ]}

{   "code":200, // 200表示返回正确,否则即为错误码   "msg":"", // 与错误码对应的报错信息   "snapshotVos":[      {         "data":{            "marginLevel":"2748.02909813",            "totalAssetOfBtc":"0.00274803",            "totalLiabilityOfBtc":"0.00000100",            "totalNetAssetOfBtc":"0.00274750",            "userAssets":[               {                  "asset":"XRP",                  "borrowed":"0.00000000",                  "free":"1.00000000",                  "interest":"0.00000000",                  "locked":"0.00000000",                  "netAsset":"1.00000000"               }            ]         },         "type":"margin",         "updateTime":1576281599000      }   ]}

{   "code":200, // 200表示返回正确,否则即为错误码   "msg":"", // 与错误码对应的报错信息   "snapshotVos":[      {         "data":{            "assets":[               {                  "asset":"USDT",                  "marginBalance":"118.99782335", // 不会实时更新,可以忽略                  "walletBalance":"120.23811389"               }            ],            "position":[               {                  "entryPrice":"7130.41000000",                  "markPrice":"7257.66239673",                  "positionAmt":"0.01000000",                  "symbol":"BTCUSDT",                  "unRealizedProfit":"1.24029054" // 只显示开仓当时的未实现盈亏,不会实时更新,可以忽略               }            ]         },         "type":"futures",         "updateTime":1576281599000      }   ]}

GET /sapi/v1/accountSnapshot (HMAC SHA256)

权重(IP): 2400

参数:

名称类型是否必需描述
typeSTRINGYES"SPOT", "MARGIN", "FUTURES"
startTimeLONGNO
endTimeLONGNO
limitINTNOmin 7, max 30, default 7
recvWindowLONGNO
timestampLONGYES
  • 查询时间范围最大不得超过30天
  • 仅支持查询最近 1 个月数据
  • 若startTime和endTime没传,则默认返回最近7天数据

关闭站内划转 (USER_DATA)#

响应

{}

POST /sapi/v1/account/disableFastWithdrawSwitch (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES
  • 注意:

    此请求会关闭您账户的站内快速划转。您需要为api-key开通"trade"权限才能发送此请求。

开启站内划转 (USER_DATA)#

响应

{}

POST /sapi/v1/account/enableFastWithdrawSwitch (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES
  • 此请求会开启您账户的站内快速划转。您需要为api-key开通"trade"权限才能发送此请求。
  • 开启以后, 如果收款方为币安账户地址,转账费用为0, 速度快, 不需要提交上链请求。

提币 (USER_DATA)#

响应

{    "id":"7213fea8e94b4a5593d507237e5a555b"}

POST /sapi/v1/capital/withdraw/apply (HMAC SHA256)

Submit a withdraw request.

权重(UID): 600

参数:

名称类型是否必需描述
coinSTRINGYES
withdrawOrderIdSTRINGNO自定义提币ID
networkSTRINGNO提币网络
addressSTRINGYES提币地址
addressTagSTRINGNO某些币种例如 XRP,XMR 允许填写次级地址标签
amountDECIMALYES数量
transactionFeeFlagBOOLEANNO当站内转账时免手续费, true: 手续费归资金转入方; false: 手续费归资金转出方; . 默认 false.
nameSTRINGNO地址的备注,填写该参数后会加入该币种的提现地址簿。地址簿上限为20,超出后会造成提现失败。地址中的空格需要encode成%20
walletTypeINTEGERNO表示出金使用的钱包,0为现货钱包,1为资金钱包。默认walletType为"充币账户"是您设置在钱包->现货账户或资金账户->充值。
recvWindowLONGNO
timestampLONGYES
  • 如果不发送 network, 将按该币种默认网络返回结果;
  • 可以在接口Get /sapi/v1/capital/config/getall (HMAC SHA256)的返回值中某币种的networkList 获取 network网络字段和isDefault是否为默认网络。

获取充值历史(支持多网络) (USER_DATA)#

响应

[    {        "id": "769800519366885376",        "amount": "0.001",        "coin": "BNB",        "network": "BNB",        "status": 0,        "address": "bnb136ns6lfw4zs5hg4n85vdthaad7hq5m4gtkgf23",        "addressTag": "101764890",        "txId": "98A3EA560C6B3336D348B6C83F0F95ECE4F1F5919E94BD006E5BF3BF264FACFC",        "insertTime": 1661493146000,        "transferType": 0,        "confirmTimes": "1/1",        "unlockConfirm": 0,        "walletType": 0    },    {        "id": "769754833590042625",        "amount":"0.50000000",        "coin":"IOTA",        "network":"IOTA",        "status":1,        "address":"SIZ9VLMHWATXKV99LH99CIGFJFUMLEHGWVZVNNZXRJJVWBPHYWPPBOSDORZ9EQSHCZAMPVAPGFYQAUUV9DROOXJLNW",        "addressTag":"",        "txId":"ESBFVQUTPIWQNJSPXFNHNYHSQNTGKRVKPRABQWTAXCDWOAKDKYWPTVG9BGXNVNKTLEJGESAVXIKIZ9999",        "insertTime":1599620082000,        "transferType":0,        "confirmTimes": "1/1",        "unlockConfirm": 0,        "walletType": 0    }]

GET /sapi/v1/capital/deposit/hisrec (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
coinSTRINGNO
statusINTNO0(0:pending,6: credited but cannot withdraw,7=Wrong Deposit,8=Waiting User confirm,1:success)
startTimeLONGNO默认当前时间90天前的时间戳
endTimeLONGNO默认当前时间戳
offsetINTNO默认:0
limitINTNO默认:1000,最大1000
recvWindowLONGNO
timestampLONGYES
txIdSTRINGNO
  • 请注意startTimeendTime 的默认时间戳,保证请求时间间隔不超过90天.
  • 同时提交startTimeendTime间隔不得超过90天.

获取提币历史 (支持多网络) (USER_DATA)#

响应

[  {    "id": "b6ae22b3aa844210a7041aee7589627c",  // 该笔提现在币安的id    "amount": "8.91000000",   // 提现转出金额    "transactionFee": "0.004", // 手续费    "coin": "USDT",    "status": 6,    "address": "0x94df8b352de7f46f64b01d3666bf6e936e44ce60",    "txId": "0xb5ef8c13b968a406cc62a93a8bd80f9e9a906ef1b3fcf20a2e48573c17659268"   // 提现交易id    "applyTime": "2019-10-12 11:12:02",  // UTC 时间    "network": "ETH",    "transferType": 0 // 1: 站内转账, 0: 站外转账        "withdrawOrderId": "WITHDRAWtest123", // 自定义ID, 如果没有则不返回该字段    "info": "The address is not valid. Please confirm with the recipient",  // 提币失败原因    "confirmNo":3,  // 提现确认数    "walletType": 1,  //1: 资金钱包 0:现货钱包    "txKey": "",    "completeTime": "2023-03-23 16:52:41"  // 提现完成,成功下账时间(UTC)  },  {    "id": "156ec387f49b41df8724fa744fa82719",    "amount": "0.00150000",    "transactionFee": "0.004",    "coin": "BTC",    "status": 6,    "address": "1FZdVHtiBqMrWdjPyRPULCUceZPJ2WLCsB",    "txId": "60fd9007ebfddc753455f95fafa808c4302c836e4d1eebc5a132c36c1d8ac354"    "applyTime": "2019-09-24 12:43:45",    "network": "BTC",    "transferType": 0,     "info": "",    "confirmNo": 2,    "walletType": 1,    "txKey": "",    "completeTime": "2023-03-23 16:52:41"   }]

GET /sapi/v1/capital/withdraw/history (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
coinSTRINGNO
withdrawOrderIdSTRINGNO
statusINTNO0(0:已发送确认Email,1:已被用户取消 2:等待确认 3:被拒绝 4:处理中 5:提现交易失败 6 提现完成)
offsetINTNO
limitINTNO默认:1000, 最大:1000
startTimeLONGNO默认当前时间90天前的时间戳
endTimeLONGNO默认当前时间戳
recvWindowLONGNO
timestampLONGYES
  • 支持多网络提币前的历史记录可能不会返回network字段.
  • 请注意startTimeendTime 的默认时间戳,保证请求时间间隔不得超过90天.
  • 同时提交startTimeendTime间隔不得超过90天.
  • 若传了withdrawOrderId,则请求的startTimeendTime的时间间隔不得超过7天.
  • 若传了withdrawOrderId,没传startTimeendTime,则默认返回最近7天数据.

获取充值地址 (支持多网络) (USER_DATA)#

响应

{    "address": "1HPn8Rx2y6nNSfagQBKy27GB99Vbzg89wv",    "coin": "BTC",    "tag": "",    "url": "https://btc.com/1HPn8Rx2y6nNSfagQBKy27GB99Vbzg89wv"}

GET /sapi/v1/capital/deposit/address (HMAC SHA256)

权重(IP): 10

参数:

名称类型是否必需描述
coinSTRINGYES
networkSTRINGNO
recvWindowLONGNO
timestampLONGYES
  • 如果不发送 network, 将按该币种默认网络返回结果;
  • 可以在接口Get /sapi/v1/capital/config/getall (HMAC SHA256)的返回值中某币种的networkList 获取 network网络字段和isDefault是否为默认网络。

账户状态 (USER_DATA)#

响应

{    "data": "Normal" }

GET /sapi/v1/account/status

获取账户状态详情。

权重(IP): 1

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES

账户API交易状态(USER_DATA)#

响应

{    "data": {          // 账户API交易状态详情            "isLocked": false,   // API交易功能是否被锁            "plannedRecoverTime": 0,  // API交易功能被锁情况下的预计恢复时间            "triggerCondition": {                     "GCR": 150,  // Number of GTC orders                    "IFER": 150, // Number of FOK/IOC orders                    "UFR": 300   // Number of orders            },            "updateTime": 1547630471725       }}

GET /sapi/v1/account/apiTradingStatus (HMAC SHA256)

获取 api 账户交易状态详情。

权重(IP): 1

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES

小额资产转换BNB历史 (USER_DATA)#

响应

{        "total": 8,   //共计发生过的转换笔数        "userAssetDribblets": [            {                "operateTime": 1615985535000,                "totalTransferedAmount": "0.00132256",   //本次转换所得BNB                "totalServiceChargeAmount": "0.00002699",   //本次转换手续费(BNB)                "transId": 45178372831,                "userAssetDribbletDetails": [           //本次转换的细节                    {                        "transId": 4359321,                        "serviceChargeAmount": "0.000009",                        "amount": "0.0009",                        "operateTime": 1615985535000,                        "transferedAmount": "0.000441",                        "fromAsset": "USDT"                    },                    {                        "transId": 4359321,                        "serviceChargeAmount": "0.00001799",                        "amount": "0.0009",                        "operateTime": 1615985535000,                        "transferedAmount": "0.00088156",                        "fromAsset": "ETH"                    }                ]            },            {                "operateTime":1616203180000,                "totalTransferedAmount": "0.00058795",                "totalServiceChargeAmount": "0.000012",                "transId": 4357015,                "userAssetDribbletDetails": [                           {                        "transId": 4357015,                        "serviceChargeAmount": "0.00001"                        "amount": "0.001",                        "operateTime": 1616203180000,                        "transferedAmount": "0.00049",                        "fromAsset": "USDT"                    },                    {                        "transId": 4357015,                        "serviceChargeAmount": "0.000002"                                 "amount": "0.0001",                        "operateTime": 1616203180000,                        "transferedAmount": "0.00009795",                        "fromAsset": "ETH"                    }                ]            }        ]    }}

GET /sapi/v1/asset/dribblet (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
startTimeLONGNO
endTimeLONGNO
recvWindowLONGNO
timestampLONGYES
  • 只返回最近100条记录
  • 只返回 2020/12/01 之后记录

获取可以转换成BNB的小额资产 (USER_DATA)#

响应

{    "details": [        {            "asset": "ADA",         //资产名            "assetFullName": "ADA", //资产全称            "amountFree": "6.21",   //可转换数量            "toBTC": "0.00016848",  //等值BTC            "toBNB": "0.01777302",  //可转换BNB(未扣除手续费)            "toBNBOffExchange": "0.01741756", //可转换BNB(已扣除手续费)            "exchange": "0.00035546" //手续费        }    ],    "totalTransferBtc": "0.00016848",//全部资产等值BTC    "totalTransferBNB": "0.01777302",//总共可以转换的BNB数量    "dribbletPercentage": "0.02"     //转换手续费}  

POST /sapi/v1/asset/dust-btc (HMAC SHA256)

获取可以转换成 BNB 的小额资产列表.

权重(IP): 1

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES

小额资产转换 (USER_DATA)#

响应

{    "totalServiceCharge":"0.02102542",    "totalTransfered":"1.05127099",    "transferResult":[        {            "amount":"0.03000000",            "fromAsset":"ETH",            "operateTime":1563368549307,            "serviceChargeAmount":"0.00500000",            "tranId":2970932918,            "transferedAmount":"0.25000000"        },        {            "amount":"0.09000000",            "fromAsset":"LTC",            "operateTime":1563368549404,            "serviceChargeAmount":"0.01548000",            "tranId":2970932918,            "transferedAmount":"0.77400000"        },        {            "amount":"248.61878453",            "fromAsset":"TRX",            "operateTime":1563368549489,            "serviceChargeAmount":"0.00054542",            "tranId":2970932918,            "transferedAmount":"0.02727099"        }    ]}

POST /sapi/v1/asset/dust (HMAC SHA256)

把小额资产转换成 BNB.

权重(UID): 10

参数:

名称类型是否必需描述
assetARRAYYES正在转换的资产。 例如:asset=BTC,USDT
recvWindowLONGNO
timestampLONGYES
  • 您需要为API Key开通允许现货和杠杆交易权限才能发送此请求

资产利息记录 (USER_DATA)#

响应

{    "rows":[        {            "id":1637366104,            "amount":"10.00000000",            "asset":"BHFT",            "divTime":1563189166000,            "enInfo":"BHFT distribution",            "tranId":2968885920        },        {            "id": 1631750237,            "amount":"10.00000000",            "asset":"BHFT",            "divTime":1563189165000,            "enInfo":"BHFT distribution",            "tranId":2968885920        }    ],    "total":2}

GET /sapi/v1/asset/assetDividend (HMAC SHA256)

获取资产利息记录。

权重(IP): 10

参数:

名称类型是否必需描述
assetSTRINGNO
startTimeLONGNO
endTimeLONGNO
limitINTNODefault 20, max 500
recvWindowLONGNO
timestampLONGYES
  • startTimeendTime之间最多只可以相差180天。

上架资产详情 (USER_DATA)#

响应

{    "CTR": {            "minWithdrawAmount": "70.00000000",   //最小提现数量            "depositStatus": false,   //是否可以充值(只有所有网络都关闭充值才为false)            "withdrawFee": 35,   // 提现手续费            "withdrawStatus": true,    //是否开放提现(只有所有网络都关闭提币才为false)            "depositTip": "Delisted, Deposit Suspended"   //暂停充值的原因(如果暂停才有这一项)        },        "SKY": {            "minWithdrawAmount": "0.02000000",            "depositStatus": true,            "withdrawFee": 0.01,            "withdrawStatus": true        }}

GET /sapi/v1/asset/assetDetail (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
assetSTRINGNO
recvWindowLONGNO
timestampLONGYES
  • 充提币信息,建议查询 GET /sapi/v1/capital/config/getall 获取详情。

交易手续费率查询 (USER_DATA)#

响应

[    {        "symbol": "ADABNB",        "makerCommission": "0.001",        "takerCommission": "0.001"    },    {        "symbol": "BNBBTC",        "makerCommission": "0.001",        "takerCommission": "0.001"    }]

GET /sapi/v1/asset/tradeFee (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
symbolSTRINGNO
recvWindowLONGNO
timestampLONGYES

用户万向划转 (USER_DATA)#

响应:

{    "tranId":13526853623}

POST /sapi/v1/asset/transfer (HMAC SHA256)

您需要开通api key 允许万向划转权限来调用此接口。

权重(UID)): 900

参数:

名称类型是否必需描述
typeENUMYES
assetSTRINGYES
amountDECIMALYES
fromSymbolSTRINGNO
toSymbolSTRINGNO
recvWindowLONGNO
timestampLONGYES
  • fromSymbol 必须要发送,当类型为 ISOLATEDMARGIN_MARGIN 和 ISOLATEDMARGIN_ISOLATEDMARGIN

  • toSymbol 必须要发送,当类型为 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 币本位合约钱包转向资金钱包
    • MAIN_OPTION 现货钱包转向期权钱包
    • OPTION_MAIN 期权钱包转向现货钱包
    • UMFUTURE_OPTION U本位合约钱包转向期权钱包
    • OPTION_UMFUTURE 期权钱包转向U本位合约钱包
    • MARGIN_OPTION 杠杆全仓钱包转向期权钱包
    • OPTION_MARGIN 期权全仓钱包转向杠杆钱包
    • FUNDING_OPTION 资金钱包转向期权钱包
    • OPTION_FUNDING 期权钱包转向资金钱包
    • MAIN_PORTFOLIO_MARGIN 现货钱包转向统一账户钱包
    • PORTFOLIO_MARGIN_MAIN 统一账户钱包转向现货钱包

查询用户万向划转历史 (USER_DATA)#

响应:

{    "total":2,    "rows":[        {            "asset":"USDT",            "amount":"1",            "type":"MAIN_UMFUTURE"            "status": "CONFIRMED", // status: CONFIRMED / FAILED / PENDING            "tranId": 11415955596,            "timestamp":1544433328000        },        {            "asset":"USDT",            "amount":"2",            "type":"MAIN_UMFUTURE",            "status": "CONFIRMED",            "tranId": 11366865406,            "timestamp":1544433328000        }    ]}

GET /sapi/v1/asset/transfer (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
typeENUMYES
startTimeLONGNO
endTimeLONGNO
currentINTNO默认 1
sizeINTNO默认 10, 最大 100
fromSymbolSTRINGNO
toSymbolSTRINGNO
recvWindowLONGNO
timestampLONGYES
  • fromSymbol 必须要发送,当类型为 ISOLATEDMARGIN_MARGIN 和 ISOLATEDMARGIN_ISOLATEDMARGIN
  • toSymbol 必须要发送,当类型为 MARGIN_ISOLATEDMARGIN 和 ISOLATEDMARGIN_ISOLATEDMARGIN
  • 仅支持查询最近半年(6个月)数据
  • startTimeendTime没传,则默认返回最近7天数据

资金账户 (USER_DATA)#

响应

[    {        "asset": "USDT",        "free": "1",    // 可用余额        "locked": "0",  // 锁定资金        "freeze": "0",  //冻结资金        "withdrawing": "0",  // 提币        "btcValuation": "0.00000091"  // btc估值    }]

POST /sapi/v1/asset/get-funding-asset (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
assetSTRINGNO
needBtcValuationSTRINGNOtrue or false
recvWindowLONGNO
timestampLONGYES
  • 目前仅支持查询以下业务资产:Binance Pay, Binance Card, Binance Gift Card, Stock Token

用户持仓 (USER_DATA)#

响应

[  {    "asset": "AVAX",    "free": "1",    "locked": "0",    "freeze": "0",    "withdrawing": "0",    "ipoable": "0",    "btcValuation": "0"  },  {    "asset": "BCH",    "free": "0.9",    "locked": "0",    "freeze": "0",    "withdrawing": "0",    "ipoable": "0",    "btcValuation": "0"  },  {    "asset": "BNB",    "free": "887.47061626",    "locked": "0",    "freeze": "10.52",    "withdrawing": "0.1",    "ipoable": "0",    "btcValuation": "0"  },  {    "asset": "BUSD",    "free": "9999.7",    "locked": "0",    "freeze": "0",    "withdrawing": "0",    "ipoable": "0",    "btcValuation": "0"  },  {    "asset": "SHIB",    "free": "532.32",    "locked": "0",    "freeze": "0",    "withdrawing": "0",    "ipoable": "0",    "btcValuation": "0"  },  {    "asset": "USDT",    "free": "50300000001.44911105",    "locked": "0",    "freeze": "0",    "withdrawing": "0",    "ipoable": "0",    "btcValuation": "0"  },  {    "asset": "WRZ",    "free": "1",    "locked": "0",    "freeze": "0",    "withdrawing": "0",    "ipoable": "0",    "btcValuation": "0"  }]

POST /sapi/v3/asset/getUserAsset

获取用户持仓,仅返回>0的数据。

权重(IP): 5

参数:

名称类型是否必需描述
assetSTRINGNO如果资产为空,则查询用户所有的正资产。
needBtcValuationBOOLEANNO是否需要返回兑换成BTC的估值
recvWindowLONGNO
timestampLONGYES

稳定币自动兑换划转 (TRADE)#

响应

{  "tranId": 118263407119,  "status": "S"}

POST /sapi/v1/asset/convert-transfer

稳定币和BUSD之间的自动划转

权重(UID): 5

参数

名称类型是否必需描述
clientTranIdSTRINGYES用户自定义流水号,唯一标志,限制最短长度为20
assetSTRINGYES当前资产
amountBigDecimalYES数量必须为正数
targetAssetStringYES目标资产
accountTypeStringNO仅支持MAIN和CARD,如果为空,默认查询主账户MAIN
  • 如果clientTranId你之前使用过,不会进行第二次自动转化,而是把之前划转的结果返回

稳定币自动兑换划转查询 (USER_DATA)#

响应

{  "total":3,  "rows":  [    {      "tranId":118263615991,      "type":244,      "time":1664442078000,      "deductedAsset":"BUSD",      "deductedAmount":"1",      "targetAsset":"USDC",      "targetAmount":"1",      "status":"S",      "accountType":"MAIN"    },{      "tranId":118263598801,      "type":244,      "time":1664442061000,      "deductedAsset":"BUSD",      "deductedAmount":"1",      "targetAsset":"USDC",      "targetAmount":"1",      "status":"S",      "accountType":"MAIN"    },{      "tranId":118263407119,      "type":244,      "time":1664441820000,      "deductedAsset":"BUSD",      "deductedAmount":"1",      "targetAsset":"USDC",      "targetAmount":"1",      "status":"S",      "accountType":"MAIN"    }  ]}

GET /sapi/v1/asset/convert-transfer/queryByPage

权重(UID): 5

参数

名称类型是否必需描述
tranIdLONGNO流水号
clientTranIdSTRINGNO用户自定义流水号
assetSTRINGNO不传或者空字符串查全部, 匹配扣除币种和目标币种
startTimeLONGYES开始时间(包含),单位:毫秒
endTimeLONGYES结束时间(不包含),单位:毫秒
accountTypeSTRINGNO账户类型: MAIN-主账户。CARD-资金账户。如果传入则仅返回对应wallet的记录,不传或者传null则返回该用户spot和card钱包的记录。
currentINTEGERNO当前页面,默认1,最小值为1
sizeINTEGERNO页面大小,默认10,最大值为100
  • types类型:
    • 244 sapi请求兑换
    • 11 入金自动兑换
    • 32 提现自动兑换
    • 34 提现失败
    • 254 busd自动兑换任务

云算力历史记录分页查询 (USER_DATA)#

响应:

{  "total":5,  "rows":[    {"createTime":1667880112000,"tranId":121230610120,"type":248,"asset":"USDT","amount":"25.0068","status":"S"},    {"createTime":1666776366000,"tranId":119991507468,"type":249,"asset":"USDT","amount":"0.027","status":"S"},    {"createTime":1666764505000,"tranId":119977966327,"type":248,"asset":"USDT","amount":"0.027","status":"S"},    {"createTime":1666758189000,"tranId":119973601721,"type":248,"asset":"USDT","amount":"0.018","status":"S"},    {"createTime":1666757278000,"tranId":119973028551,"type":248,"asset":"USDT","amount":"0.018","status":"S"}  ]}

GET /sapi/v1/asset/ledger-transfer/cloud-mining/queryByPage

云算力支付和退款历史分页查询

权重(UID): 600

参数:

名称类型是否必需描述
tranIdLONGNO流水号
clientTranIdSTRINGNO外部唯一流水号
assetSTRINGNO不传或者空字符串查全部
startTimeLONGYES开始时间(包含),单位:毫秒
endTimeLONGYES结束时间(不包含),单位:毫秒
currentINTEGERNO当前页面,默认1,最小值为1
sizeINTEGERNO页面大小,默认10,最大值为100
  • 仅返回支付和退款成功的记录。
  • 对于响应来说,type = 248 代表着支付记录,type = 249 代表着退款记录, status =S 代表成功。

查询用户API Key权限 (USER_DATA)#

响应

{   "ipRestrict": false,  // 是否限制ip访问   "createTime": 1623840271000,   // 创建时间   "enableWithdrawals": false,   // 此选项允许通过此api提现。开启提现选项必须添加IP访问限制过滤器   "enableInternalTransfer": true,  // 此选项授权此密钥在您的母账户和子账户之间划转资金   "permitsUniversalTransfer": true,  // 授权该密钥可用于专用的万向划转接口,用以操作其支持的多种类型资金划转。各业务自身的划转接口使用权限,不受本授权影响   "enableVanillaOptions": false,  // 欧式期权交易权限   "enableReading": true,   "enableFutures": false,  // 合约交易权限,需注意开通合约账户之前创建的API Key不支持合约API功能   "enableMargin": false,   // 此选项在全仓账户完成划转后可编辑   "enableSpotAndMarginTrading": false, // 现货和杠杆交易权限   "tradingAuthorityExpirationTime": 1628985600000  // 现货和杠杆交易权限到期时间,如果没有则不返回该字段}

GET /sapi/v1/account/apiRestrictions (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES

查询用户稳定币与 BUSD 互相转换的设置 (USER_DATA)#

响应:

{  "convertEnabled": true,  "coins": [    "USDC",    "USDP",    "TUSD"  ],  "exchangeRates": {    "USDC": "1",    "TUSD": "1",    "USDP": "1"  }}

GET /sapi/v1/capital/contract/convertible-coins

查询用户充值/提现时候稳定币与 BUSD 互转的设置

权重(UID): 600

参数: None

修改哪些稳定币可与 BUSD 互相转换(USER_DATA)#

响应: 成功返回 200,无 body

POST /sapi/v1/capital/contract/convertible-coins

修改哪些稳定币可与 BUSD 互相转换

权重(UID): 600

参数:

名称类型是否必需描述
coinSTRINGYESUSDC、USDP、TUSD 中的一个
enableBOOLEANYEStrue: 打开转换。false: 关闭转换
  • 参数应在POST BODY

一键上账 (充值到过期地址) (USER_DATA)#

响应:

{    "code": "000000",    "message": "success",    "data":true,    "success": true}

POST /sapi/v1/capital/deposit/credit-apply (HMAC SHA256)

申请充值到过期地址的一键上账.

权重(IP): 1

参数:

名称类型是否必需描述
depositIdLONGNO充值记录Id,优先使用
txIdSTRINGNO充值txId,当depositId没指定时使用
subAccountIdLONGNOCloud的子账户ID
subUserIdLONGNO母账户的子账户userId
  • 参数应在POST BODY

子母账户接口

创建虚拟子账户(适用主账户)#

响应:

{    "email":"addsdd_virtual@aasaixwqnoemail.com"}

POST /sapi/v1/sub-account/virtualSubAccount (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
subAccountStringSTRINGYES请输入字符串,我们将为您创建一个虚拟邮箱进行注册
recvWindowLONGNO
timestampLONGYES
  • 该请求会为您的母账户生成一个虚拟子账户
  • 您需要为母账户apikey开通"允许现货及杠杆交易" 权限调用此接口

查询子账户列表(适用主账户)#

响应:

{    "subAccounts":[        {            "email":"testsub@gmail.com",            "isFreeze":false,            "createTime":1544433328000,            "isManagedSubAccount": false,            "isAssetManagementSubAccount": false        },        {            "email":"virtual@oxebmvfonoemail.com",            "isFreeze":false,            "createTime":1544433328000,            "isManagedSubAccount": false,            "isAssetManagementSubAccount": false        }    ]}

GET /sapi/v1/sub-account/list (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGNOSub-account email
isFreezeSTRINGNOtrue or false
pageINTNO默认: 1
limitINTNO默认: 1, 最大: 200
recvWindowLONGNO
timestampLONGYES

查询子账户现货资金划转历史 (适用主账户)#

响应:

[    {        "from":"aaa@test.com",        "to":"bbb@test.com",        "asset":"BTC",        "qty":"10",        "status": "SUCCESS",        "tranId": 6489943656,        "time":1544433328000    },    {        "from":"bbb@test.com",        "to":"ccc@test.com",        "asset":"ETH",        "qty":"2",        "status": "SUCCESS",        "tranId": 6489938713,        "time":1544433328000    }]

GET /sapi/v1/sub-account/sub/transfer/history (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
fromEmailSTRINGNO
toEmailSTRINGNO
startTimeLONGNO
endTimeLONGNO
pageINTNO默认: 1
limitINTNO默认: 500
recvWindowLONGNO
timestampLONGYES
  • fromEmail 和 toEmail 不可以同时发送
  • 若 fromEmail 和 toEmail 都未传,默认返回fromEmail 为母账户的记录。

查询子账户合约资金划转历史 (适用主账户)#

响应

{    "success":true,    "futuresType": 2,    "transfers":[        {            "from":"aaa@test.com",            "to":"bbb@test.com",            "asset":"BTC",            "qty":"1",            "tranId":11897001102,            "time":1544433328000        },        {            "from":"bbb@test.com",            "to":"ccc@test.com",            "asset":"ETH",            "qty":"2",            "tranId":11631474902,            "time":1544433328000        }    ]}

GET /sapi/v1/sub-account/futures/internalTransfer (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
futuresTypeLONGYES1:USDT合约,2: 币本位合约
startTimeLONGNO默认返回100天内历史记录
endTimeLONGNO默认返回100天内历史记录
pageINTNO默认值: 1
limitINTNO默认值: 50, 最大值:500
recvWindowLONGNO
timestampLONGYES

执行子账户合约资金划转 (适用主账户)#

响应

{    "success":true,    "txnId":"2934662589"}

POST /sapi/v1/sub-account/futures/internalTransfer (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
fromEmailSTRINGYES发送者邮箱 备注
toEmailSTRINGYES接收者邮箱 备注
futuresTypeLONGYES1:USDT合约, 2: 币本位合约
assetSTRINGYES
amountDECIMALYES
recvWindowLONGNO
timestampLONGYES
  • 每个母账户每分钟上限2000次
  • 您期货钱包中须有足够保证金余额才能执行转账

查询子账户资产 (适用主账户)#

响应

{    "balances":[        {            "asset":"ADA",            "free":10000,            "locked":0        },        {            "asset":"BNB",            "free":10003,            "locked":0        },        {            "asset":"BTC",            "free":11467.6399,            "locked":0        },        {            "asset":"ETH",            "free":10004.995,            "locked":0        },        {            "asset":"USDT",            "free":11652.14213,            "locked":0        }    ],}

GET /sapi/v3/sub-account/assets (HMAC SHA256)

权重(UID): 60

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
recvWindowLONGNO
timestampLONGYES

查询子账户现货资产汇总 (适用主账户)#

响应:

{    "totalCount":2,    "masterAccountTotalAsset":"0.23231201",    "spotSubUserAssetBtcVoList":[        {            "email":"sub123@test.com",            "totalAsset":"9999.00000000"        },        {            "email":"test456@test.com",            "totalAsset":"0.00000000"        }    ]}

获取BTC计价的子账户现货资产汇总。

GET /sapi/v1/sub-account/spotSummary (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGNO子账户邮箱
pageLONGNO分页,默认 1
sizeLONGNO单页条目数, 默认 10, 最大 20
recvWindowLONGNO
timestampLONGYES

获取子账户充值地址 (适用主账户)#

响应

{    "address":"TDunhSa7jkTNuKrusUTU1MUHtqXoBPKETV",    "coin":"USDT",    "tag":"",    "url":"https://tronscan.org/#/address/TDunhSa7jkTNuKrusUTU1MUHtqXoBPKETV"}

GET /sapi/v1/capital/deposit/subAddress (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
coinSTRINGYES
networkSTRINGNO
recvWindowLONGNO
timestampLONGYES

获取子账户充值记录 (适用主账户)#

响应

[    {        "id": "769800519366885376",        "amount": "0.001",        "coin": "BNB",        "network": "BNB",        "status": 0,        "address": "bnb136ns6lfw4zs5hg4n85vdthaad7hq5m4gtkgf23",        "addressTag": "101764890",        "txId": "98A3EA560C6B3336D348B6C83F0F95ECE4F1F5919E94BD006E5BF3BF264FACFC",        "insertTime": 1661493146000,        "transferType": 0,        "confirmTimes": "1/1",        "unlockConfirm": 0,        "walletType": 0    },    {        "id": "769754833590042625",        "amount":"0.50000000",        "coin":"IOTA",        "network":"IOTA",        "status":1,        "address":"SIZ9VLMHWATXKV99LH99CIGFJFUMLEHGWVZVNNZXRJJVWBPHYWPPBOSDORZ9EQSHCZAMPVAPGFYQAUUV9DROOXJLNW",        "addressTag":"",        "txId":"ESBFVQUTPIWQNJSPXFNHNYHSQNTGKRVKPRABQWTAXCDWOAKDKYWPTVG9BGXNVNKTLEJGESAVXIKIZ9999",        "insertTime":1599620082000,        "transferType":0,        "confirmTimes": "1/1",        "unlockConfirm": 0,        "walletType": 0    }]

GET /sapi/v1/capital/deposit/subHisrec (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
coinSTRINGNO
statusINTNO0(0:pending,6: credited but cannot withdraw,7:Wrong Deposit,8:Waiting User confirm,1:success)
startTimeLONGNO
endTimeLONGNO
limitINTNO
offsetINTNOdefault:0
recvWindowLONGNO
timestampLONGYES
txIdSTRINGNO

查询子账户Margin/Futures状态 (适用主账户)#

响应

[    {        "email":"123@test.com",      // user email        "isSubUserEnabled": true,    // true or false        "isUserActive": true,        // true or false        "insertTime": 1570791523523,  // sub account create time        "isMarginEnabled": true,     // true or false for margin        "isFutureEnabled": true,      // true or false for futures.        "mobile": 1570791523523      // user mobile number    }]

GET /sapi/v1/sub-account/status (HMAC SHA256)

权重(IP): 10

参数:

名称类型是否必需描述
emailSTRINGNO子账户邮箱 备注
recvWindowLONGNO
timestampLONGYES
  • 如果不提交子账户email,返回所有子账户情况。

##为子账户开通Margin (适用主账户)

响应

{
    "email":"123@test.com",    "isMarginEnabled": true
}

POST /sapi/v1/sub-account/margin/enable (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
recvWindowLONGNO
timestampLONGYES

##查询子账户Margin账户详情 (适用主账户)

响应

{      "email":"123@test.com",      "marginLevel": "11.64405625",      "totalAssetOfBtc": "6.82728457",      "totalLiabilityOfBtc": "0.58633215",      "totalNetAssetOfBtc": "6.24095242",      "marginTradeCoeffVo":             {                "forceLiquidationBar": "1.10000000",  // 强平风险率                "marginCallBar": "1.50000000",        // 补仓风险率                "normalBar": "2.00000000"             // 初始风险率            },      "marginUserAssetVoList": [          {              "asset": "BTC",              "borrowed": "0.00000000",              "free": "0.00499500",              "interest": "0.00000000",              "locked": "0.00000000",              "netAsset": "0.00499500"          },          {              "asset": "BNB",              "borrowed": "201.66666672",              "free": "2346.50000000",              "interest": "0.00000000",              "locked": "0.00000000",              "netAsset": "2144.83333328"          },          {              "asset": "ETH",              "borrowed": "0.00000000",              "free": "0.00000000",              "interest": "0.00000000",              "locked": "0.00000000",              "netAsset": "0.00000000"          },          {              "asset": "USDT",              "borrowed": "0.00000000",              "free": "0.00000000",              "interest": "0.00000000",              "locked": "0.00000000",              "netAsset": "0.00000000"          }      ]}

GET /sapi/v1/sub-account/margin/account (HMAC SHA256)

权重(IP): 10

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
recvWindowLONGNO
timestampLONGYES

##查询子账户Margin账户汇总 (适用主账户)

响应

{    "totalAssetOfBtc": "4.33333333",     "totalLiabilityOfBtc": "2.11111112",     "totalNetAssetOfBtc": "2.22222221",    "subAccountList":[        {            "email":"123@test.com",            "totalAssetOfBtc": "2.11111111",            "totalLiabilityOfBtc": "1.11111111",            "totalNetAssetOfBtc": "1.00000000"        },        {             "email":"345@test.com",            "totalAssetOfBtc": "2.22222222",             "totalLiabilityOfBtc": "1.00000001",             "totalNetAssetOfBtc": "1.22222221"        }    ]}

GET /sapi/v1/sub-account/margin/accountSummary (HMAC SHA256)

权重(IP): 10

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES

##为子账户开通Futures (适用主账户)

响应

{
    "email":"123@test.com",    "isFuturesEnabled": true  // true or false
}

POST /sapi/v1/sub-account/futures/enable (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
recvWindowLONGNO
timestampLONGYES

##查询子账户Futures账户详情 (适用主账户)

响应


{    "email": "abc@test.com",    "asset": "USDT",    "assets":[        {            "asset": "USDT",            "initialMargin": "0.00000000",            "maintenanceMargin": "0.00000000",            "marginBalance": "0.88308000",            "maxWithdrawAmount": "0.88308000",            "openOrderInitialMargin": "0.00000000",            "positionInitialMargin": "0.00000000",            "unrealizedProfit": "0.00000000",            "walletBalance": "0.88308000"         }    ],    "canDeposit": true,    "canTrade": true,    "canWithdraw": true,    "feeTier": 2,    "maxWithdrawAmount": "0.88308000",    "totalInitialMargin": "0.00000000",    "totalMaintenanceMargin": "0.00000000",    "totalMarginBalance": "0.88308000",    "totalOpenOrderInitialMargin": "0.00000000",    "totalPositionInitialMargin": "0.00000000",    "totalUnrealizedProfit": "0.00000000",    "totalWalletBalance": "0.88308000",    "updateTime": 1576756674610 }

GET /sapi/v1/sub-account/futures/account (HMAC SHA256)

权重(IP): 10

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
recvWindowLONGNO
timestampLONGYES

##查询子账户Futures账户汇总 (适用主账户)

响应

{    "totalInitialMargin": "9.83137400",     "totalMaintenanceMargin": "0.41568700",     "totalMarginBalance": "23.03235621",     "totalOpenOrderInitialMargin": "9.00000000",    "totalPositionInitialMargin": "0.83137400",    "totalUnrealizedProfit": "0.03219710",    "totalWalletBalance": "22.15879444",    "asset": "USD",  //USDT和BUSD资产汇总    "subAccountList":[        {            "email": "123@test.com",            "totalInitialMargin": "9.00000000",             "totalMaintenanceMargin": "0.00000000",             "totalMarginBalance": "22.12659734",             "totalOpenOrderInitialMargin": "9.00000000",            "totalPositionInitialMargin": "0.00000000",            "totalUnrealizedProfit": "0.00000000",            "totalWalletBalance": "22.12659734",            "asset": "USD"  //USDT和BUSD资产汇总        },        {             "email": "345@test.com",            "totalInitialMargin": "0.83137400",             "totalMaintenanceMargin": "0.41568700",            "totalMarginBalance": "0.90575887",            "totalOpenOrderInitialMargin": "0.00000000",            "totalPositionInitialMargin": "0.83137400",            "totalUnrealizedProfit": "0.03219710",            "totalWalletBalance": "0.87356177",            "asset": "USD"        }    ]}

GET /sapi/v1/sub-account/futures/accountSummary (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
recvWindowLONGNO
timestampLONGYES

##查询子账户合约持仓信息 (仅适用主账户)

响应

[    {        "entryPrice": "9975.12000",        "leverage": "50",              // current initial leverage        "maxNotional": "1000000",      // notional value limit of current initial leverage        "liquidationPrice": "7963.54",        "markPrice": "9973.50770517",        "positionAmount": "0.010",        "symbol": "BTCUSDT",        "unrealizedProfit": "-0.01612295"    }]

GET /sapi/v1/sub-account/futures/positionRisk (HMAC SHA256)

权重(IP): 10

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
recvWindowLONGNO
timestampLONGYES

子账户Futures划转 (仅适用主账户)#

响应

{    "txnId":"2966662589"}

POST /sapi/v1/sub-account/futures/transfer (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
assetSTRINGYES划转资产, e.g., USDT
amountDECIMALYES划转数量
typeINTYES1: 由子账户的现货账户划转至其USDT本位合约账户; 2: 由子账户的USDT本位合约账户划转至其现货账户; 3:由子账户现货账户划转至其COIN本位合约账户;4: 由子账户COIN本位合约账户划转至其现货账户
recvWindowLONGNO
timestampLONGYES
  • 您需要打开 API Key 的 Spot & Margin Trading 权限以使用此接口。

子账户Margin划转 (仅适用主账户)#

响应

{    "txnId":"2966662589"}

POST /sapi/v1/sub-account/margin/transfer (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
assetSTRINGYES划转资产, e.g., USDT
amountDECIMALYES划转数量
typeINTYES1: 由子账户的现货账户划转至其杠杆账户; 2: 由子账户的杠杆账户划转至其现货账户
recvWindowLONGNO
timestampLONGYES
  • 您需要打开 API Key 的 Spot & Margin Trading 权限以使用此接口。

向共同主账户下的子账户主动划转 (仅适用子账户)#

响应

{    "txnId":"2966662589"}

POST /sapi/v1/sub-account/transfer/subToSub (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
toEmailSTRINGYES接收者子邮箱地址 备注
assetSTRINGYES
amountDECIMALYES
recvWindowLONGNO
timestampLONGYES
  • 您需要打开 API Key 的 Spot & Margin Trading 权限以使用此接口。

向主账户主动划转 (仅适用子账户)#

响应

{    "txnId":"2966662589"}

POST /sapi/v1/sub-account/transfer/subToMaster (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
assetSTRINGYES
amountDECIMALYES
recvWindowLONGNO
timestampLONGYES
  • 您需要打开 API Key 的 Spot & Margin Trading 权限以使用此接口。

查询子账户划转历史 (仅适用子账户)#

响应

[  {    "counterParty":"master",    "email":"master@test.com",    "type":1,  // 1 for transfer in , 2 for transfer out    "asset":"BTC",    "qty":"1",    "fromAccountType":"SPOT",    "toAccountType":"SPOT",    "status":"SUCCESS", // status: PROCESS / SUCCESS / FAILURE    "tranId":11798835829,    "time":1544433325000  },  {    "counterParty": "subAccount",    "email": "sub2@test.com",    "type":  1,                                     "asset":"ETH",    "qty":"2",    "fromAccountType":"SPOT",    "toAccountType":"SPOT",    "status":"SUCCESS",    "tranId":11798829519,    "time":1544433326000  }]

GET /sapi/v1/sub-account/transfer/subUserHistory (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
assetSTRINGNO如不提供,返回所有asset 划转记录
typeINTNO1: transfer in, 2: transfer out; 如不提供,返回transfer out方向划转记录
startTimeLONGNO
endTimeLONGNO
limitINTNO默认值: 500
recvWindowLONGNO
timestampLONGYES
  • 如果startTime和endTime均未发送,默认只返回最近30天数据

子母账户万能划转 (适用主账户)#

响应

{    "tranId":11945860693,    "clientTranId":"test"}

POST /sapi/v1/sub-account/universalTransfer (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
fromEmailSTRINGNO
toEmailSTRINGNO
fromAccountTypeSTRINGYES"SPOT","USDT_FUTURE","COIN_FUTURE","MARGIN"(Cross),"ISOLATED_MARGIN"
toAccountTypeSTRINGYES"SPOT","USDT_FUTURE","COIN_FUTURE","MARGIN"(Cross),"ISOLATED_MARGIN"
clientTranIdSTRINGNO不可重复
symbolSTRINGNO仅在ISOLATED_MARGIN类型下使用
assetSTRINGYES
amountDECIMALYES
recvWindowLONGNO
timestampLONGYES
  • 需要开启母账户apikey“允许子母账户划转”权限。
  • 若 fromEmail 未传,默认从母账户转出。
  • 若 toEmail 未传,默认转入母账户。
  • 最少指定fromEmail和toEmail 其中之一。
  • 该接口支持的划转操作有:
    • 现货账户划转到现货账户U本位合约账户币本位合约账户(无论母账户或子账户)
    • 现货账户U本位合约账户币本位合约账户划转到现货账户(无论母账户或子账户)
    • 母账户现货账户划转到子账户杠杆全仓账户杠杆逐仓账户
    • 子账户杠杆全仓账户杠杆逐仓账户划转到母账户现货账户

查询子母账户万能划转历史 (适用主账户)#

响应

{    "result": [        {            "tranId": 92275823339,            "fromEmail": "abctest@gmail.com",            "toEmail": "deftest@gmail.com",            "asset": "BNB",            "amount": "0.01",            "createTimeStamp": 1640317374000,            "fromAccountType": "USDT_FUTURE",            "toAccountType": "SPOT",            "status": "SUCCESS",            "clientTranId": "test"        }    ],    "totalCount": 1}

GET /sapi/v1/sub-account/universalTransfer (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
fromEmailSTRINGNO
toEmailSTRINGNO
clientTranIdSTRINGNO
startTimeLONGNO
endTimeLONGNO
pageINTNO默认 1
limitINTNO默认 500, 最大 500
recvWindowLONGNO
timestampLONGYES
  • 本查询接口只可以单边查询,fromEmail 和 toEmail 不能同时传入。
  • 若 fromEmail 和 toEmail 都未传,默认返回 fromEmail 为母账户的划转记录。
  • 若 startTime 和 endTime 都未传,则只可查询最近30天的记录。
  • 查询时间范围最大不得超过30天。

##查询子账户Futures账户详情V2 (适用主账户)

响应

USDT Margined Futures:


{    "futureAccountResp": {    "email": "abc@test.com",    "assets":[        {            "asset": "USDT",            "initialMargin": "0.00000000",            "maintenanceMargin": "0.00000000",            "marginBalance": "0.88308000",            "maxWithdrawAmount": "0.88308000",            "openOrderInitialMargin": "0.00000000",            "positionInitialMargin": "0.00000000",            "unrealizedProfit": "0.00000000",            "walletBalance": "0.88308000"         }    ],    "canDeposit": true,    "canTrade": true,    "canWithdraw": true,    "feeTier": 2,    "maxWithdrawAmount": "0.88308000",    "totalInitialMargin": "0.00000000",    "totalMaintenanceMargin": "0.00000000",    "totalMarginBalance": "0.88308000",    "totalOpenOrderInitialMargin": "0.00000000",    "totalPositionInitialMargin": "0.00000000",    "totalUnrealizedProfit": "0.00000000",    "totalWalletBalance": "0.88308000",    "updateTime": 1576756674610 }

COIN Margined Futures:


{    "deliveryAccountResp": {        "email": "abc@test.com",        "assets":[            {                "asset": "BTC",                "initialMargin": "0.00000000",                "maintenanceMargin": "0.00000000",                "marginBalance": "0.88308000",                "maxWithdrawAmount": "0.88308000",                "openOrderInitialMargin": "0.00000000",                "positionInitialMargin": "0.00000000",                "unrealizedProfit": "0.00000000",                "walletBalance": "0.88308000"             }        ],        "canDeposit": true,        "canTrade": true,        "canWithdraw": true,        "feeTier": 2,        "updateTime": 1598959682001    } }

GET /sapi/v2/sub-account/futures/account (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
futuresTypeINTYES1:USDT Margined Futures, 2:COIN Margined Futures
recvWindowLONGNO
timestampLONGYES

##查询子账户Futures账户汇总V2 (适用主账户)

响应

USDT Margined Futures:

{  "futureAccountSummaryResp": {    "totalInitialMargin": "9.83137400",     "totalMaintenanceMargin": "0.41568700",     "totalMarginBalance": "23.03235621",     "totalOpenOrderInitialMargin": "9.00000000",    "totalPositionInitialMargin": "0.83137400",    "totalUnrealizedProfit": "0.03219710",    "totalWalletBalance": "22.15879444",    "asset": "USD",  //USDT和BUSD资产汇总    "subAccountList":[        {            "email": "123@test.com",            "totalInitialMargin": "9.00000000",             "totalMaintenanceMargin": "0.00000000",             "totalMarginBalance": "22.12659734",             "totalOpenOrderInitialMargin": "9.00000000",            "totalPositionInitialMargin": "0.00000000",            "totalUnrealizedProfit": "0.00000000",            "totalWalletBalance": "22.12659734",            "asset": "USD"  //USDT和BUSD资产汇总        },        {             "email": "345@test.com",            "totalInitialMargin": "0.83137400",             "totalMaintenanceMargin": "0.41568700",            "totalMarginBalance": "0.90575887",            "totalOpenOrderInitialMargin": "0.00000000",            "totalPositionInitialMargin": "0.83137400",            "totalUnrealizedProfit": "0.03219710",            "totalWalletBalance": "0.87356177",            "asset": "USD"        }    ]}

COIN Margined Futures:

{  "deliveryAccountSummaryResp": {    "totalMarginBalanceOfBTC": "25.03221121",     "totalUnrealizedProfitOfBTC": "0.12233410",    "totalWalletBalanceOfBTC": "22.15879444",    "asset": "BTC",    "subAccountList":[        {            "email": "123@test.com",            "totalMarginBalance": "22.12659734",             "totalUnrealizedProfit": "0.00000000",            "totalWalletBalance": "22.12659734",            "asset": "BTC"        },        {             "email": "345@test.com",            "totalMarginBalance": "0.90575887",            "totalUnrealizedProfit": "0.03219710",            "totalWalletBalance": "0.87356177",            "asset": "BTC"        }    ]  }}

GET /sapi/v2/sub-account/futures/accountSummary (HMAC SHA256)

权重(IP): 10

参数:

名称类型是否必需描述
futuresTypeINTYES1:USDT Margined Futures, 2:COIN Margined Futures
pageINTNOdefault:1
limitINTNOdefault:10, max:20
recvWindowLONGNO
timestampLONGYES

##查询子账户合约持仓信息V2 (仅适用主账户)

响应

USDT Margined Futures:

{  "futurePositionRiskVos": [     {        "entryPrice": "9975.12000",        "leverage": "50",              // current initial leverage        "maxNotional": "1000000",      // notional value limit of current initial leverage        "liquidationPrice": "7963.54",        "markPrice": "9973.50770517",        "positionAmount": "0.010",        "symbol": "BTCUSDT",        "unrealizedProfit": "-0.01612295"     }   ]}

COIN Margined Futures:

{  "deliveryPositionRiskVos": [     {        "entryPrice": "9975.12000",        "markPrice": "9973.50770517",        "leverage": "20",                  "isolated": "false",                        "isolatedWallet": "9973.50770517",        "isolatedMargin": "0.00000000",        "isAutoAddMargin": "false",        "positionSide": "BOTH",        "positionAmount": "1.230",        "symbol": "BTCUSD_201225",        "unrealizedProfit": "-0.01612295"     }   ]}

GET /sapi/v2/sub-account/futures/positionRisk (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES子账户邮箱 备注
futuresTypeINTYES1:USDT Margined Futures, 2:COIN Margined Futures
recvWindowLONGNO
timestampLONGYES

为子账户开通杠杆代币 (适用母账户)#

响应

{    "email":"123@test.com",    "enableBlvt":true}

POST /sapi/v1/sub-account/blvt/enable (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYESSub-account email
enableBlvtBOOLEANYESOnly true for now
recvWindowLONGNO
timestampLONGYES

查询子账户API Key IP白名单 (适用母账户)#

响应:

{    "ipRestrict": "true",    "ipList": [        "69.210.67.14",        "8.34.21.10"    ],    "updateTime": 1636371437000,    "apiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf"}

GET /sapi/v1/sub-account/subAccountApi/ipRestriction (HMAC SHA256)

权重(UID): 3000

参数:

名称类型是否必需描述
emailSTRINGYESSub-account email
subAccountApiKeySTRINGYES
recvWindowLONGNO
timestampLONGYES

删除子账户API Key IP白名单 (适用母账户)#

响应:

{  "ipRestrict": "true",  "ipList": [    "69.210.67.14",    "8.34.21.10"  ],  "updateTime": 1636371437000,  "apiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf"}

DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList (HMAC SHA256)

权重(UID): 3000

参数:

名称类型是否必需描述
emailSTRINGYESSub-account email
subAccountApiKeySTRINGYES
ipAddressSTRINGNO可批量删除,用逗号分隔
recvWindowLONGNO
timestampLONGYES
  • 调用此端口前需要在api管理页开启允许现货及杠杆交易选项

为子账户API Key增加IP白名单 (适用母账户)#

响应:

{  "status": "2",   "ipList": [    "69.210.67.14",    "8.34.21.10",  //只当您有开启IP白名单且添加了IP白名单地址时才返回  ],  "updateTime": 1636371437000,  "apiKey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf"}

POST /sapi/v2/sub-account/subAccountApi/ipRestriction (HMAC SHA256)

权重(UID): 3000

参数:

名称类型是否必需描述
emailSTRINGYESSub-account email
subAccountApiKeySTRINGYES
statusSTRINGYESIP限制状态。1或不填入(null) = IP未受限。2 = 仅限受信任IP访问。
ipAddressSTRINGNO可批量填入IP,以逗号区隔
recvWindowLONGNO
timestampLONGYES
  • 调用此端口前需要在api管理页开启允许现货及杠杆交易选项

投资人账户为托管子账户充值资产 (适用投资人母账户)#

响应

{    "tranId":66157362489}

POST /sapi/v1/managed-subaccount/deposit (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
toEmailSTRINGYES
assetSTRINGYES
amountDECIMALYES
recvWindowLONGNO
timestampLONGYES
  • 您需要开通API Key允许现货和杠杆交易权限

投资人账户查询托管子账户资产 (适用投资人母账户)#

响应

[  {     "coin": "INJ",                //币种     "name": "Injective Protocol", //名称     "totalBalance": "0",          //总资产     "availableBalance": "0",      //可用资产     "inOrder": "0",               //下单冻结     "btcValue": "0"               //btc估值  },  {     "coin": "FILDOWN",     "name": "FILDOWN",     "totalBalance": "0",     "availableBalance": "0",     "inOrder": "0",     "btcValue": "0"   }]

GET /sapi/v1/managed-subaccount/asset (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES
recvWindowLONGNO
timestampLONGYES

投资人账户为托管子账户提币资产 (适用投资人母账户)#

响应

{    "tranId":66157362489}

POST /sapi/v1/managed-subaccount/withdraw (HMAC SHA256)

权重(IP): 1

参数:

名称类型是否必需描述
fromEmailSTRINGYES
assetSTRINGYES
amountDECIMALYES
transferDateLONGNO提币会自动发生在选择的日期(UTC0),如果没有选择日期,提币会立即生效
recvWindowLONGNO
timestampLONGYES
  • 您需要开通API Key允许现货和杠杆交易权限

查询托管子账户资产快照 (适用投资人母账户)#

响应

{   "code":200, // 200表示返回正确,否则即为错误码   "msg":"", // 与错误码对应的报错信息   "snapshotVos":[      {         "data":{            "balances":[               {                  "asset":"BTC",                  "free":"0.09905021",                  "locked":"0.00000000"               },               {                  "asset":"USDT",                  "free":"1.89109409",                  "locked":"0.00000000"               }            ],            "totalAssetOfBtc":"0.09942700"         },         "type":"spot",         "updateTime":1576281599000      }   ]}

{   "code":200, // 200表示返回正确,否则即为错误码   "msg":"", // 与错误码对应的报错信息   "snapshotVos":[      {         "data":{            "marginLevel":"2748.02909813",            "totalAssetOfBtc":"0.00274803",            "totalLiabilityOfBtc":"0.00000100",            "totalNetAssetOfBtc":"0.00274750",            "userAssets":[               {                  "asset":"XRP",                  "borrowed":"0.00000000",                  "free":"1.00000000",                  "interest":"0.00000000",                  "locked":"0.00000000",                  "netAsset":"1.00000000"               }            ]         },         "type":"margin",         "updateTime":1576281599000      }   ]}

{   "code":200, // 200表示返回正确,否则即为错误码   "msg":"", // 与错误码对应的报错信息   "snapshotVos":[      {         "data":{            "assets":[               {                  "asset":"USDT",                  "marginBalance":"118.99782335",                  "walletBalance":"120.23811389"               }            ],            "position":[               {                  "entryPrice":"7130.41000000",                  "markPrice":"7257.66239673",                  "positionAmt":"0.01000000",                  "symbol":"BTCUSDT",                  "unRealizedProfit":"1.24029054" //只显示开仓当时的未实现盈亏,不会实时更新,可以忽略               }            ]         },         "type":"futures",         "updateTime":1576281599000      }   ]}

GET /sapi/v1/managed-subaccount/accountSnapshot (HMAC SHA256)

权重(IP): 2400

参数:

名称类型是否必需描述
emailSTRINGYES
typeSTRINGYES"SPOT"(现货), "MARGIN"(全仓), "FUTURES"(U本位合约)
startTimeLONGNO
endTimeLONGNO
limitINTNOmin 7, max 30, default 7
recvWindowLONGNO
timestampLONGYES
  • 查询时间范围最大不得超过30天
  • 仅支持查询最近 1 个月数据
  • 若startTime和endTime没传,则默认返回最近7天数据

查询托管子账户的划转记录(适用投资人母账户) (USER_DATA)#

响应

{    managerSubTransferHistoryVos: [        0: {            fromEmail: "test_0_virtual@kq3kno9imanagedsub.com"            fromAccountType: "SPOT"            toEmail: "wdywl0lddakh@test.com"            toAccountType: "SPOT"            asset: "BNB"            amount: "0.01"            scheduledData: 1679416673000            createTime: 1679416673000            status: "SUCCESS"            tranId: 91077779        }        1: {            fromEmail: "wdywl0lddakh@test.com"            fromAccountType: "SPOT"            toEmail: "test_0_virtual@kq3kno9imanagedsub.com"            toAccountType: "SPOT"            asset: "BNB"            amount: "1"            scheduledData: 1679416616000            createTime: 1679416616000            status: "SUCCESS"            tranId: 91077676        }    ]    count: 2}

GET /sapi/v1/managed-subaccount/queryTransLogForInvestor (HMAC SHA256)

投资人可以根据此接口查询其托管子账户划转记录。此接口可供托管子账户的投资者使用。托管子账户是为重视资产配置与账户应用灵活性,并同时将交易委托专业交易团队的投资者的子账户类型。 请参阅链接

权重(UID): 60

参数:

名称类型是否必需描述
emailSTRINGYES托管子账户邮箱
startTimeLONGYES开始时间
endTimeLONGYES结束时间(开始时间结束时间间隔不能超过半年)
pageINTYES页数
limitINTYES每页数量 (最大值: 500)
transfersSTRINGNO划转方向 (FROM/TO)
transferFunctionAccountTypeSTRINGNO划转账户类型 (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE)

查询托管子账户的划转记录(适用交易团队母账户)(USER_DATA)#

响应

{    managerSubTransferHistoryVos: [        0: {            fromEmail: "test_0_virtual@kq3kno9imanagedsub.com"            fromAccountType: "SPOT"            toEmail: "wdywl0lddakh@test.com"            toAccountType: "SPOT"            asset: "BNB"            amount: "0.01"            scheduledData: 1679416673000            createTime: 1679416673000            status: "SUCCESS"            tranId: 91077779        }        1: {            fromEmail: "wdywl0lddakh@test.com"            fromAccountType: "SPOT"            toEmail: "test_0_virtual@kq3kno9imanagedsub.com"            toAccountType: "SPOT"            asset: "BNB"            amount: "1"            scheduledData: 1679416616000            createTime: 1679416616000            status: "SUCCESS"            tranId: 91077676        }    ]    count: 2}

GET /sapi/v1/managed-subaccount/queryTransLogForTradeParent (HMAC SHA256)

交易团队可以根据此接口查询其托管子账户划转记录。此接口可供托管子账户的交易团队使用。托管子账户是为重视资产配置与账户应用灵活性,并同时将交易委托专业交易团队的投资者的子账户类型。 请参阅链接

权重(UID): 60

参数:

名称类型是否必需描述
emailSTRINGYES托管子账户邮箱
startTimeLONGYES开始时间
endTimeLONGYES结束时间(开始时间结束时间间隔不能超过半年)
pageINTYES页数
limitINTYES每页数量 (最大值: 500)
transfersSTRINGNO划转方向 (FROM/TO)
transferFunctionAccountTypeSTRINGNO划转账户类型 (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE)

投资人账户查询托管子账户期货资产 (适用投资人母账户) (USER_DATA)#

响应

{  "code": "200",  "message": "OK",  "snapshotVos": [    {      "type": "FUTURES",      "updateTime": 1672893855394,      "data": {        "assets": [          {            "asset": "USDT",            "marginBalance": 100,            "walletBalance": 120          }        ],        "position": [          {            "symbol": "BTCUSDT",            "entryPrice": 17000,            "markPrice": 17000,            "positionAmt": 0.0001          }        ]      }    }  ]}

GET /sapi/v1/managed-subaccount/fetch-future-asset (HMAC SHA256)

投资人可以根据此接口查询其托管子账户期货资产

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES托管子账户邮箱

投资人账户查询托管子账户杠杆资产 (适用投资人母账户) (USER_DATA)#

响应

{  marginLevel:"999"  totalAssetOfBtc:"0"  totalLiabilityOfBtc:"0"  totalNetAssetOfBtc:"0"  userAssets:[    0:{    asset:"MATIC"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    1:{    asset:"VET"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    2:{    asset:"BAKE"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    3:{    asset:"SHIB"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    4:{    asset:"USDT"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    5:{    asset:"DOGE"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    6:{    asset:"AAVE"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    7:{    asset:"ONT"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    8:{    asset:"XRP"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    9:{    asset:"XLM"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    10:{    asset:"LINK"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    11:{    asset:"QTUM"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    12:{    asset:"ETHW"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    13:{    asset:"XTZ"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    14:{    asset:"LUNA"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    15:{    asset:"EUR"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    16:{    asset:"IOST"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    17:{    asset:"BCH"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    18:{    asset:"BTC"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    19:{    asset:"IOTA"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    20:{    asset:"CREAM"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    21:{    asset:"BAT"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    22:{    asset:"BNB"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    23:{    asset:"ETH"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    24:{    asset:"ZEC"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    25:{    asset:"USDC"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    26:{    asset:"LTC"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    27:{    asset:"BUSD"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    28:{    asset:"ZIL"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }    29:{    asset:"THETA"    borrowed:"0"    free:"0"    interest:"0"    locked:"0"    netAsset:"0"    }  ]}

GET /sapi/v1/managed-subaccount/marginAsset (HMAC SHA256)

投资人可以根据此接口查询其托管子账户杠杆资产

权重(IP): 1

参数:

名称类型是否必需描述
emailSTRINGYES托管子账户邮箱

查询子账户资产(适用主账户)(USER_DATA)#

响应

{    "balances":[        {            "asset":"ADA",            "free":"10000",            "locked":"0"        },        {            "asset":"BNB",            "free":"10003",            "locked":"0"        },        {            "asset":"BTC",            "free":"11467.6399",            "locked":"0"        }    ]}

GET /sapi/v4/sub-account/assets (HMAC SHA256)

获取子账户资产

权重(UID): 60

参数:

名称类型是否必需描述
emailSTRINGYES托管子账户邮箱
recvWindowLONGNO
timestampLONGYES

查询托管子账户列表 (适用投资人母账户)(USER_DATA)#

响应

{    "total": 3,    "managerSubUserInfoVoList": [        {            "rootUserId": 1000138475670,            "managersubUserId": 1000137842513,            "bindParentUserId": 1000138475669,            "email": "test_0_virtual@kq3kno9imanagedsub.com",            "insertTimeStamp": 1678435149000,            "bindParentEmail": "wdyw8xsh8pey@test.com",            "isSubUserEnabled": true,            "isUserActive": true,            "isMarginEnabled": false,            "isFutureEnabled": false,            "isSignedLVTRiskAgreement": false        },        {            "rootUserId": 1000138475670,            "managersubUserId": 1000137842514,            "bindParentUserId": 1000138475669,            "email": "test_1_virtual@4qd2u7zxmanagedsub.com",            "insertTimeStamp": 1678435152000,            "bindParentEmail": "wdyw8xsh8pey@test.com",            "isSubUserEnabled": true,            "isUserActive": true,            "isMarginEnabled": false,            "isFutureEnabled": false,            "isSignedLVTRiskAgreement": false        },        {            "rootUserId": 1000138475670,            "managersubUserId": 1000137842515,            "bindParentUserId": 1000138475669,            "email": "test_2_virtual@akc05o8hmanagedsub.com",            "insertTimeStamp": 1678435153000,            "bindParentEmail": "wdyw8xsh8pey@test.com",            "isSubUserEnabled": true,            "isUserActive": true,            "isMarginEnabled": false,            "isFutureEnabled": false,            "isSignedLVTRiskAgreement": false        }    ]}

GET /sapi/v1/managed-subaccount/info (HMAC SHA256)

获取投资人之托管子账户列表

权重(UID): 60

参数:

名称类型是否必需描述
emailSTRINGNO托管子账户邮箱
pageINTNO默认值: 1
limitINTNO默认值: 20, 最大值: 20
recvWindowLONGNO
timestampLONGYES

查询子账户交易量统计列表 (适用母账户)(USER_DATA)#

响应

{    "recent30BtcTotal": "0",    "recent30BtcFuturesTotal": "0",    "recent30BtcMarginTotal": "0",    "recent30BusdTotal": "0",    "recent30BusdFuturesTotal": "0",    "recent30BusdMarginTotal": "0",    "tradeInfoVos": []}{    "recent30BtcTotal": "0",    "recent30BtcFuturesTotal": "0",    "recent30BtcMarginTotal": "0",    "recent30BusdTotal": "0",    "recent30BusdFuturesTotal": "0",    "recent30BusdMarginTotal": "0",    "tradeInfoVos": [        {            "userId": 1000138138384,            "btc": 0,            "btcFutures": 0,            "btcMargin": 0,            "busd": 0,            "busdFutures": 0,            "busdMargin": 0,            "date": 1676851200000        },        {            "userId": 1000138138384,            "btc": 0,            "btcFutures": 0,            "btcMargin": 0,            "busd": 0,            "busdFutures": 0,            "busdMargin": 0,            "date": 1676937600000        },        {            "userId": 1000138138384,            "btc": 0,            "btcFutures": 0,            "btcMargin": 0,            "busd": 0,            "busdFutures": 0,            "busdMargin": 0,            "date": 1677024000000        }    ]}

GET /sapi/v1/sub-account/transaction-statistics (HMAC SHA256)

查询子账户交易量统计列表 (适用母账户)

权重(UID): 60

参数:

名称类型是否必需描述
emailSTRINGYes子账户邮箱
recvWindowLONGNO
timestampLONGYES

获取托管子账户充值地址 (适用投资人母账户)(USER_DATA)#

响应

{    "coin": "USDT",    "address": "0x206c22d833bb0bb2102da6b7c7d4c3eb14bcf73d",    "tag": "",    "url": "https://etherscan.io/address/0x206c22d833bb0bb2102da6b7c7d4c3eb14bcf73d"}

GET /sapi/v1/managed-subaccount/deposit/address (HMAC SHA256)

获取投资人之托管子账户充值地址

权重(UID): 1

参数:

名称类型是否必需描述
emailSTRINGYES托管子账户邮箱
coinSTRINGYES
networkSTRINGNO网络可以在GET /sapi/v1/capital/deposit/address获取
recvWindowLONGNO
timestampLONGYES
  • network不传时,返回该coin默认的network.

行情接口

测试服务器连通性#

响应

{}

GET /api/v3/ping

测试能否联通 Rest API。

权重(IP): 1

参数:

NONE

数据源: 缓存

获取服务器时间#

响应

{  "serverTime": 1499827319559}

GET /api/v3/time

测试能否联通 Rest API 并 获取服务器时间。

权重(IP): 1

参数:

NONE

数据源: 缓存

交易规范信息#

响应

{    "timezone": "UTC",    "serverTime": 1565246363776,    "rateLimits": [        {            //这些在"限制种类 (rateLimitType)"下的"枚举定义"部分中定义            //所有限制都是可选的        }    ],    "exchangeFilters": [            //这些是"过滤器"部分中定义的过滤器            //所有限制都是可选的    ],    "symbols": [        {            "symbol": "ETHBTC",            "status": "TRADING",            "baseAsset": "ETH",            "baseAssetPrecision": 8,            "quoteAsset": "BTC",            "quotePrecision": 8,            "quoteAssetPrecision": 8,            "orderTypes": [                "LIMIT",                "LIMIT_MAKER",                "MARKET",                "STOP_LOSS",                "STOP_LOSS_LIMIT",                "TAKE_PROFIT",                "TAKE_PROFIT_LIMIT"            ],            "icebergAllowed": true,            "ocoAllowed": true,            "quoteOrderQtyMarketAllowed": false,            "allowTrailingStop": false,            "isSpotTradingAllowed": true,            "isMarginTradingAllowed": true,            "cancelReplaceAllowed": false,            "filters": [                //这些在"过滤器"部分中定义                //所有限制都是可选的            ],            "permissions": [              "SPOT",              "MARGIN"            ],            "defaultSelfTradePreventionMode": "NONE",            "allowedSelfTradePreventionModes": [              "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"
或者
curl -g -X GET 'https://api.binance.com/api/v3/exchangeInfo?symbols=["BTCUSDT","BNBBTC"]'
交易权限curl -X GET "https://api.binance.com/api/v3/exchangeInfo?permissions=SPOT"
或者
curl -X GET "https://api.binance.com/api/v3/exchangeInfo?permissions=%5B%22MARGIN%22%2C%22LEVERAGED%22%5D"
或者
curl -g -X GET 'https://api.binance.com/api/v3/exchangeInfo?permissions=["MARGIN","LEVERAGED"]'

备注:

  • 如果参数 symbol 或者 symbols 提供的交易对不存在, 系统会返回错误并提示交易对不正确.
  • 所有的参数都是可选的.
  • permissions 支持单个或者多个值, 比如 SPOT, ["MARGIN","LEVERAGED"].
  • 如果permissions值没有提供, 其默认值为 ["SPOT","MARGIN","LEVERAGED"].
    • 如果想取接口 GET /api/v3/exchangeInfo 的所有交易对, 则需要设置此参数的所有可能交易权限值, 比如 permissions=["SPOT","MARGIN","LEVERAGED","TRD_GRP_002","TRD_GRP_003","TRD_GRP_004","TRD_GRP_005","TRD_GRP_006","TRD_GRP_007"])

数据源: 缓存

深度信息#

响应

{  "lastUpdateId": 1027024,  "bids": [    [      "4.00000000",     // 价位      "431.00000000"    // 挂单量    ]  ],  "asks": [    [      "4.00000200",      "12.00000000"    ]  ]}

GET /api/v3/depth

权重(IP):

基于限制调整:

限制权重
1-1001
101-5005
501-100010
1001-500050

参数:

名称类型是否必需描述
symbolSTRINGYES
limitINTNO默认 100; 最大 5000. 可选值:[5, 10, 20, 50, 100, 500, 1000, 5000]
如果 limit > 5000, 最多返回5000条数据.

数据源: 缓存

近期成交列表#

响应

[  {    "id": 28457,    "price": "4.00000100",    "qty": "12.00000000",    "time": 1499865549590, // 交易成交时间, 和websocket中的T一致.    "isBuyerMaker": true,    "isBestMatch": true  }]

GET /api/v3/trades

获取近期成交

权重(IP): 1

参数:

名称类型是否必需描述
symbolSTRINGYES
limitINTNO默认 500; 最大值 1000.

数据源: 缓存

查询历史成交 (MARKET_DATA)#

响应

[  {    "id": 28457,    "price": "4.00000100",    "qty": "12.00000000",    "quoteQty": "48.000012",    "time": 1499865549590,    "isBuyerMaker": true,    "isBestMatch": true  }]

GET /api/v3/historicalTrades

获取历史成交。

权重(IP): 5

参数:

名称类型是否必需描述
symbolSTRINGYES
limitINTNO默认 500; 最大值 1000.
fromIdLONGNO从哪一条成交id开始返回. 缺省返回最近的成交记录。

数据源: 数据库

近期成交(归集)#

响应

[  {    "a": 26129,         // 归集成交ID    "p": "0.01633102",  // 成交价    "q": "4.70443515",  // 成交量    "f": 27781,         // 被归集的首个成交ID    "l": 27781,         // 被归集的末个成交ID    "T": 1498793709153, // 成交时间    "m": true,          // 是否为主动卖出单    "M": true           // 是否为最优撮合单(可忽略,目前总为最优撮合)  }]

GET /api/v3/aggTrades

归集交易与逐笔交易的区别在于,同一价格、同一方向、同一时间的trade会被聚合为一条

权重(IP): 1

参数:

名称类型是否必需描述
symbolSTRINGYES
fromIdLONGNO从包含fromId的成交id开始返回结果
startTimeLONGNO从该时刻之后的成交记录开始返回结果
endTimeLONGNO返回该时刻为止的成交记录
limitINTNO默认 500; 最大 1000.
  • 如果没有发送任何筛选参数(fromId, startTime,endTime),默认返回最近的成交记录
  • 如果一个trade有下面的值,表示这是一个重复的记录,并被标记为无效(invalid):
    • p = '0' // price
    • q = '0' // qty
    • f = -1 // first_trade_id
    • l = -1 // last_trade_id

数据源: 数据库

K线数据#

响应

[  [    1499040000000,      // k线开盘时间    "0.01634790",       // 开盘价    "0.80000000",       // 最高价    "0.01575800",       // 最低价    "0.01577100",       // 收盘价(当前K线未结束的即为最新价)    "148976.11427815",  // 成交量    1499644799999,      // k线收盘时间    "2434.19055334",    // 成交额    308,                // 成交笔数    "1756.87402397",    // 主动买入成交量    "28.46694368",      // 主动买入成交额    "17928899.62484339" // 请忽略该参数  ]]

GET /api/v3/klines

每根K线代表一个交易对。
每根K线的开盘时间可视为唯一ID

权重(IP): 1

参数:

名称类型是否必需描述
symbolSTRINGYES
intervalENUMYES详见枚举定义:K线间隔
startTimeLONGNO
endTimeLONGNO
limitINTNO默认 500; 最大 1000.
  • 如果未发送 startTime 和 endTime ,默认返回最近的交易。

数据源: 数据库

当前平均价格#

响应

{  "mins": 5,  "price": "9.35751834"}

GET /api/v3/avgPrice

权重(IP): 1

参数:

名称类型是否必需描述
symbolSTRINGYES

数据源: 缓存

UIK线数据#

响应

[  [    1499040000000,      // k线开盘时间    "0.01634790",       // 开盘价    "0.80000000",       // 最高价    "0.01575800",       // 最低价    "0.01577100",       // 收盘价(当前K线未结束的即为最新价)    "148976.11427815",  // 成交量    1499644799999,      // k线收盘时间    "2434.19055334",    // 成交额    308,                // 成交笔数    "1756.87402397",    // 主动买入成交量    "28.46694368",      // 主动买入成交额    "0" // 请忽略该参数  ]]

GET /api/v3/uiKlines

请求参数与响应和k线接口相同。

uiKlines 返回修改后的k线数据,针对k线图的呈现进行了优化。

权重(IP): 1

参数:

名称类型是否必需描述
symbolSTRINGYES
intervalENUMYES
startTimeLONGNO
endTimeLONGNO
limitINTNO默认 500; 最大 1000.
  • 如果未发送 startTime 和 endTime ,默认返回最近的交易。

数据源: 数据库

24hr 价格变动情况#

响应 - FULL

{  "symbol": "BNBBTC",  "priceChange": "-94.99999800",  "priceChangePercent": "-95.960",  "weightedAvgPrice": "0.29628482",  "prevClosePrice": "0.10002000",  "lastPrice": "4.00000200",  "lastQty": "200.00000000",  "bidPrice": "4.00000000",  "bidQty": "100.00000000",  "askPrice": "4.00000200",  "askQty": "100.00000000",  "openPrice": "99.00000000",  "highPrice": "100.00000000",  "lowPrice": "0.10000000",  "volume": "8913.30000000",  "quoteVolume": "15.30000000",  "openTime": 1499783499040,  "closeTime": 1499869899040,  "firstId": 28385,   // 首笔成交id  "lastId": 28460,    // 末笔成交id  "count": 76         // 成交笔数}

OR

[  {    "symbol": "BNBBTC",    "priceChange": "-94.99999800",    "priceChangePercent": "-95.960",    "weightedAvgPrice": "0.29628482",    "prevClosePrice": "0.10002000",    "lastPrice": "4.00000200",    "lastQty": "200.00000000",    "bidPrice": "4.00000000",    "bidQty": "100.00000000",    "askPrice": "4.00000200",    "askQty": "100.00000000",    "openPrice": "99.00000000",    "highPrice": "100.00000000",    "lowPrice": "0.10000000",    "volume": "8913.30000000",    "quoteVolume": "15.30000000",    "openTime": 1499783499040,    "closeTime": 1499869899040,    "firstId": 28385,      "lastId": 28460,       "count": 76        }]

Response - MINI

{  "symbol":      "BNBBTC",          // 交易对  "openPrice":   "99.00000000",     // 间隔开盘价  "highPrice":   "100.00000000",    // 间隔最高价  "lowPrice":    "0.10000000",      // 间隔最低价  "lastPrice":   "4.00000200",      // 间隔收盘价  "volume":      "8913.30000000",   // 总交易量 (base asset)  "quoteVolume": "15.30000000",     // 总交易量 (quote asset)  "openTime":    1499783499040,     // ticker间隔的开始时间  "closeTime":   1499869899040,     // ticker间隔的结束时间  "firstId":     28385,             // 统计时间内的第一笔trade id  "lastId":      28460,             // 统计时间内的最后一笔trade id  "count":       76                 // 统计时间内交易笔数}

OR

[  {    "symbol": "BNBBTC",    "openPrice": "99.00000000",    "highPrice": "100.00000000",    "lowPrice": "0.10000000",    "lastPrice": "4.00000200",    "volume": "8913.30000000",    "quoteVolume": "15.30000000",    "openTime": 1499783499040,    "closeTime": 1499869899040,    "firstId": 28385,    "lastId": 28460,    "count": 76  },  {    "symbol": "LTCBTC",    "openPrice": "0.07000000",    "highPrice": "0.07000000",    "lowPrice": "0.07000000",    "lastPrice": "0.07000000",    "volume": "11.00000000",    "quoteVolume": "0.77000000",    "openTime": 1656908192899,    "closeTime": 1656994592899,    "firstId": 0,    "lastId": 10,    "count": 11  }]

GET /api/v3/ticker/24hr

24 小时滚动窗口价格变动数据。 请注意,不携带symbol参数会返回全部交易对数据,不仅数据庞大,而且权重极高

权重(IP):

参数提供Symbol数量权重
symbol11
不提供symbol40
symbols1-201
21-10020
>= 10140
不提供symbol40

参数:

名称类型是否强制要求详情
symbolSTRINGNO参数 `symbol` 和 `symbols` 不可以一起使用
如果都不提供, 所有symbol的ticker数据都会返回.

symbols参数可接受的格式: ["BTCUSDT","BNBUSDT"]

%5B%22BTCUSDT%22,%22BNBUSDT%22%5D
symbolsSTRINGNO
typeENUMNO可接受的参数: FULL or MINI.
如果不提供, 默认值为 FULL

数据源: 缓存

最新价格#

响应

{  "symbol": "LTCBTC",  "price": "4.00000200"}

OR

[  {    "symbol": "LTCBTC",    "price": "4.00000200"  },  {    "symbol": "ETHBTC",    "price": "0.07946600"  }]

GET /api/v3/ticker/price

获取交易对最新价格

权重(IP):

参数Symbols数量权重
symbol11
不提供symbol2
symbols不限2

参数:

参数名类型是否强制详情
symbolSTRINGNO 参数 `symbol` 和 `symbols` 不可以一起使用
如果都不提供, 所有symbol的价格数据都会返回.

symbols参数可接受的格式: ["BTCUSDT","BNBUSDT"]

%5B%22BTCUSDT%22,%22BNBUSDT%22%5D
symbolsSTRINGNO
  • 不发送交易对参数,则会返回所有交易对信息

数据源: 缓存

当前最优挂单#

响应

{  "symbol": "LTCBTC",  "bidPrice": "4.00000000",  "bidQty": "431.00000000",  "askPrice": "4.00000200",  "askQty": "9.00000000"}

OR

[  {    "symbol"