Skip to content

CHANGELOG.md

Latest commit

 

History

History
1373 lines (1020 loc) · 42.2 KB

CHANGELOG.md

File metadata and controls

1373 lines (1020 loc) · 42.2 KB

Changelog

44.0.0 - 2026-04-20

Added (6)

  • DELETE /papi/v1/um/algo/allOpenOrders
  • DELETE /papi/v1/um/algo/order
  • GET /papi/v1/um/algo/algoOrder
  • GET /papi/v1/um/algo/allAlgoOrders
  • GET /papi/v1/um/algo/openAlgoOrders
  • POST /papi/v1/um/algo/order

Changed (3)

  • Deleted parameter page
    • affected endpoints:
      • GET /fapi/v1/allAlgoOrders
  • Modified parameter interval:
    • enum added: 1s
    • affected endpoints:
      • GET /fapi/v1/continuousKlines
      • GET /fapi/v1/indexPriceKlines
      • GET /fapi/v1/klines
      • GET /fapi/v1/markPriceKlines
      • GET /fapi/v1/premiumIndexKlines
  • Modified parameter limit:
    • required: true → false
    • affected endpoints:
      • GET /futures/data/basis

43.0.0 - 2026-04-15

Added (4)

  • DELETE /sapi/v1/portfolio/margin-call-level
  • GET /sapi/v1/portfolio/margin-call-level
  • POST /sapi/v1/portfolio/margin-call-level
  • POST /papi/v1/um/stock/contract

42.0.0 - 2026-03-19

Changed (4)

  • Added parameter purchaseId
    • affected endpoints:
      • GET /sapi/v1/eth-staking/eth/history/stakingHistory
      • GET /sapi/v1/sol-staking/sol/history/stakingHistory
  • Added parameter redeemId
    • affected endpoints:
      • GET /sapi/v1/eth-staking/eth/history/redemptionHistory
      • GET /sapi/v1/sol-staking/sol/history/redemptionHistory
  • Added parameter selfTradePreventionMode
    • affected endpoints:
      • POST /eapi/v1/order
  • Modified parameter orders:
    • items: property selfTradePreventionMode added
    • items: item property selfTradePreventionMode added
    • affected endpoints:
      • POST /eapi/v1/batchOrders

41.0.0 - 2026-03-13

Added (4)

  • Support Demo Mode environment.
  • GET /api/v3/executionRules
  • GET /api/v3/referencePrice/calculation
  • GET /api/v3/referencePrice

40.0.0 - 2026-02-13

Added (2)

  • GET /sapi/v1/margin/myPreventedMatches
  • GET /sapi/v1/margin/restricted-asset

39.0.0 - 2026-02-02

Changed (2)

  • Added parameter limit
    • affected endpoints:
      • GET /sapi/v1/sub-account/futures/accountSummary
  • Added parameter page
    • affected endpoints:
      • GET /sapi/v1/sub-account/futures/accountSummary

38.0.0 - 2026-01-27

Added (1)

  • GET /sapi/v1/margin/risk-based-liquidation-ratio

Changed (2)

  • Added parameter newOrderRespType
    • affected endpoints:
      • POST /fapi/v1/algoOrder
  • Modified parameter batchOrders:
    • items: property stopPrice added
    • items: item property stopPrice added
    • affected endpoints:
      • PUT /fapi/v1/batchOrders

37.0.0 - 2026-01-20

Added (1)

  • Add Alpha Endpoints

Changed (3)

  • Added parameter accountType
    • affected endpoints:
      • GET /sapi/v1/asset/dribblet
  • Added parameter asset
    • affected endpoints:
      • GET /sapi/v1/asset/assetDetail
  • Deleted parameter userName
    • affected endpoints:
      • GET /sapi/v1/mining/hash-transfer/profit/details

36.0.0 - 2026-01-13

Added (7)

  • POST /dapi/v1/batchOrders
  • GET /sapi/v1/portfolio/delta-mode
  • POST /sapi/v1/portfolio/delta-mode
  • GET /sapi/v1/loan/vip/accruedInterest
  • GET /sapi/v1/loan/vip/interestRateHistory
  • GET /sapi/v2/loan/interestRateHistory
  • PUT /sapi/v2/localentity/deposit/provide-info

Changed (5)

  • Added parameter algoId
    • affected endpoints:
      • DELETE /fapi/v1/algoOrder
  • Added parameter clientAlgoId
    • affected endpoints:
      • DELETE /fapi/v1/algoOrder
  • Deleted parameter algoid
    • affected endpoints:
      • DELETE /fapi/v1/algoOrder
  • Deleted parameter clientalgoid
    • affected endpoints:
      • DELETE /fapi/v1/algoOrder
  • Modified parameter depositId:
    • type string → integer
    • affected endpoints:
      • PUT /sapi/v1/localentity/broker/deposit/provide-info

35.0.0 - 2025-12-19

Added (2)

  • POST /sapi/v1/asset/dust-convert/convert
  • POST /sapi/v1/asset/dust-convert/query-convertible-assets

Changed (2)

  • Added parameter activatePrice
    • affected endpoints:
      • POST /fapi/v1/algoOrder
  • Deleted parameter activationPrice
    • affected endpoints:
      • POST /fapi/v1/algoOrder

34.0.1 - 2025-12-17

Changed (1)

  • Fixed bug on pre-request script for query params.

34.0.0 - 2025-12-16

Added (7)

  • GET /fapi/v1/tradingSchedule
  • POST /fapi/v1/stock/contract
  • POST /api/v3/orderList/opo
  • POST /api/v3/orderList/opoco
  • GET /sapi/v1/fiat/get-order-detail
  • POST /sapi/v1/fiat/deposit
  • POST /sapi/v2/fiat/withdraw

