margin-trading

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Binance Margin-trading Skill

币安保证金交易Skill

Margin-trading request on Binance using authenticated API endpoints. Requires API key and secret key for certain endpoints. Return the result in JSON format.
通过经过身份验证的API端点发起币安保证金交易请求,部分端点需要提供API key和secret key,返回结果为JSON格式。

Quick Reference

快速参考

EndpointDescriptionRequiredOptionalAuthentication
/sapi/v1/margin/max-leverage
(POST)
Adjust cross margin max leverage (USER_DATA)maxLeverageNoneYes
/sapi/v1/margin/isolated/account
(DELETE)
Disable Isolated Margin Account (TRADE)symbolrecvWindowYes
/sapi/v1/margin/isolated/account
(POST)
Enable Isolated Margin Account (TRADE)symbolrecvWindowYes
/sapi/v1/margin/isolated/account
(GET)
Query Isolated Margin Account Info (USER_DATA)Nonesymbols, recvWindowYes
/sapi/v1/bnbBurn
(GET)
Get BNB Burn Status (USER_DATA)NonerecvWindowYes
/sapi/v1/margin/tradeCoeff
(GET)
Get Summary of Margin account (USER_DATA)NonerecvWindowYes
/sapi/v1/margin/capital-flow
(GET)
Query Cross Isolated Margin Capital Flow (USER_DATA)Noneasset, symbol, type, startTime, endTime, fromId, limit, recvWindowYes
/sapi/v1/margin/account
(GET)
Query Cross Margin Account Details (USER_DATA)NonerecvWindowYes
/sapi/v1/margin/crossMarginData
(GET)
Query Cross Margin Fee Data (USER_DATA)NonevipLevel, coin, recvWindowYes
/sapi/v1/margin/isolated/accountLimit
(GET)
Query Enabled Isolated Margin Account Limit (USER_DATA)NonerecvWindowYes
/sapi/v1/margin/isolatedMarginData
(GET)
Query Isolated Margin Fee Data (USER_DATA)NonevipLevel, symbol, recvWindowYes
/sapi/v1/margin/interestHistory
(GET)
Get Interest History (USER_DATA)Noneasset, isolatedSymbol, startTime, endTime, current, size, recvWindowYes
/sapi/v1/margin/next-hourly-interest-rate
(GET)
Get future hourly interest rate (USER_DATA)assets, isIsolatedNoneYes
/sapi/v1/margin/borrow-repay
(POST)
Margin account borrow/repay(MARGIN)asset, isIsolated, symbol, amount, typerecvWindowYes
/sapi/v1/margin/borrow-repay
(GET)
Query borrow/repay records in Margin account(USER_DATA)typeasset, isolatedSymbol, txId, startTime, endTime, current, size, recvWindowYes
/sapi/v1/margin/interestRateHistory
(GET)
Query Margin Interest Rate History (USER_DATA)assetvipLevel, startTime, endTime, recvWindowYes
/sapi/v1/margin/maxBorrowable
(GET)
Query Max Borrow (USER_DATA)assetisolatedSymbol, recvWindowYes
/sapi/v1/margin/crossMarginCollateralRatio
(GET)
Cross margin collateral ratio (MARKET_DATA)NoneNoneNo
/sapi/v1/margin/allPairs
(GET)
Get All Cross Margin Pairs (MARKET_DATA)NonesymbolNo
/sapi/v1/margin/isolated/allPairs
(GET)
Get All Isolated Margin Symbol(MARKET_DATA)Nonesymbol, recvWindowNo
/sapi/v1/margin/allAssets
(GET)
Get All Margin Assets (MARKET_DATA)NoneassetNo
/sapi/v1/margin/delist-schedule
(GET)
Get Delist Schedule (MARKET_DATA)NonerecvWindowNo
/sapi/v1/margin/limit-price-pairs
(GET)
Get Limit Price Pairs(MARKET_DATA)NoneNoneNo
/sapi/v1/margin/list-schedule
(GET)
Get list Schedule (MARKET_DATA)NonerecvWindowNo
/sapi/v1/margin/risk-based-liquidation-ratio
(GET)
Get Margin Asset Risk-Based Liquidation Ratio (MARKET_DATA)NoneNoneNo
/sapi/v1/margin/restricted-asset
(GET)
Get Margin Restricted Assets (MARKET_DATA)NoneNoneNo
/sapi/v1/margin/isolatedMarginTier
(GET)
Query Isolated Margin Tier Data (USER_DATA)symboltier, recvWindowYes
/sapi/v1/margin/leverageBracket
(GET)
Query Liability Coin Leverage Bracket in Cross Margin Pro Mode(MARKET_DATA)NoneNoneNo
/sapi/v1/margin/priceIndex
(GET)
Query Margin PriceIndex (MARKET_DATA)symbolNoneNo
/sapi/v1/margin/available-inventory
(GET)
Query Margin Available Inventory(USER_DATA)typeNoneYes
/sapi/v1/margin/listen-key
(DELETE)
Close User Data Stream (USER_STREAM)NoneNoneNo
/sapi/v1/margin/listen-key
(PUT)
Keepalive User Data Stream (USER_STREAM)listenKeyNoneNo
/sapi/v1/margin/listen-key
(POST)
Start User Data Stream (USER_STREAM)NoneNoneNo
/sapi/v1/margin/apiKey
(POST)
Create Special Key(Low-Latency Trading)(TRADE)apiNamesymbol, ip, publicKey, permissionMode, recvWindowYes
/sapi/v1/margin/apiKey
(DELETE)
Delete Special Key(Low-Latency Trading)(TRADE)NoneapiName, symbol, recvWindowYes
/sapi/v1/margin/apiKey
(GET)
Query Special key(Low Latency Trading)(TRADE)Nonesymbol, recvWindowYes
/sapi/v1/margin/apiKey/ip
(PUT)
Edit ip for Special Key(Low-Latency Trading)(TRADE)ipsymbol, recvWindowYes
/sapi/v1/margin/forceLiquidationRec
(GET)
Get Force Liquidation Record (USER_DATA)NonestartTime, endTime, isolatedSymbol, current, size, recvWindowYes
/sapi/v1/margin/exchange-small-liability
(GET)
Get Small Liability Exchange Coin List (USER_DATA)NonerecvWindowYes
/sapi/v1/margin/exchange-small-liability
(POST)
Small Liability Exchange (MARGIN)assetNamesrecvWindowYes
/sapi/v1/margin/exchange-small-liability-history
(GET)
Get Small Liability Exchange History (USER_DATA)current, sizestartTime, endTime, recvWindowYes
/sapi/v1/margin/openOrders
(DELETE)
Margin Account Cancel all Open Orders on a Symbol (TRADE)symbolisIsolated, recvWindowYes
/sapi/v1/margin/openOrders
(GET)
Query Margin Account's Open Orders (USER_DATA)Nonesymbol, isIsolated, recvWindowYes
/sapi/v1/margin/orderList
(DELETE)
Margin Account Cancel OCO (TRADE)symbolisIsolated, orderListId, listClientOrderId, newClientOrderId, recvWindowYes
/sapi/v1/margin/orderList
(GET)
Query Margin Account's OCO (USER_DATA)NoneisIsolated, symbol, orderListId, origClientOrderId, recvWindowYes
/sapi/v1/margin/order
(DELETE)
Margin Account Cancel Order (TRADE)symbolisIsolated, orderId, origClientOrderId, newClientOrderId, recvWindowYes
/sapi/v1/margin/order
(POST)
Margin Account New Order (TRADE)symbol, side, typeisIsolated, quantity, quoteOrderQty, price, stopPrice, newClientOrderId, icebergQty, newOrderRespType, sideEffectType, timeInForce, selfTradePreventionMode, autoRepayAtCancel, recvWindowYes
/sapi/v1/margin/order
(GET)
Query Margin Account's Order (USER_DATA)symbolisIsolated, orderId, origClientOrderId, recvWindowYes
/sapi/v1/margin/order/oco
(POST)
Margin Account New OCO (TRADE)symbol, side, quantity, price, stopPriceisIsolated, listClientOrderId, limitClientOrderId, limitIcebergQty, stopClientOrderId, stopLimitPrice, stopIcebergQty, stopLimitTimeInForce, newOrderRespType, sideEffectType, selfTradePreventionMode, autoRepayAtCancel, recvWindowYes
/sapi/v1/margin/order/oto
(POST)
Margin Account New OTO (TRADE)symbol, workingType, workingSide, workingPrice, workingQuantity, workingIcebergQty, pendingType, pendingSide, pendingQuantityisIsolated, listClientOrderId, newOrderRespType, sideEffectType, selfTradePreventionMode, autoRepayAtCancel, workingClientOrderId, workingTimeInForce, pendingClientOrderId, pendingPrice, pendingStopPrice, pendingTrailingDelta, pendingIcebergQty, pendingTimeInForceYes
/sapi/v1/margin/order/otoco
(POST)
Margin Account New OTOCO (TRADE)symbol, workingType, workingSide, workingPrice, workingQuantity, pendingSide, pendingQuantity, pendingAboveTypeisIsolated, sideEffectType, autoRepayAtCancel, listClientOrderId, newOrderRespType, selfTradePreventionMode, workingClientOrderId, workingIcebergQty, workingTimeInForce, pendingAboveClientOrderId, pendingAbovePrice, pendingAboveStopPrice, pendingAboveTrailingDelta, pendingAboveIcebergQty, pendingAboveTimeInForce, pendingBelowType, pendingBelowClientOrderId, pendingBelowPrice, pendingBelowStopPrice, pendingBelowTrailingDelta, pendingBelowIcebergQty, pendingBelowTimeInForceYes
/sapi/v1/margin/manual-liquidation
(POST)
Margin Manual Liquidation(MARGIN)typesymbol, recvWindowYes
/sapi/v1/margin/rateLimit/order
(GET)
Query Current Margin Order Count Usage (TRADE)NoneisIsolated, symbol, recvWindowYes
/sapi/v1/margin/allOrderList
(GET)
Query Margin Account's all OCO (USER_DATA)NoneisIsolated, symbol, fromId, startTime, endTime, limit, recvWindowYes
/sapi/v1/margin/allOrders
(GET)
Query Margin Account's All Orders (USER_DATA)symbolisIsolated, orderId, startTime, endTime, limit, recvWindowYes
/sapi/v1/margin/openOrderList
(GET)
Query Margin Account's Open OCO (USER_DATA)NoneisIsolated, symbol, recvWindowYes
/sapi/v1/margin/myTrades
(GET)
Query Margin Account's Trade List (USER_DATA)symbolisIsolated, orderId, startTime, endTime, fromId, limit, recvWindowYes
/sapi/v1/margin/myPreventedMatches
(GET)
Query Prevented Matches(USER_DATA)symbolpreventedMatchId, orderId, fromPreventedMatchId, recvWindow, isIsolatedYes
/sapi/v1/margin/api-key-list
(GET)
Query Special key List(Low Latency Trading)(TRADE)Nonesymbol, recvWindowYes
/sapi/v1/margin/transfer
(GET)
Get Cross Margin Transfer History (USER_DATA)Noneasset, type, startTime, endTime, current, size, isolatedSymbol, recvWindowYes
/sapi/v1/margin/maxTransferable
(GET)
Query Max Transfer-Out Amount (USER_DATA)assetisolatedSymbol, recvWindowYes