Changed (8)

  • Deleted parameter activationPrice
    • affected endpoints:
      • POST /fapi/v1/order
  • Deleted parameter callbackRate
    • affected endpoints:
      • POST /fapi/v1/order
  • Deleted parameter closePosition
    • affected endpoints:
      • POST /fapi/v1/order
  • Deleted parameter priceProtect
    • affected endpoints:
      • POST /fapi/v1/order
  • Deleted parameter stopPrice
    • affected endpoints:
      • POST /fapi/v1/order
  • Deleted parameter workingType
    • affected endpoints:
      • POST /fapi/v1/order
  • Modified parameter batchOrders:
    • items: property activationPrice deleted
    • items: property priceProtect deleted
    • items: property stopPrice deleted
    • items: property workingType deleted
    • items: property callbackRate deleted
    • items: item property activationPrice deleted
    • items: item property priceProtect deleted
    • items: item property stopPrice deleted
    • items: item property workingType deleted
    • items: item property callbackRate deleted
    • affected endpoints:
      • POST /fapi/v1/batchOrders
  • Modified parameter batchOrders:
    • items.orderId: type integer → string
    • items.price: type number → string
    • items.quantity: type number → string
    • items.recvWindow: type integer → string
    • items.orderId: type integer → string
    • items.price: type number → string
    • items.quantity: type number → string
    • items.recvWindow: type integer → string
    • affected endpoints:
      • PUT /fapi/v1/batchOrders

33.0.0 - 2025-11-27

Added (1)

  • GET /fapi/v1/rpiDepth

32.0.0 - 2025-11-20

Added (1)

  • GET /fapi/v1/symbolAdlRisk

31.0.0 - 2025-11-18

Changed (1)

  • Renamed Symbol Price Ticker to Index Price Ticker in Derivatives Trading Options API collection.

Removed (2)

  • GET /sapi/v1/fiat/get-order-detail
  • GET /sapi/v2/fiat/withdraw

30.0.0 - 2025-11-10

Added (8)

  • DELETE /fapi/v1/algoOpenOrders
  • DELETE /fapi/v1/algoOrder
  • GET /fapi/v1/algoOrder
  • GET /fapi/v1/allAlgoOrders
  • GET /fapi/v1/openAlgoOrders
  • POST /fapi/v1/algoOrder
  • GET /sapi/v1/fiat/get-order-detail
  • GET /sapi/v2/fiat/withdraw

Changed (4)

  • Added parameter endTimestamp
    • affected endpoints:
      • GET /sapi/v1/c2c/orderMatch/listUserOrderHistory
  • Added parameter startTimestamp
    • affected endpoints:
      • GET /sapi/v1/c2c/orderMatch/listUserOrderHistory
  • Deleted parameter endTime
    • affected endpoints:
      • GET /sapi/v1/c2c/orderMatch/listUserOrderHistory
  • Deleted parameter startTime
    • affected endpoints:
      • GET /sapi/v1/c2c/orderMatch/listUserOrderHistory

Removed (8)

  • DELETE /sapi/v1/userDataStream/isolated
  • DELETE /sapi/v1/userDataStream
  • POST /sapi/v1/userDataStream/isolated
  • POST /sapi/v1/userDataStream
  • PUT /sapi/v1/userDataStream/isolated
  • PUT /sapi/v1/userDataStream
  • POST /sapi/v1/portfolio/mint
  • POST /sapi/v1/portfolio/redeem

29.0.0 - 2025-11-06

Changed (2)

  • Added parameter rows
    • affected endpoints:
      • GET /sapi/v1/c2c/orderMatch/listUserOrderHistory
  • Added parameter tradeType
    • affected endpoints:
      • GET /sapi/v1/c2c/orderMatch/listUserOrderHistory

28.0.0 - 2025-10-30

Added (8)

  • GET /sapi/v1/bfusd/account
  • GET /sapi/v1/bfusd/history/rateHistory
  • GET /sapi/v1/bfusd/history/redemptionHistory
  • GET /sapi/v1/bfusd/history/rewardsHistory
  • GET /sapi/v1/bfusd/history/subscriptionHistory
  • GET /sapi/v1/bfusd/quota
  • POST /sapi/v1/bfusd/redeem
  • POST /sapi/v1/bfusd/subscribe

Changed (1)

  • Added parameter symbolStatus
    • affected endpoints:
      • GET /api/v3/depth
      • GET /api/v3/ticker
      • GET /api/v3/ticker/24hr
      • GET /api/v3/ticker/bookTicker
      • GET /api/v3/ticker/price
      • GET /api/v3/ticker/tradingDay

27.0.0 - 2025-10-27

Removed (3)

  • DELETE /api/v3/userDataStream
  • POST /api/v3/userDataStream
  • PUT /api/v3/userDataStream

26.0.0 - 2025-10-09

Changed (4)

  • Deleted parameter price
    • affected endpoints:
      • POST /eapi/v1/block/order/create
  • Deleted parameter quantity
    • affected endpoints:
      • POST /eapi/v1/block/order/create
  • Deleted parameter side
    • affected endpoints:
      • POST /eapi/v1/block/order/create
  • Deleted parameter symbol
    • affected endpoints:
      • POST /eapi/v1/block/order/create

25.0.0 - 2025-10-06

Changed (2)

  • Deleted parameter limit
    • affected endpoints:
      • GET /eapi/v1/openOrders

24.0.0 - 2025-10-01

Added (1)

  • GET /api/v3/myFilters

Changed (1)

  • Modified parameter aboveTimeInForce:
    • type number → string
    • enum added: GTC, IOC, FOK
    • affected endpoints:
      • POST /api/v3/orderList/oco

23.0.0 - 2025-09-19

Changed (3)

  • Modified parameter recvWindow:

    • type integer → number
    • format int64 → float
    • affected endpoints:
      • GET /api/v3/account
      • GET /api/v3/allOrderList
      • GET /api/v3/allOrders
      • GET /api/v3/myAllocations
      • GET /api/v3/myPreventedMatches
      • GET /api/v3/myTrades
      • GET /api/v3/openOrderList
      • DELETE /api/v3/openOrders
      • GET /api/v3/openOrders
      • DELETE /api/v3/order
      • GET /api/v3/order
      • POST /api/v3/order
      • PUT /api/v3/order/amend/keepPriority
      • GET /api/v3/order/amendments
      • POST /api/v3/order/cancelReplace
      • POST /api/v3/order/oco
      • POST /api/v3/order/test
      • DELETE /api/v3/orderList
      • GET /api/v3/orderList
      • POST /api/v3/orderList/oco
      • POST /api/v3/orderList/oto
      • POST /api/v3/orderList/otoco
      • GET /api/v3/rateLimit/order
      • POST /api/v3/sor/order
      • POST /api/v3/sor/order/test

  • Update /sapi/v1/convert/limit/queryOpenOrders HTTP method (GET from POST)

  • Modified parameter email:

    • required: true → false
    • affected endpoints:
      • GET /sapi/v1/sub-account/transaction-statistics