Endpoint描述必填选填是否需要鉴权
/sapi/v1/margin/max-leverage
(POST)
调整全仓保证金最高杠杆(USER_DATA)maxLeverage
/sapi/v1/margin/isolated/account
(DELETE)
禁用逐仓保证金账户(TRADE)symbolrecvWindow
/sapi/v1/margin/isolated/account
(POST)
启用逐仓保证金账户(TRADE)symbolrecvWindow
/sapi/v1/margin/isolated/account
(GET)
查询逐仓保证金账户信息(USER_DATA)symbols, recvWindow
/sapi/v1/bnbBurn
(GET)
获取BNB销毁状态(USER_DATA)recvWindow
/sapi/v1/margin/tradeCoeff
(GET)
获取保证金账户汇总信息(USER_DATA)recvWindow
/sapi/v1/margin/capital-flow
(GET)
查询全仓/逐仓保证金资金流水(USER_DATA)asset, symbol, type, startTime, endTime, fromId, limit, recvWindow
/sapi/v1/margin/account
(GET)
查询全仓保证金账户详情(USER_DATA)recvWindow
/sapi/v1/margin/crossMarginData
(GET)
查询全仓保证金费率数据(USER_DATA)vipLevel, coin, recvWindow
/sapi/v1/margin/isolated/accountLimit
(GET)
查询已启用的逐仓保证金账户数量上限(USER_DATA)recvWindow
/sapi/v1/margin/isolatedMarginData
(GET)
查询逐仓保证金费率数据(USER_DATA)vipLevel, symbol, recvWindow
/sapi/v1/margin/interestHistory
(GET)
获取利息历史(USER_DATA)asset, isolatedSymbol, startTime, endTime, current, size, recvWindow
/sapi/v1/margin/next-hourly-interest-rate
(GET)
获取未来每小时利率(USER_DATA)assets, isIsolated
/sapi/v1/margin/borrow-repay
(POST)
保证金账户借款/还款(MARGIN)asset, isIsolated, symbol, amount, typerecvWindow
/sapi/v1/margin/borrow-repay
(GET)
查询保证金账户借款/还款记录(USER_DATA)typeasset, isolatedSymbol, txId, startTime, endTime, current, size, recvWindow
/sapi/v1/margin/interestRateHistory
(GET)
查询保证金利率历史(USER_DATA)assetvipLevel, startTime, endTime, recvWindow
/sapi/v1/margin/maxBorrowable
(GET)
查询最大可借额度(USER_DATA)assetisolatedSymbol, recvWindow
/sapi/v1/margin/crossMarginCollateralRatio
(GET)
全仓保证金抵押率(MARKET_DATA)
/sapi/v1/margin/allPairs
(GET)
获取所有全仓保证金交易对(MARKET_DATA)symbol
/sapi/v1/margin/isolated/allPairs
(GET)
获取所有逐仓保证金交易对(MARKET_DATA)symbol, recvWindow
/sapi/v1/margin/allAssets
(GET)
获取所有保证金支持资产(MARKET_DATA)asset
/sapi/v1/margin/delist-schedule
(GET)
获取下线计划(MARKET_DATA)recvWindow
/sapi/v1/margin/limit-price-pairs
(GET)
获取限价交易对列表(MARKET_DATA)
/sapi/v1/margin/list-schedule
(GET)
获取上线计划(MARKET_DATA)recvWindow
/sapi/v1/margin/risk-based-liquidation-ratio
(GET)
获取保证金资产风险导向强平比例(MARKET_DATA)
/sapi/v1/margin/restricted-asset
(GET)
获取保证金受限资产列表(MARKET_DATA)
/sapi/v1/margin/isolatedMarginTier
(GET)
查询逐仓保证金层级数据(USER_DATA)symboltier, recvWindow
/sapi/v1/margin/leverageBracket
(GET)
查询全仓保证金专业模式负债币种杠杆档位(MARKET_DATA)
/sapi/v1/margin/priceIndex
(GET)
查询保证金价格指数(MARKET_DATA)symbol
/sapi/v1/margin/available-inventory
(GET)
查询保证金可用库存(USER_DATA)type
/sapi/v1/margin/listen-key
(DELETE)
关闭用户数据流(USER_STREAM)
/sapi/v1/margin/listen-key
(PUT)
延长用户数据流有效期(USER_STREAM)listenKey
/sapi/v1/margin/listen-key
(POST)
启动用户数据流(USER_STREAM)
/sapi/v1/margin/apiKey
(POST)
创建特殊密钥(低延迟交易)(TRADE)apiNamesymbol, ip, publicKey, permissionMode, recvWindow
/sapi/v1/margin/apiKey
(DELETE)
删除特殊密钥(低延迟交易)(TRADE)apiName, symbol, recvWindow
/sapi/v1/margin/apiKey
(GET)
查询特殊密钥(低延迟交易)(TRADE)symbol, recvWindow
/sapi/v1/margin/apiKey/ip
(PUT)
编辑特殊密钥的IP白名单(低延迟交易)(TRADE)ipsymbol, recvWindow
/sapi/v1/margin/forceLiquidationRec
(GET)
获取强制平仓记录(USER_DATA)startTime, endTime, isolatedSymbol, current, size, recvWindow
/sapi/v1/margin/exchange-small-liability
(GET)
获取小额负债兑换币种列表(USER_DATA)recvWindow
/sapi/v1/margin/exchange-small-liability
(POST)
小额负债兑换(MARGIN)assetNamesrecvWindow
/sapi/v1/margin/exchange-small-liability-history
(GET)
获取小额负债兑换历史(USER_DATA)current, sizestartTime, endTime, recvWindow
/sapi/v1/margin/openOrders
(DELETE)
撤销保证金账户指定交易对的所有挂单(TRADE)symbolisIsolated, recvWindow
/sapi/v1/margin/openOrders
(GET)
查询保证金账户的挂单列表(USER_DATA)symbol, isIsolated, recvWindow
/sapi/v1/margin/orderList
(DELETE)
撤销保证金账户的OCO订单(TRADE)symbolisIsolated, orderListId, listClientOrderId, newClientOrderId, recvWindow
/sapi/v1/margin/orderList
(GET)
查询保证金账户的OCO订单(USER_DATA)isIsolated, symbol, orderListId, origClientOrderId, recvWindow
/sapi/v1/margin/order
(DELETE)
撤销保证金账户订单(TRADE)symbolisIsolated, orderId, origClientOrderId, newClientOrderId, recvWindow
/sapi/v1/margin/order
(POST)
保证金账户新建订单(TRADE)symbol, side, typeisIsolated, quantity, quoteOrderQty, price, stopPrice, newClientOrderId, icebergQty, newOrderRespType, sideEffectType, timeInForce, selfTradePreventionMode, autoRepayAtCancel, recvWindow
/sapi/v1/margin/order
(GET)
查询保证金账户订单(USER_DATA)symbolisIsolated, orderId, origClientOrderId, recvWindow
/sapi/v1/margin/order/oco
(POST)
保证金账户新建OCO订单(TRADE)symbol, side, quantity, price, stopPriceisIsolated, listClientOrderId, limitClientOrderId, limitIcebergQty, stopClientOrderId, stopLimitPrice, stopIcebergQty, stopLimitTimeInForce, newOrderRespType, sideEffectType, selfTradePreventionMode, autoRepayAtCancel, recvWindow
/sapi/v1/margin/order/oto
(POST)
保证金账户新建OTO订单(TRADE)symbol, workingType, workingSide, workingPrice, workingQuantity, workingIcebergQty, pendingType, pendingSide, pendingQuantityisIsolated, listClientOrderId, newOrderRespType, sideEffectType, selfTradePreventionMode, autoRepayAtCancel, workingClientOrderId, workingTimeInForce, pendingClientOrderId, pendingPrice, pendingStopPrice, pendingTrailingDelta, pendingIcebergQty, pendingTimeInForce
/sapi/v1/margin/order/otoco
(POST)
保证金账户新建OTOCO订单(TRADE)symbol, workingType, workingSide, workingPrice, workingQuantity, pendingSide, pendingQuantity, pendingAboveTypeisIsolated, sideEffectType, autoRepayAtCancel, listClientOrderId, newOrderRespType, selfTradePreventionMode, workingClientOrderId, workingIcebergQty, workingTimeInForce, pendingAboveClientOrderId, pendingAbovePrice, pendingAboveStopPrice, pendingAboveTrailingDelta, pendingAboveIcebergQty, pendingAboveTimeInForce, pendingBelowType, pendingBelowClientOrderId, pendingBelowPrice, pendingBelowStopPrice, pendingBelowTrailingDelta, pendingBelowIcebergQty, pendingBelowTimeInForce
/sapi/v1/margin/manual-liquidation
(POST)
保证金手动平仓(MARGIN)typesymbol, recvWindow
/sapi/v1/margin/rateLimit/order
(GET)
查询当前保证金订单频次限制使用情况(TRADE)isIsolated, symbol, recvWindow
/sapi/v1/margin/allOrderList
(GET)
查询保证金账户所有OCO订单(USER_DATA)isIsolated, symbol, fromId, startTime, endTime, limit, recvWindow
/sapi/v1/margin/allOrders
(GET)
查询保证金账户所有订单(USER_DATA)symbolisIsolated, orderId, startTime, endTime, limit, recvWindow
/sapi/v1/margin/openOrderList
(GET)
查询保证金账户未成交的OCO订单(USER_DATA)isIsolated, symbol, recvWindow
/sapi/v1/margin/myTrades
(GET)
查询保证金账户成交记录(USER_DATA)symbolisIsolated, orderId, startTime, endTime, fromId, limit, recvWindow
/sapi/v1/margin/myPreventedMatches
(GET)
查询被阻止的成交记录(USER_DATA)symbolpreventedMatchId, orderId, fromPreventedMatchId, recvWindow, isIsolated
/sapi/v1/margin/api-key-list
(GET)
查询特殊密钥列表(低延迟交易)(TRADE)symbol, recvWindow
/sapi/v1/margin/transfer
(GET)
获取全仓保证金转账历史(USER_DATA)asset, type, startTime, endTime, current, size, isolatedSymbol, recvWindow
/sapi/v1/margin/maxTransferable
(GET)
查询最大可转出金额(USER_DATA)assetisolatedSymbol, recvWindow