22.0.0 - 2025-09-09

Added (3)

  • GET /sapi/v1/soft-staking/history/rewardsRecord
  • GET /sapi/v1/soft-staking/list
  • GET /sapi/v1/soft-staking/set

21.0.0 - 2025-09-05

Added (8)

  • GET /sapi/v1/rwusd/account
  • GET /sapi/v1/rwusd/history/rateHistory
  • GET /sapi/v1/rwusd/history/redemptionHistory
  • GET /sapi/v1/rwusd/history/rewardsHistory
  • GET /sapi/v1/rwusd/history/subscriptionHistory
  • GET /sapi/v1/rwusd/quota
  • POST /sapi/v1/rwusd/redeem
  • POST /sapi/v1/rwusd/subscribe

20.0.0 - 2025-08-29

Added (1)

  • GET /sapi/v2/localentity/deposit/history

19.0.0 - 2025-08-26

Changed (3)

  • Added parameter loanTerm
    • affected endpoints:
      • POST /sapi/v1/loan/vip/borrow
  • Added parameter collateralAmount
    • affected endpoints:
      • POST /sapi/v2/loan/flexible/borrow
  • Added parameter loanAmount
    • affected endpoints:
      • POST /sapi/v2/loan/flexible/borrow

18.0.0 - 2025-08-19

Changed (1)

  • Updated type example in /sapi/v1/simple-earn/flexible/history/rewardsRecord endpoint

17.0.0 - 2025-08-18

Added (1)

  • GET /sapi/v1/margin/limit-price-pairs

Changed (35)

  • Added parameter abovePegOffsetType
    • affected endpoints:
      • POST /api/v3/orderList/oco
  • Added parameter abovePegOffsetValue
    • affected endpoints:
      • POST /api/v3/orderList/oco
  • Added parameter abovePegPriceType
    • affected endpoints:
      • POST /api/v3/orderList/oco
  • Added parameter belowPegOffsetType
    • affected endpoints:
      • POST /api/v3/orderList/oco
  • Added parameter belowPegOffsetValue
    • affected endpoints:
      • POST /api/v3/orderList/oco
  • Added parameter belowPegPriceType
    • affected endpoints:
      • POST /api/v3/orderList/oco
  • Added parameter icebergQty
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter newClientOrderId
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter newOrderRespType
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter pegOffsetType
    • affected endpoints:
      • POST /api/v3/order
      • POST /api/v3/order/cancelReplace
      • POST /api/v3/order/test
  • Added parameter pegOffsetValue
    • affected endpoints:
      • POST /api/v3/order
      • POST /api/v3/order/cancelReplace
      • POST /api/v3/order/test
  • Added parameter pegPriceType
    • affected endpoints:
      • POST /api/v3/order
      • POST /api/v3/order/cancelReplace
      • POST /api/v3/order/test
  • Added parameter pendingAbovePegOffsetType
    • affected endpoints:
      • POST /api/v3/orderList/otoco
  • Added parameter pendingAbovePegOffsetValue
    • affected endpoints:
      • POST /api/v3/orderList/otoco
  • Added parameter pendingAbovePegPriceType
    • affected endpoints:
      • POST /api/v3/orderList/otoco
  • Added parameter pendingBelowPegOffsetType
    • affected endpoints:
      • POST /api/v3/orderList/otoco
  • Added parameter pendingBelowPegOffsetValue
    • affected endpoints:
      • POST /api/v3/orderList/otoco
  • Added parameter pendingBelowPegPriceType
    • affected endpoints:
      • POST /api/v3/orderList/otoco
  • Added parameter pendingPegOffsetType
    • affected endpoints:
      • POST /api/v3/orderList/oto
  • Added parameter pendingPegOffsetValue
    • affected endpoints:
      • POST /api/v3/orderList/oto
  • Added parameter pendingPegPriceType
    • affected endpoints:
      • POST /api/v3/orderList/oto
  • Added parameter price
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter quantity
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter recvWindow
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter selfTradePreventionMode
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter side
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter strategyId
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter strategyType
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter symbol
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter timeInForce
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter type
    • affected endpoints:
      • POST /api/v3/sor/order/test
  • Added parameter workingPegOffsetType
    • affected endpoints:
      • POST /api/v3/orderList/oto
      • POST /api/v3/orderList/otoco
  • Added parameter workingPegOffsetValue
    • affected endpoints:
      • POST /api/v3/orderList/oto
      • POST /api/v3/orderList/otoco
  • Added parameter workingPegPriceType
    • affected endpoints:
      • POST /api/v3/orderList/oto
      • POST /api/v3/orderList/otoco
  • Modified parameter computeCommissionRates:
    • affected endpoints:
      • POST /api/v3/order/test
      • POST /api/v3/sor/order/test

16.0.0 - 2025-07-23

Changed (1)

  • Added missing parameters on POST /api/v3/order/test

15.0.0 - 2025-07-22

Added (1)

  • GET /sapi/v1/localentity/questionnaire-requirements

Changed (2)

  • Added parameter recvWindow

    • affected endpoints:
      • GET /sapi/v1/addressVerify/list
      • GET /sapi/v1/localentity/vasp

  • Added parameters:

    • icebergQty
    • newClientOrderId
    • newClientOrderId
    • price
    • quantity
    • quoteOrderQty
    • recvWindow
    • selfTradePreventionMode
    • side
    • stopPrice
    • stopLimitPrice
    • stopLimitTimeInForce
    • newOrderRespType
    • workingType
    • type
    • affected endpoints:
      • POST /api/v3/order/test