Parameters

参数说明

Common Parameters

通用参数

  • maxLeverage: Can only adjust 3 , 5 or 10,Example: maxLeverage = 5 or 3 for Cross Margin Classic; maxLeverage=10 for Cross Margin Pro 10x leverage or 20x if compliance allows.
  • symbol:
  • recvWindow: No more than 60000 (e.g., 5000)
  • asset:
  • symbol: isolated margin pair
  • type: Transfer Type: ROLL_IN, ROLL_OUT
  • startTime: Only supports querying data from the past 90 days. (e.g., 1623319461670)
  • endTime: (e.g., 1641782889000)
  • fromId: If
    fromId
    is set, data with
    id
    greater than
    fromId
    will be returned. Otherwise, the latest data will be returned. (e.g., 1)
  • limit: Limit on the number of data records returned per request. Default: 500; Maximum: 1000. (e.g., 500)
  • vipLevel: User's current specific margin data will be returned if vipLevel is omitted (e.g., 1)
  • coin:
  • symbols: Max 5 symbols can be sent; separated by ",". e.g. "BTCUSDT,BNBUSDT,ADAUSDT"
  • isolatedSymbol: isolated symbol
  • current: Currently querying page. Start from 1. Default:1 (e.g., 1)
  • size: Default:10 Max:100 (e.g., 10)
  • assets: List of assets, separated by commas, up to 20
  • isIsolated: for isolated margin or not, "TRUE", "FALSE"
  • asset:
  • isIsolated:
    TRUE
    for Isolated Margin,
    FALSE
    for Cross Margin, Default
    FALSE
    (e.g., FALSE)
  • amount:
  • type:
    MARGIN
    ,
    ISOLATED
  • txId:
    tranId
    in
    POST /sapi/v1/margin/loan
    (e.g., 1)
  • tier: All margin tier data will be returned if tier is omitted
  • listenKey:
  • apiName:
  • ip: Can be added in batches, separated by commas. Max 30 for an API key
  • publicKey: 1. If publicKey is inputted it will create an RSA or Ed25519 key. 2. Need to be encoded to URL-encoded format
  • permissionMode: This parameter is only for the Ed25519 API key, and does not effact for other encryption methods. The value can be TRADE (TRADE for all permissions) or READ (READ for USER_DATA, FIX_API_READ_ONLY). The default value is TRADE. (e.g., value)
  • apiName:
  • ip: Can be added in batches, separated by commas. Max 30 for an API key
  • current: Currently querying page. Start from 1. Default:1 (e.g., 1)
  • size: Default:10, Max:100 (e.g., 10)
  • isIsolated: For isolated margin or not, "TRUE", "FALSE", default "FALSE"
  • orderListId: Either
    orderListId
    or
    listClientOrderId
    must be provided (e.g., 1)
  • listClientOrderId: Either
    orderListId
    or
    listClientOrderId
    must be provided (e.g., 1)
  • newClientOrderId: Used to uniquely identify this cancel. Automatically generated by default (e.g., 1)
  • orderId: (e.g., 1)
  • origClientOrderId: (e.g., 1)
  • quantity: (e.g., 1.0)
  • limitClientOrderId: A unique Id for the limit order (e.g., 1)
  • price: (e.g., 1.0)
  • limitIcebergQty: (e.g., 1.0)
  • stopClientOrderId: A unique Id for the stop loss/stop loss limit leg (e.g., 1)
  • stopPrice: (e.g., 1.0)
  • stopLimitPrice: If provided,
    stopLimitTimeInForce
    is required. (e.g., 1.0)
  • stopIcebergQty: (e.g., 1.0)
  • stopLimitTimeInForce: Valid values are
    GTC
    /
    FOK
    /
    IOC
  • sideEffectType: NO_SIDE_EFFECT, MARGIN_BUY, AUTO_REPAY,AUTO_BORROW_REPAY; default NO_SIDE_EFFECT. More info in FAQ (e.g., NO_SIDE_EFFECT)
  • selfTradePreventionMode: The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE (e.g., NONE)
  • autoRepayAtCancel: Only when MARGIN_BUY or AUTO_BORROW_REPAY order takes effect, true means that the debt generated by the order needs to be repay after the order is cancelled. The default is true (e.g., true)
  • workingType: Supported values:
    LIMIT
    ,
    LIMIT_MAKER
  • workingSide: BUY, SELL
  • workingClientOrderId: Arbitrary unique ID among open orders for the working order. Automatically generated if not sent. (e.g., 1)
  • workingPrice: (e.g., 1.0)
  • workingQuantity: (e.g., 1.0)
  • workingIcebergQty: This can only be used if
    workingTimeInForce
    is
    GTC
    . (e.g., 1.0)
  • workingTimeInForce: GTC,IOC,FOK
  • pendingType: Supported values: Order Types Note that
    MARKET
    orders using
    quoteOrderQty
    are not supported. (e.g., Order Types)
  • pendingSide: BUY, SELL
  • pendingClientOrderId: Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent. (e.g., 1)
  • pendingPrice: (e.g., 1.0)
  • pendingStopPrice: (e.g., 1.0)
  • pendingTrailingDelta: (e.g., 1.0)
  • pendingQuantity: (e.g., 1.0)
  • pendingIcebergQty: This can only be used if
    pendingTimeInForce
    is
    GTC
    . (e.g., 1.0)
  • pendingTimeInForce: GTC,IOC,FOK
  • workingIcebergQty: This can only be used if
    workingTimeInForce
    is
    GTC
    . (e.g., 1.0)
  • pendingAboveType: Supported values:
    LIMIT_MAKER
    ,
    STOP_LOSS
    , and
    STOP_LOSS_LIMIT
  • pendingAboveClientOrderId: Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent. (e.g., 1)
  • pendingAbovePrice: (e.g., 1.0)
  • pendingAboveStopPrice: (e.g., 1.0)
  • pendingAboveTrailingDelta: (e.g., 1.0)
  • pendingAboveIcebergQty: This can only be used if
    pendingAboveTimeInForce
    is
    GTC
    . (e.g., 1.0)
  • pendingAboveTimeInForce:
  • pendingBelowType: Supported values:
    LIMIT_MAKER
    ,
    STOP_LOSS
    , and
    STOP_LOSS_LIMIT
  • pendingBelowClientOrderId: Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent. (e.g., 1)
  • pendingBelowPrice: (e.g., 1.0)
  • pendingBelowStopPrice: (e.g., 1.0)
  • pendingBelowTrailingDelta: (e.g., 1.0)
  • pendingBelowIcebergQty: This can only be used if
    pendingBelowTimeInForce
    is
    GTC
    . (e.g., 1.0)
  • pendingBelowTimeInForce:
  • quantity: (e.g., 1.0)
  • quoteOrderQty: (e.g., 1.0)
  • price: (e.g., 1.0)
  • stopPrice: Used with
    STOP_LOSS
    ,
    STOP_LOSS_LIMIT
    ,
    TAKE_PROFIT
    , and
    TAKE_PROFIT_LIMIT
    orders. (e.g., 1.0)
  • icebergQty: Used with
    LIMIT
    ,
    STOP_LOSS_LIMIT
    , and
    TAKE_PROFIT_LIMIT
    to create an iceberg order. (e.g., 1.0)
  • preventedMatchId: (e.g., 1)
  • fromPreventedMatchId: (e.g., 1)
  • assetNames: The assets list of small liability exchange, Example: assetNames = BTC,ETH
  • maxLeverage: 仅可调整为3、5或10,示例:全仓保证金经典模式maxLeverage = 5或3;全仓保证金专业模式maxLeverage=10表示10倍杠杆,合规允许的情况下可设置为20倍。
  • symbol:
  • recvWindow: 不可超过60000(例如:5000)
  • asset:
  • symbol: 逐仓保证金交易对
  • type: 转账类型:ROLL_IN(转入), ROLL_OUT(转出)
  • startTime: 仅支持查询最近90天内的数据(例如:1623319461670)
  • endTime: (例如:1641782889000)
  • fromId: 如果设置了
    fromId
    ,将返回
    id
    大于
    fromId
    的数据,否则返回最新数据(例如:1)
  • limit: 单次请求返回的数据条数限制,默认值:500;最大值:1000(例如:500)
  • vipLevel: 如果省略vipLevel,将返回用户当前对应的保证金数据(例如:1)
  • coin:
  • symbols: 最多可传入5个交易对,用英文逗号分隔,例如:"BTCUSDT,BNBUSDT,ADAUSDT"
  • isolatedSymbol: 逐仓交易对
  • current: 当前查询页码,从1开始,默认值:1(例如:1)
  • size: 默认值:10,最大值:100(例如:10)
  • assets: 资产列表,用英文逗号分隔,最多20个
  • isIsolated: 是否为逐仓保证金,可选值:"TRUE", "FALSE"
  • asset:
  • isIsolated:
    TRUE
    表示逐仓保证金,
    FALSE
    表示全仓保证金,默认值:
    FALSE
    (例如:FALSE)
  • amount:
  • type:
    MARGIN
    (全仓),
    ISOLATED
    (逐仓)
  • txId:
    POST /sapi/v1/margin/loan
    接口返回的
    tranId
    (例如:1)
  • tier: 如果省略tier,将返回所有保证金层级数据
  • listenKey:
  • apiName:
  • ip: 可批量添加,用英文逗号分隔,单个API密钥最多支持30个IP
  • publicKey: 1. 如果传入publicKey,将创建RSA或Ed25519密钥;2. 需要转换为URL编码格式
  • permissionMode: 该参数仅适用于Ed25519类型的API密钥,对其他加密方式无效,可选值为TRADE(拥有所有交易权限)或READ(仅拥有USER_DATA、FIX_API_READ_ONLY权限),默认值为TRADE(例如:value)
  • apiName:
  • ip: 可批量添加,用英文逗号分隔,单个API密钥最多支持30个IP
  • current: 当前查询页码,从1开始,默认值:1(例如:1)
  • size: 默认值:10,最大值:100(例如:10)
  • isIsolated: 是否为逐仓保证金,可选值:"TRUE", "FALSE",默认值:"FALSE"
  • orderListId:
    orderListId
    listClientOrderId
    必须提供其中一个(例如:1)
  • listClientOrderId:
    orderListId
    listClientOrderId
    必须提供其中一个(例如:1)
  • newClientOrderId: 用于唯一标识本次撤销操作,默认自动生成(例如:1)
  • orderId: (例如:1)
  • origClientOrderId: (例如:1)
  • quantity: (例如:1.0)
  • limitClientOrderId: 限价单的唯一ID(例如:1)
  • price: (例如:1.0)
  • limitIcebergQty: (例如:1.0)
  • stopClientOrderId: 止损/止损限价单的唯一ID(例如:1)
  • stopPrice: (例如:1.0)
  • stopLimitPrice: 如果传入该参数,则必须同时传入
    stopLimitTimeInForce
    (例如:1.0)
  • stopIcebergQty: (例如:1.0)
  • stopLimitTimeInForce: 有效值为
    GTC
    /
    FOK
    /
    IOC
  • sideEffectType: NO_SIDE_EFFECT, MARGIN_BUY, AUTO_REPAY,AUTO_BORROW_REPAY; 默认值:NO_SIDE_EFFECT,更多信息请参考常见问题(例如:NO_SIDE_EFFECT)
  • selfTradePreventionMode: 允许的枚举值取决于交易对的配置,支持的可选值为EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE(例如:NONE)
  • autoRepayAtCancel: 仅当订单为MARGIN_BUY或AUTO_BORROW_REPAY类型时生效,true表示订单取消后需要偿还该订单产生的负债,默认值为true(例如:true)
  • workingType: 支持的可选值:
    LIMIT
    ,
    LIMIT_MAKER
  • workingSide: BUY(买), SELL(卖)
  • workingClientOrderId: 条件单的唯一ID,在所有挂单中需唯一,未传入则自动生成(例如:1)
  • workingPrice: (例如:1.0)
  • workingQuantity: (例如:1.0)
  • workingIcebergQty: 仅当
    workingTimeInForce
    GTC
    时可使用(例如:1.0)
  • workingTimeInForce: GTC,IOC,FOK
  • pendingType: 支持的可选值:订单类型,注意不支持使用
    quoteOrderQty
    MARKET
    订单(例如:Order Types)
  • pendingSide: BUY(买), SELL(卖)
  • pendingClientOrderId: 挂单的唯一ID,在所有挂单中需唯一,未传入则自动生成(例如:1)
  • pendingPrice: (例如:1.0)
  • pendingStopPrice: (例如:1.0)
  • pendingTrailingDelta: (例如:1.0)
  • pendingQuantity: (例如:1.0)
  • pendingIcebergQty: 仅当
    pendingTimeInForce
    GTC
    时可使用(例如:1.0)
  • pendingTimeInForce: GTC,IOC,FOK
  • workingIcebergQty: 仅当
    workingTimeInForce
    GTC
    时可使用(例如:1.0)
  • pendingAboveType: 支持的可选值:
    LIMIT_MAKER
    ,
    STOP_LOSS
    , 和
    STOP_LOSS_LIMIT
  • pendingAboveClientOrderId: 上方条件挂单的唯一ID,在所有挂单中需唯一,未传入则自动生成(例如:1)
  • pendingAbovePrice: (例如:1.0)
  • pendingAboveStopPrice: (例如:1.0)
  • pendingAboveTrailingDelta: (例如:1.0)
  • pendingAboveIcebergQty: 仅当
    pendingAboveTimeInForce
    GTC
    时可使用(例如:1.0)
  • pendingAboveTimeInForce:
  • pendingBelowType: 支持的可选值:
    LIMIT_MAKER
    ,
    STOP_LOSS
    , 和
    STOP_LOSS_LIMIT
  • pendingBelowClientOrderId: 下方条件挂单的唯一ID,在所有挂单中需唯一,未传入则自动生成(例如:1)
  • pendingBelowPrice: (例如:1.0)
  • pendingBelowStopPrice: (例如:1.0)
  • pendingBelowTrailingDelta: (例如:1.0)
  • pendingBelowIcebergQty: 仅当
    pendingBelowTimeInForce
    GTC
    时可使用(例如:1.0)
  • pendingBelowTimeInForce:
  • quantity: (例如:1.0)
  • quoteOrderQty: (例如:1.0)
  • price: (例如:1.0)
  • stopPrice: 用于
    STOP_LOSS
    STOP_LOSS_LIMIT
    TAKE_PROFIT
    TAKE_PROFIT_LIMIT
    类型的订单(例如:1.0)
  • icebergQty: 用于
    LIMIT
    STOP_LOSS_LIMIT
    TAKE_PROFIT_LIMIT
    类型的订单,创建冰山订单(例如:1.0)
  • preventedMatchId: (例如:1)
  • fromPreventedMatchId: (例如:1)
  • assetNames: 小额负债兑换的资产列表,示例:assetNames = BTC,ETH

Enums

枚举值

  • side: BUY | SELL
  • newOrderRespType: ACK | RESULT | FULL
  • timeInForce: GTC | IOC | FOK
  • side: BUY | SELL
  • newOrderRespType: ACK | RESULT | FULL
  • timeInForce: GTC | IOC | FOK

Authentication

鉴权说明

For endpoints that require authentication, you will need to provide Binance API credentials. Required credentials:
  • apiKey: Your Binance API key (for header)
  • secretKey: Your Binance API secret (for signing)
Base URLs:
需要鉴权的端点,你需要提供币安API凭证。 所需凭证:
  • apiKey: 你的币安API密钥(放在请求头中)
  • secretKey: 你的币安API私钥(用于签名)
基础URL:

Security

安全注意事项

Share Credentials

凭证共享

Users can provide Binance API credentials by sending a file where the content is in the following format:
bash
abc123...xyz
secret123...key
用户可通过发送包含以下格式内容的文件来提供币安API凭证:
bash
abc123...xyz
secret123...key

Never Disclose API Key and Secret

切勿泄露API Key和Secret

Never disclose the location of the API key and secret file.
Never send the API key and secret to any website other than Mainnet and Testnet.
切勿泄露API Key和Secret文件的存储位置。
切勿将API Key和Secret发送到主网和测试网以外的任何网站。