14.0.0 - 2025-07-01

Added (12)

  • GET /sapi/v1/onchain-yields/account
  • GET /sapi/v1/onchain-yields/locked/history/redemptionRecord
  • GET /sapi/v1/onchain-yields/locked/history/rewardsRecord
  • GET /sapi/v1/onchain-yields/locked/history/subscriptionRecord
  • GET /sapi/v1/onchain-yields/locked/list
  • GET /sapi/v1/onchain-yields/locked/personalLeftQuota
  • GET /sapi/v1/onchain-yields/locked/position
  • GET /sapi/v1/onchain-yields/locked/subscriptionPreview
  • POST /sapi/v1/onchain-yields/locked/redeem
  • POST /sapi/v1/onchain-yields/locked/setAutoSubscribe
  • POST /sapi/v1/onchain-yields/locked/setRedeemOption
  • POST /sapi/v1/onchain-yields/locked/subscribe

13.0.0 - 2025-06-16

Added (1)

  • GET /sapi/v1/margin/list-schedule

12.0.0 - 2025-06-11

Added (1)

  • GET /sapi/v1/addressVerify/list

11.0.0 - 2025-06-05

Changed (1)

  • Fixed async signature generation script race condition.

Removed (2)

  • POST /sapi/v1/sub-account/blvt/enable
  • POST /sapi/v1/sub-account/margin/enable

10.0.0 - 2025-06-03

Changed (1)

  • Added parameter recvWindow
    • affected endpoints:
      • GET /sapi/v1/simple-earn/flexible/history/redemptionRecord

Removed (8)

  • GET /fapi/v1/lvtKlines
  • GET /sapi/v1/loan/collateral/data
  • GET /sapi/v1/loan/loanable/data
  • GET /sapi/v1/loan/ongoing/orders
  • POST /sapi/v1/loan/adjust/ltv
  • POST /sapi/v1/loan/borrow
  • POST /sapi/v1/loan/customize/margin_call
  • POST /sapi/v1/loan/repay

9.0.0 - 2025-05-29

Changed (1)

  • Marked as signed the following endpoints:
    • GET /sapi/v1/lending/auto-invest/target-asset/roi/list
    • POST /sapi/v1/portfolio/repay
    • GET /sapi/v1/dci/product/list
    • GET /sapi/v1/mining/hash-transfer/config/details/list
    • GET /sapi/v1/pay/transactions
    • GET /sapi/v1/simple-earn/locked/position

8.0.0 - 2025-05-26

Changed (2)

  • Updated GET /sapi/v1/portfolio/pmLoan-history to GET /sapi/v1/portfolio/pmloan-history
  • Modified parameter ipAddress for the following endpoints:
    • POST /sapi/v2/sub-account/subAccountApi/ipRestriction
    • DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList

Removed (1)

  • POST /sapi/v2/loan/flexible/repay/collateral

7.0.0 - 2025-05-19

Changed (1)

  • Added parameter repaymentType for POST /sapi/v2/loan/flexible/repay

6.0.1 - 2025-05-16

Changed

  • Updated signing script using Web Crypto API instead of CryptoJS.

6.0.0 - 2025-05-14

Changed

Spot

  • Updated request parameters to correctly specify their required status.

5.0.0 - 2025-04-25

Added

Derivatives Trading USDS Futures

  • GET /fapi/v1/insuranceBalance

Fixed

  • Fixed bug with with the testnet URLs.

4.0.0 - 2025-04-23

Added

Derivatives Trading Portfolio Margin Pro

  • POST /sapi/v1/portfolio/earn-asset-transfer

Wallett

  • GET /sapi/v1/capital/withdraw/quota

Changed

Derivatives Trading Portfolio Margin Pro

  • Removed POST /sapi/v1/portfolio/earn-asset-balance

Sub-Account

  • Marked as signed the following endpoints:
    • GET /sapi/v1/sub-account/transfer/subUserHistory
    • POST /sapi/v1/sub-account/transfer/subToMaster
    • POST /sapi/v1/sub-account/transfer/subToSub
    • POST /sapi/v1/managed-subaccount/deposit
    • GET /sapi/v1/managed-subaccount/asset
    • GET /sapi/v1/managed-subaccount/accountSnapshot
    • POST /sapi/v1/managed-subaccount/withdraw

Wallet

  • Removed subAccountIdRequired parameter from POST /sapi/v1/localentity/broker/withdraw/apply

Fixed

  • Fixed bug with duplicate environment script variables.

3.0.0 - 2025-04-15

Added

Derivatives Trading Portfolio Margin Pro

  • GET /sapi/v1/portfolio/earn-asset-balance
  • POST /sapi/v1/portfolio/earn-asset-balance

Changed

Simple Earn

  • Added current, size and recvWindow parameters to /sapi/v1/simple-earn/flexible/history/rewardsRecord.

2.2.0 - 2025-04-10

Added

Spot

  • PUT /api/v3/order/amend/keepPriority

Changed

  • Remove testnet_url from products that don't support it.

2.1.0 - 2025-03-28

Added

Sub-Account

  • GET /sapi/v1/sub-account/futures/move-position
  • POST /sapi/v1/sub-account/futures/move-position

Wallet

  • GET /sapi/v1/localentity/broker/deposit/provide-info
  • POST /sapi/v1/localentity/broker/withdraw/apply

Removed

Staking

  • POST /sapi/v1/eth-staking/wbeth/unwrap

2.0.0 - 2025-03-26

  • Added collections for all supported public APIs
  • Updated and simplified environments

1.17.0 - 2024-10-08

Spot

Added

Trade

  • POST /api/v3/orderList/oto
  • POST /api/v3/orderList/otoco

Margin

  • POST /sapi/v1/margin/order/oto
  • POST /sapi/v1/margin/order/otoco

Portfolio Margin

  • GET /sapi/v2/portfolio/collateralRate

Simple Earn

  • POST /sapi/v1/simple-earn/locked/setRedeemOption