Never Display Full Secrets

切勿完整展示密钥信息

When showing credentials to users:
  • API Key: Show first 5 + last 4 characters:
    su1Qc...8akf
  • Secret Key: Always mask, show only last 5:
    ***...aws1
Example response when asked for credentials: Account: main API Key: su1Qc...8akf Secret: ***...aws1
向用户展示凭证时:
  • API Key: 展示前5位 + 后4位:
    su1Qc...8akf
  • Secret Key: 全程脱敏,仅展示最后5位:
    ***...aws1
查询凭证时的示例返回: 账户:main API Key: su1Qc...8akf Secret: ***...aws1

Listing Accounts

账号列表展示

When listing accounts, show names and environment only — never keys: Binance Accounts:
  • main (Mainnet)
  • futures-keys (Mainnet)
展示账号列表时,仅展示名称和环境,绝对不展示密钥: 币安账户:
  • main(主网)
  • futures-keys(主网)

Transactions in Mainnet

主网交易操作

When performing transactions in mainnet, always confirm with the user before proceeding by asking them to write "CONFIRM" to proceed.

在主网执行交易操作时,必须提前向用户确认,要求用户输入"CONFIRM"后再继续。

Binance Accounts

币安账户

main

main

  • API Key: your_mainnet_api_key
  • Secret: your_mainnet_secret
  • API Key: your_mainnet_api_key
  • Secret: your_mainnet_secret

TOOLS.md Structure

TOOLS.md 结构

bash
undefined
bash
undefined

Binance Accounts

币安账户

main

main

  • API Key: abc123...xyz
  • Secret: secret123...key
  • Description: Primary trading account
  • API Key: abc123...xyz
  • Secret: secret123...key
  • Description: 主要交易账户

futures-keys

futures-keys

  • API Key: futures789...def
  • Secret: futuressecret...uvw
  • Description: Futures trading account
undefined
  • API Key: futures789...def
  • Secret: futuressecret...uvw
  • Description: 合约交易账户
undefined

Agent Behavior

Agent行为规则

  1. Credentials requested: Mask secrets (show last 5 chars only)
  2. Listing accounts: Show names and environment, never keys
  3. Account selection: Ask if ambiguous, default to main
  4. When doing a transaction in mainnet, confirm with user before by asking to write "CONFIRM" to proceed
  5. New credentials: Prompt for name, environment, signing mode
  1. 凭证查询:对密钥进行脱敏(仅展示最后5位)
  2. 账户列表展示:仅展示名称和环境,绝不展示密钥
  3. 账户选择:如果存在歧义请询问用户,默认使用main账户
  4. 主网交易操作:提前向用户确认,要求用户输入"CONFIRM"后再继续
  5. 新增凭证:提示用户输入账户名称、环境、签名模式