Copy Trading

  • GET /sapi/v1/copyTrading/futures/userStatus
  • GET /sapi/v1/copyTrading/futures/leadSymbol

Updated

Simple Earn

  • POST /sapi/v1/simple-earn/locked/subscribe new parameter: redeemTo

USDs-Margined Futures

Added

Account

  • GET /fapi/v1/accountConfig
  • GET /fapi/v1/symbolConfig

Convert

  • GET /fapi/v1/convert/exchangeInfo
  • POST /fapi/v1/convert/getQuote
  • POST /fapi/v1/convert/acceptQuote
  • GET /fapi/v1/convert/orderStatus

Updated

Account

  • Updated deprecated endpoints GET /fapi/v2/balance, GET /fapi/v2/account and GET /fapi/v2/positionRisk to GET /fapi/v3/account, GET /fapi/v3/balance andGET /fapi/v3/positionRisk

Coin-Margined Futures

Deleted

  • GET /dapi/v1/pmExchangeInfo

1.16.0 - 2024-06-06

Spot

Added

Dual Investment

  • GET /sapi/v1/dci/product/list
  • POST /sapi/v1/dci/product/subscribe
  • GET /sapi/v1/dci/product/positions
  • GET /sapi/v1/dci/product/accounts
  • POST /sapi/v1/dci/product/auto_compound/edit-status

Loan

  • POST /sapi/v2/loan/flexible/borrow
  • GET /sapi/v2/loan/flexible/ongoing/orders
  • GET /sapi/v2/loan/flexible/borrow/history
  • POST /sapi/v2/loan/flexible/repay
  • GET /sapi/v2/loan/flexible/repay/history
  • POST /sapi/v2/loan/flexible/adjust/ltv
  • GET /sapi/v2/loan/flexible/ltv/adjustment/history
  • GET /sapi/v2/loan/flexible/loanable/data
  • GET /sapi/v2/loan/flexible/collateral/data

Staking

  • POST /sapi/v2/eth-staking/eth/stake
  • POST /sapi/v1/eth-staking/eth/redeem
  • GET /sapi/v1/eth-staking/eth/history/stakingHistory
  • GET /sapi/v1/eth-staking/eth/history/redemptionHistory
  • GET /sapi/v1/eth-staking/eth/history/rewardsHistory
  • GET /sapi/v1/eth-staking/eth/quota
  • GET /sapi/v1/eth-staking/eth/history/rateHistory
  • GET /sapi/v2/eth-staking/account
  • POST /sapi/v1/eth-staking/wbeth/wrap
  • GET /sapi/v1/eth-staking/wbeth/history/wrapHistory
  • GET /sapi/v1/eth-staking/wbeth/history/unwrapHistory
  • GET /sapi/v1/eth-staking/eth/history/wbethRewardsHistory

Trade

  • POST /api/v3/orderList/oco

Wallet

  • GET /sapi/v1/capital/withdraw/address/list
  • GET /sapi/v1/account/info

Updated

Convert

  • GET /sapi/v1/convert/exchangeInfo: Remove recvWindow, timestamp and signature parameters

Trade

  • GET /api/v3/account
  • GET /api/v3/trades
  • GET /api/v3/historicalTrades

Deleted

Loan

  • POST /sapi/v1/loan/flexible/borrow
  • GET /sapi/v1/loan/flexible/ongoing/orders
  • GET /sapi/v1/loan/flexible/borrow/history
  • POST /sapi/v1/loan/flexible/repay
  • GET /sapi/v1/loan/flexible/repay/history
  • POST /sapi/v1/loan/flexible/adjust/ltv
  • GET /sapi/v1/loan/flexible/ltv/adjustment/history
  • GET /sapi/v1/loan/flexible/loanable/data
  • GET /sapi/v1/loan/flexible/collateral/data

Trade

  • POST /api/v3/order/oco

USD-M Futures

Added

Account

  • GET /fapi/v1/rateLimit/order

Trade

  • POST /fapi/v1/feeBurn
  • GET /fapi/v1/feeBurn

Updated

Order

  • PUT /fapi/v1/order

1.15.0 - 2024-02-05

Spot

Added

Margin

  • POST /sapi/v1/margin/borrow-repay
  • GET /sapi/v1/margin/borrow-repay

Wallet

  • GET /sapi/v1/spot/delist-schedule

Convert

  • POST /sapi/v1/convert/limit/placeOrder
  • POST /sapi/v1/convert/limit/cancelOrder
  • GET /sapi/v1/convert/limit/queryOpenOrders

Updated

  • Add optional parameter accountType in the endpoints below:
    • GET /sapi/v1/asset/dribblet
    • POST /sapi/v1/asset/dust-btc
    • POST /sapi/v1/asset/dust
  • Add optional parameter symbol in the endpoints below:
    • GET /sapi/v1/margin/allPairs
    • GET /sapi/v1/margin/isolated/allPairs
  • GET /sapi/v1/margin/transfer add optional parameter isolatedSymbol
  • GET /sapi/v1/margin/allAssets add optional parameter asset

Deleted

Bswap

  • 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
  • GET /sapi/v1/bswap/poolConfigure
  • GET /sapi/v1/bswap/addLiquidityPreview
  • GET /sapi/v1/bswap/removeLiquidityPreview
  • GET /sapi/v1/bswap/unclaimedRewards
  • POST /sapi/v1/bswap/claimRewards
  • GET /sapi/v1/bswap/claimedHistory

Margin

  • POST /sapi/v1/margin/transfer will be removed, please replace with POST /sapi/v1/asset/transfer universal transfer
  • POST /sapi/v1/margin/isolated/transfer will be removed, please replace with POST /sapi/v1/asset/transfer universal transfer
  • POST /sapi/v1/margin/loan will be removed, please replace with the new POST /sapi/v1/margin/borrow-repay borrowing and repayment interface
  • POST /sapi/v1/margin/repay will be removed, please replace with the new POST /sapi/v1/margin/borrow-repay borrowing and repayment interface
  • GET /sapi/v1/margin/isolated/transfer will be removed, please replace it with GET /sapi/v1/margin/transfer to get total margin transfer history
  • GET /sapi/v1/margin/asset will be removed, please replace with GET /sapi/v1/margin/allAssets
  • GET /sapi/v1/margin/pair will be removed, please replace with GET /sapi/v1/margin/allPairs
  • GET /sapi/v1/margin/isolated/pair will be removed, please replace with GET /sapi/v1/margin/isolated/allPairs
  • GET /sapi/v1/margin/loan will be removed, please replace with GET /sapi/v1/margin/borrow-repay
  • GET /sapi/v1/margin/repay will be removed, please replace with GET /sapi/v1/margin/borrow-repay
  • GET /sapi/v1/margin/dribblet will be removed, please replace with GET /sapi/v1/asset/dribblet
  • GET /sapi/v1/margin/dust will be removed, please replace with POST /sapi/v1/asset/dust-btc
  • POST /sapi/v1/margin/dust will be removed, please replace with POST /sapi/v1/asset/dust

Staking

  • GET /sapi/v1/staking/productList
  • POST /sapi/v1/staking/purchase
  • POST /sapi/v1/staking/redeem
  • GET /sapi/v1/staking/position
  • GET /sapi/v1/staking/stakingRecord
  • POST /sapi/v1/staking/setAutoStaking
  • GET /sapi/v1/staking/personalLeftQuota

1.14.0 - 2023-12-12

Spot

Added

  • GET /api/v3/account/commission
  • GET /api/v3/ticker/tradingDay
  • GET /sapi/v1/margin/leverageBracket
  • GET /sapi/v1/capital/deposit/address/list

Updated

  • GET /api/v3/klines and GET /api/v3/uiKlines have a new optional parameter timeZone.
  • POST /api/v3/order/test and POST /api/v3/sor/order/test have a new optional parameter computeCommissionRates.

UM Futures

  • Replace GET /fapi/v1/ticker/price by GET /fapi/v2/ticker/price

1.13.0 -2023-11-16

Updated

  • GET /dapi/v1/income Add parameter page for pagination
  • GET /fapi/v1/income Add parameter page for pagination
  • Add optional parameter goodTillDate in the endpoints below to set order's goodTillDate :
    • POST /fapi/v1/order
  • Add optional parameter priceMatch in the endpoints below to set order's priceMatch mode:
    • POST /fapi/v1/order
  • Add optional parameter selfTradePreventionMode in the endpoints below to set order's STP mode:
    • POST /fapi/v1/order
  • POST /sapi/v1/loan/vip/borrow add field isFlexibleRate to borrow using flexible rate loan
  • POST /sapi/v1/simple-earn/flexible/subscribe new parameter sourceAccount
  • POST /sapi/v1/simple-earn/locked/subscribe new parameter sourceAccount
  • POST /sapi/v1/simple-earn/flexible/redeem new parameter destAccount
  • Changes to Margin Endpoint GET /sapi/v1/margin/isolated/transfer:
    • Add request field type
    • Delete request field transFrom, transTo
  • POST /sapi/v1/portfolio/repay add paramater from

Added

  • GET /dapi/v1/income/asyn get Download Id For Futures Transaction History
  • GET /dapi/v1/income/asyn/id to get Futures Transaction History Download Link by Id
  • GET /dapi/v1/fundingInfo query adjusted funding info
  • GET /dapi/v1/constituents query index constituents
  • GET /futures/data/delivery-price query quarterly contract settlement price
  • GET /fapi/v1/fundingInfo query adjusted funding info
  • GET /fapi/v1/constituents query index constituents
  • GET /futures/data/delivery-price query quarterly contract settlement price
  • GET /futures/data/basis query basis data
  • New endpoints for order placement using SOR:
    • POST /api/v3/sor/order
    • POST /api/v3/sor/order/test
  • GET /api/v3/myAllocations
  • POST /sapi/v1/loan/flexible/borrow flexible Loan borrow
  • GET /sapi/v1/loan/flexible/ongoing/orders get flexible loan ongoing orders
  • GET /sapi/v1/loan/flexible/borrow/history Get flexible loan borrow history
  • POST /sapi/v1/loan/flexible/repay flexible loan repay
  • POST /sapi/v1/loan/flexible/repay/history Get flexible loan repayment history
  • POST /sapi/v1/loan/flexible/adjust/ltv adjust flexible Loan adjust LTV
  • GET /sapi/v1/loan/flexible/ltv/adjustment/history Get Flexible loan LTV adjustment history
  • GET /sapi/v1/loan/flexible/loanable/data Get flexible loan assets data
  • GET /sapi/v1/loan/flexible/collateral/data Get flexible loan collateral assets data
  • GET /sapi/v1/margin/capital-flow Get cross or isolated margin capital flow
  • GET /sapi/v1/portfolio/margin-asset-leverage Get Portfolio Margin Asset Leverage
  • GET /sapi/v1/lending/auto-invest/index/info query index details
  • GET /sapi/v1/lending/auto-invest/index/user-summary query index linked plan position details
  • POST /sapi/v1/lending/auto-invest/one-off One Time transaction
  • GET /sapi/v1/lending/auto-invest/one-off/status query one-time transaction status
  • POST /sapi/v1/lending/auto-invest/redeem index linked plan redemption
  • GET /sapi/v1/lending/auto-invest/redeem/history query index Linked plan Redemption history
  • GET /sapi/v1/lending/auto-invest/rebalance/history query index linked plan rebalance details
  • GET /sapi/v1/asset/wallet/balance query user wallet balance
  • GET /sapi/v1/asset/custody/transfer-history query user delegation history(For Master Account)
  • GET /sapi/v1/futures/histDataLink query futures ticklevel orderbook historicak data download link
  • GET /sapi/v1/loan/vip/request/interestRate Get Borrow Interest Rate
  • GET /sapi/v1/margin/available-inventory Query margin available inventory
  • POST /sapi/v1/margin/manual-liquidation Margin manual liquidation