Adding New Accounts

添加新账户

When user provides new credentials:
  • Ask for account name
  • Store in
    TOOLS.md
    with masked display confirmation
用户提供新凭证时:
  • 询问账户名称
  • 存储到
    TOOLS.md
    文件中,返回脱敏后的确认信息

Signing Requests

请求签名

For trading endpoints that require a signature:
  1. Build query string with all parameters, including the timestamp (Unix ms).
  2. Percent-encode the parameters using UTF-8 according to RFC 3986.
  3. Sign query string with secretKey using HMAC SHA256, RSA, or Ed25519 (depending on the account configuration).
  4. Append signature to query string.
  5. Include
    X-MBX-APIKEY
    header.
Otherwise, do not perform steps 3–5.
需要签名的交易端点:
  1. 构建包含所有参数的查询字符串,包括时间戳(Unix毫秒级)
  2. 根据RFC 3986规范对参数进行UTF-8百分比编码
  3. 根据账户配置,使用HMAC SHA256、RSA或Ed25519算法和secretKey对查询字符串进行签名
  4. 将签名追加到查询字符串中
  5. 添加
    X-MBX-APIKEY
    请求头
不需要签名的端点无需执行3-5步。

New Client Order ID

客户端订单ID规则

For endpoints that include the
newClientOrderId
parameter, the value must always start with
agent-
. If the parameter is not provided,
agent-
followed by 18 random alphanumeric characters will be generated automatically. If a value is provided, it will be prefixed with
agent-
Example:
agent-1a2b3c4d5e6f7g8h9i
包含
newClientOrderId
参数的端点,该参数值必须始终以
agent-
开头。如果用户未传入该参数,将自动生成
agent-
加18位随机字母数字组合的ID;如果用户传入了值,将自动添加
agent-
前缀。
示例:
agent-1a2b3c4d5e6f7g8h9i

User Agent Header

User-Agent请求头

Include
User-Agent
header with the following string:
binance-margin-trading/1.0.0 (Skill)
See
references/authentication.md
for implementation details.
请求需携带
User-Agent
头,值为:
binance-margin-trading/1.0.0 (Skill)
实现详情请参考
references/authentication.md