Deleted

  • GET /sapi/v1/futures/loan/borrow/history
  • GET /sapi/v1/futures/loan/repay/history
  • GET /sapi/v2/futures/loan/wallet
  • GET /sapi/v1/futures/loan/adjustCollateral/history
  • GET /sapi/v1/futures/loan/liquidationHistory
  • GET /sapi/v1/futures/loan/interestHistory

1.12.0 - 2023-08-07

Spot API Collection

Added

Spot Algo:

  • POST /sapi/v1/algo/spot/newOrderTwap: Place a new spot TWAP order with Algo service.
  • DELETE /sapi/v1/algo/spot/order: Cancel an open TWAP order.
  • GET /sapi/v1/algo/spot/openOrders: Get all open SPOT TWAP orders.
  • GET /sapi/v1/algo/spot/historicalOrders: Get all historical SPOT TWAP orders.
  • GET /sapi/v1/algo/spot/subOrders: Get respective sub orders for a specified algoId.

Sub-Account:

  • GET /sapi/v1/managed-subaccount/deposit/address: Get investor's managed sub-account deposit address.
  • GET /sapi/v1/managed-subaccount/query-trans-log: Query Managed Sub Account Transfer Log (For Trading Team Sub Account).
  • GET /sapi/v1/managed-subaccount/queryTransLogForInvestor: Investor can use this api to query managed sub account transfer log. This endpoint is available for investor of Managed Sub-Account. A Managed Sub-Account is an account type for investors who value flexibility in asset allocation and account application, while delegating trades to a professional trading team.
  • GET /sapi/v1/managed-subaccount/queryTransLogForTradeParent: Trading team can use this api to query managed sub account transfer log.
  • 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/managed-subaccount/info: Get investor's managed sub-account list.
  • POST /sapi/v1/sub-account/eoptions/enable: Enable Options for Sub-account (For Master Account).
  • GET /sapi/v4/sub-account/assets: Fetch sub-account assets
  • GET /sapi/v1/sub-account/transaction-statistics: Query Sub-account Transaction statistics (For Master Account).

Portfolio:

  • GET /sapi/v1/portfolio/asset-index-price: Query Portfolio Margin Asset Index Price.
  • GET /sapi/v1/portfolio/repay-futures-switch: Change Auto-repay-futures Status.
  • POST /sapi/v1/portfolio/auto-collection: Transfers all assets from Futures Account to Margin account.
  • POST /sapi/v1/portfolio/bnb-transfer: BNB transfer can be between Margin Account and USDM Account.
  • POST /sapi/v1/portfolio/repay-futures-switch: Change Auto-repay-futures Status.
  • POST /sapi/v1/portfolio/repay-futures-negative-balance: Repay futures Negative Balance.
  • POST /sapi/v1/portfolio/asset-collection: Transfers specific asset from Futures Account to Margin account.
  • GET /sapi/v1/portfolio/interest-history: Query interest history of negative balance for portfolio margin.

Wallet:

  • POST /sapi/v1/capital/deposit/credit-apply: Apply deposit credit for expired address (One click arrival).
  • GET /sapi/v1/capital/contract/convertible-coins: Get a user's auto-conversion settings in deposit/withdrawal.
  • POST /sapi/v1/capital/contract/convertible-coins: User can use it to turn on or turn off the BUSD auto-conversion from/to a specific stable coin.

Simple Earn:

  • GET /sapi/v1/simple-earn/flexible/list: Get available Simple Earn flexible product list.
  • GET /sapi/v1/simple-earn/locked/list: Get available Simple Earn locked product list.
  • POST /sapi/v1/simple-earn/flexible/subscribe: Subscribe flexibe product.
  • POST /sapi/v1/simple-earn/locked/subscribe: Subscribe locked product.
  • POST /sapi/v1/simple-earn/flexible/redeem: Redeem flexible product.
  • POST /sapi/v1/simple-earn/locked/redeem: Redeem locked product.
  • GET /sapi/v1/simple-earn/flexible/position: Get flexible product position.
  • GET /sapi/v1/simple-earn/locked/position: Get locked product position.
  • GET /sapi/v1/simple-earn/account: Get account details.
  • GET /sapi/v1/simple-earn/flexible/history/subscriptionRecord: Get flexible subscription record.
  • GET /sapi/v1/simple-earn/locked/history/subscriptionRecord: Get locked subscription record.
  • GET /sapi/v1/simple-earn/flexible/history/redemptionRecord: Get flexible redemption record.
  • GET /sapi/v1/simple-earn/locked/history/redemptionRecord: Get locked redemption record.
  • GET /sapi/v1/simple-earn/flexible/history/rewardsRecord: Get flexible rewards history.
  • GET /sapi/v1/simple-earn/locked/history/rewardsRecord: Get locked rewards history.
  • POST /sapi/v1/simple-earn/flexible/setAutoSubscribe: Set flexible auto subscribe.
  • POST /sapi/v1/simple-earn/locked/setAutoSubscribe: Set locked auto subscribe.
  • GET /sapi/v1/simple-earn/flexible/personalLeftQuota: Get flexible personal left quota.
  • GET /sapi/v1/simple-earn/locked/personalLeftQuota: Get locked personal left quota.
  • GET /sapi/v1/simple-earn/flexible/subscriptionPreview: Get flexible subscription preview.
  • GET /sapi/v1/simple-earn/locked/subscriptionPreview: Get locked subscription preview.
  • GET /sapi/v1/simple-earn/flexible/history/rateHistory: Get rate history.
  • GET /sapi/v1/simple-earn/flexible/history/collateralRecord: Get collateral record.

Auto-Investment:

  • GET /sapi/v1/lending/auto-invest/target-asset/list: Get target asset list.
  • GET /sapi/v1/lending/auto-invest/target-asset/roi/list: ROI return list for target asset.
  • GET /sapi/v1/lending/auto-invest/all/asset: Query all source assets and target assets.
  • GET /sapi/v1/lending/auto-invest/source-asset/list: Query Source Asset to be used for investment.
  • GET /sapi/v1/lending/auto-invest/plan/list: Query plan lists.
  • GET /sapi/v1/lending/auto-invest/plan/id: Query holding details of the plan
  • GET /sapi/v1/lending/auto-invest/history/list: Query subscription transaction history of a plan
  • POST /sapi/v1/lending/auto-invest/plan/add: Post an investment plan creation.
  • POST /sapi/v1/lending/auto-invest/plan/edit: Query Source Asset to be used for investment.
  • POST /sapi/v1/lending/auto-invest/plan/edit-status: Change Plan Status.

Margin:

  • GET /sapi/v1/margin/dust: Get assets that can be converted into BNB.
  • POST /sapi/v1/margin/dust: Convert dust assets to BNB.
  • GET /sapi/v1/margin/crossMarginCollateralRatio: Get cross margin account details.
  • GET /sapi/v1/margin/exchange-small-liability: Query the coins which can be small liability exchange.
  • POST /sapi/v1/margin/exchange-small-liability: Cross Margin Small Liability Exchange.
  • GET /sapi/v1/margin/exchange-small-liability-history: Get Small liability Exchange History.
  • GET /sapi/v1/margin/next-hourly-interest-rate: Get user the next hourly estimate interest.
  • GET /sapi/v1/margin/delist-schedule: Get tokens or symbols delist schedule for cross margin and isolated margin.
  • POST /sapi/v1/margin/max-leverage: Adjust cross margin max leverage

VIP loan:

  • POST /sapi/v1/loan/vip/renew: VIP loan is available for VIP users only.
  • POST /sapi/v1/loan/vip/borrow: VIP loan is available for VIP users only.
  • GET /sapi/v1/loan/vip/loanable/data: Get interest rate and borrow limit of loanable assets. The borrow limit is shown in USD value.
  • GET /sapi/v1/loan/vip/collateral/data: Get Collateral Asset Data.
  • GET /sapi/v1/loan/vip/request/data: Query the application status.

Updated

Margin:

  • POST /sapi/v1/margin/order: Add fields autoRepayAtCancel and selfTradePreventionMode:
  • POST /sapi/v1/margin/order/oco: Add fields autoRepayAtCancel and selfTradePreventionMode

Deleted

Lending:

  • GET /sapi/v1/lending/daily/product/list
  • GET /sapi/v1/lending/daily/userLeftQuota
  • GET /sapi/v1/lending/daily/userRedemptionQuota
  • 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
  • POST /sapi/v1/lending/daily/redeem
  • POST /sapi/v1/lending/daily/purchase

Sub-Account:

  • POST /sapi/v1/sub-account/subAccountApi/ipRestriction
  • POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList

USDⓈ-Margined Futures Collection

Added

  • PUT /fapi/v1/order: Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue.
  • PUT /fapi/v1/batchOrders: Modify Multiple Orders.
  • GET /fapi/v1/orderAmendment: Get order modification history.
  • GET /fapi/v1/order/asyn: Get download id for futures order history.
  • GET /fapi/v1/order/asyn/id: Get futures order history download link by id.
  • GET /fapi/v1/trade/asyn: Get download id for futures trade history.
  • GET /fapi/v1/trade/asyn/id: Get futures trade download link by id.

Deleted

  • GET /fapi/v1/pmExchangeInfo

European Options Collection

Added

  • GET /eapi/v1/order: Check an order status.
  • GET /eapi/v1/income/asyn/id: Get option transaction history download link by id.
  • GET /eapi/v1/income/asyn: Get download id for option transaction history.

Deleted

  • /eapi/v1/transfer

1.11.1 - 2023-04-14

  • Added missing X-MBX-APIKEY and Content Type headers to the Crypto Loan endpoints

1.11.0 - 2023-03-24

  • Rename collections
  • Fix an bug that if the timestamp is not in the last second position, the request could return error.

1.10.0 - 2022-12-23

Spot API Collection

Added

VIP Loans:

  • GET /sapi/v1/loan/vip/collateral/account: Check Locked Value of VIP Collateral Account
  • GET /sapi/v1/loan/vip/ongoing/orders: Get VIP Loan Ongoing

Orders

  • POST /sapi/v1/loan/vip/repay: VIP Loan Repay
  • GET /sapi/v1/loan/vip/repay/history: Get VIP Loan Repayment History

Crypto Loan:

  • GET /sapi/v1/loan/loanable/data: Get interest rate and borrow limit of loanable assets. The borrow limit is shown in USD value.
  • GET /sapi/v1/loan/collateral/data: Get LTV information and collateral limit of collateral assets. The collateral limit is shown in USD value.
  • GET /sapi/v1/loan/repay/collateral/rate: Get the the rate of collateral coin / loan coin when using collateral repay, the rate will be valid within 8 second.
  • POST /sapi/v1/loan/customize/margin_call: Customize margin call for ongoing orders only.

Convert:

  • GET /sapi/v1/convert/exchangeInfo: Query for all convertible token pairs and the tokens’ respective upper/lower limits
  • GET /sapi/v1/convert/assetInfo: Query for supported asset’s precision information
  • POST /sapi/v1/convert/getQuote: Request a quote for the requested token pairs
  • POST /sapi/v1/convert/acceptQuote: Accept the offered quote by quote ID.
  • GET /sapi/v1/convert/orderStatus: Query order status by order ID.

Wallet:

  • POST /sapi/v1/asset/convert-transfer: New parameter accountType
  • POST /sapi/v1/asset/convert-transfer/queryByPage: request method is changed to GET, new parameter clientTranId
  • GET /sapi/v1/asset/ledger-transfer/cloud-mining/queryByPage: The query of Cloud-Mining payment and refund history Sub-account:
  • GET /sapi/v1/sub-account/apiRestrictions/ipRestriction/thirdPartyList: To query Sub-Account API key Third Party IP whitelist
  • POST /sapi/v2/sub-account/subAccountApi/ipRestriction: To support master account update IP Restriction for Sub-Account API key

Binance Code:

  • POST /sapi/v1/giftcard/buyCode: For buying a fixed-value Binance Code.
  • GET /sapi/v1/giftcard/buyCode/token-limit: To verify which tokens are available for you to purchase fixed-value gift cards as mentioned in section 2 and its’ limitation.