Skip to main content

Change Log

2024-08-15

  • New parameter filterResult will be available on August 16, 2024 for query futures commission rebate record:GET /sapi/v1/broker/rebate/futures/recentRecord . If filterResult = TRUE, rebates not from its own sub accounts will be filtered out in response.

2024-06-28

  • New Endpoint for query futures assets of sub-accounts:GET /sapi/v3/broker/subAccount/futuresSummary .
  • Following endpoints will be deleted in a month: GET /sapi/v1/broker/subAccount/futuresSummary ,GET /sapi/v2/broker/subAccount/futuresSummary . Please migrate the usage of legacy version(v1&v2) to the new (v3) version as soon as possible.

2024-06-06

  • Endpoints adjustment: for internal transfers, the txid prefix has been replaced to “Off-chain transfer”on 28 May 2024. “internal transfer” flag is no longer available in the TXID field, including historical transactions, the following endpoints are impacted: GET /sapi/v1/broker/subAccount/depositHist.

2024-04-30

  • Update the request limit for endpoint: POST /sapi/v1/broker/subAccountApi. You can only create 1 api key for each sub account per second

  • Update the request limit for endpoint: DELETE /sapi/v1/broker/subAccountApi. You can only delete 1 api key for each sub account per second

2024-03-05

  • Remove endpoint: POST /sapi/v1/broker/subAccount/blvt.

2023-12-15

  • Update the default parameter values of endpoint: GET /sapi/v1/broker/universalTransfer.

2023-11-20

  • Add depositId and selfReturnStatus in response of endpoint: GET /sapi/v1/broker/subAccount/deposit.

2023-10-04

  • Remove endpoint: POST /sapi/v1/broker/subAccountApi/permission/vanillaOptions.

2023-08-31

  • Remove endpoint: POST /sapi/v1/broker/subAccount/margin. To enable the margin account, simply transfer assets into Cross Margin wallet.

2023-06-08

  • Update weight for endpoint: POST /sapi/v1/broker/subAccountApi. Weight(Master Account) changed to 3000

2023-01-13

  • Remove 2 endpoints: POST /sapi/v1/broker/subAccountApi/ipRestriction, POST /sapi/v1/broker/subAccountApi/ipRestriction/ipList.

2022-12-16

  • Remove "thirdPartyName" for POST /sapi/v2/broker/subAccountApi/ipRestriction (HMAC SHA256), POST /sapi/v1/broker/subAccountApi/ipRestriction, POST /sapi/v1/broker/subAccountApi/ipRestriction/ipList, DELETE /sapi/v1/broker/subAccountApi/ipRestriction/ipList.

2022-11-28

  • Add "the max length is 32 characters" in the description of clientTranId for endpoints POST /sapi/v1/broker/universalTransfer, POST /sapi/v1/broker/transfer/futures, POST /sapi/v1/broker/transfer.

2022-11-18

  • Added new endpoint POST /sapi/v2/sub-account/subAccountApi/ipRestriction to support user update IP Restriction for Sub-Account API key.

2022-09-22

  • Update POST /sapi/v1/broker/subAccountApi/ipRestriction to support user enable or disable Third party IP list name restriction for sub-account api key.
  • Update POST /sapi/v1/broker/subAccountApi/ipRestriction/ipList to support user update Third party IP list name restriction for sub-account api key.
  • Update DELETE /sapi/v1/broker/subAccountApi/ipRestriction/ipList to support user delete Third party IP list name restriction for sub-account api key.

2022-09-12

  • Update GET /sapi/v1/broker/subAccountApi/ipRestriction to support user query third party IP list name.

2022-08-23

  • Add 100-days query scope for GET /sapi/v1/broker/universalTransfer and GET /sapi/v1/broker/transfer.
  • Add requests per UID are limited to 60 requests per minute for GET /sapi/v1/broker/subAccount/spotSummary.

2022-06-27

  • Added a new rebate status field in API response for endpoints GET /sapi/v1/broker/rebate/futures/recentRecord and GET /sapi/v1/broker/rebate/recentRecord.

2021-04-29

  • Added parameter tag and new field email in endpoint POST /sapi/v1/broker/subAccount.

2021-03-26

  • Added new endpoint POST /sapi/v1/broker/subAccountApi/permission/universalTransfer to enable the api permission for a sub account to use POST /sapi/v1/asset/transferendpoint.
  • Added new endpoint POST /sapi/v1/broker/subAccountApi/permission/vanillaOptions to enable Vanilla Options permission for sub account api key.

2021-02-04

  • Added parameter fromId and toId in endpoint GET /sapi/v1/broker/transfer. The parameter subaccountId will be removed on 02/10 16:00(UTC+8). Please adjust the program as soon as possible.

2021-02-04

  • Added parameter showAllStatus in endpoint GET /sapi/v1/broker/universalTransfer.

2021-01-27

  • Added new endpoint GET /sapi/v2/broker/subAccount/futuresSummary to support query subaccount Coin Margined Futures asset info.

2021-01-14

  • Added parameter clientTranId in endpoint POST /sapi/v1/broker/transfer/futures and GET /sapi/v1/broker/transfer/futures.

2020-12-28

  • Added parameters page and size in endpoint GET /sapi/v1/broker/subAccountApi.

2020-12-14

  • The endpoint GET /sapi/v1/broker/transfer/futures can only get the latest history of past 30 days.

2020-12-10

  • Added new endpoint POST /sapi/v1/broker/universalTransfer to transfer spot and futures asset between master account and sub accounts.
  • Added new endpoint GET /sapi/v1/broker/universalTransfer to get universal transfer history.

2020-11-27

  • Added tranId in response of endpoint GET /sapi/v1/broker/transfer/futures.

2020-10-23

  • Added parameter showAllStatus in endpoint GET /sapi/v1/broker/transfer.

2020-10-12

  • Added parameter status in the response of endpoint GET /sapi/v1/broker/transfer.

2020-09-16

  • Added new endpoint POST /sapi/v1/broker/subAccountApi/commission/coinFutures to change sub- account COIN-Ⓜ futures commission adjustment.
  • Added new endpoint GET /sapi/v1/broker/subAccountApi/commission/coinFutures query sub- account COIN-Ⓜ futures commission adjustment.
  • Added parameter confirmTimes in endpoint GET /sapi/v1/broker/subAccount/depositHist.

2020-09-11

  • Added parameter email in endpoint GET /sapi/v1/broker/subAccount.

2020-09-07

  • Added new endpoint POST /sapi/v1/broker/subAccountApi/ipRestriction to enable or disable IP restriction for sub-account api key.
  • Added new endpoint POST /sapi/v1/broker/subAccountApi/ipRestriction/ipList to add IP restricion for sub-account api key.
  • Added new endpoint GET /sapi/v1/broker/subAccountApi/ipRestriction to get IP restriction for sub-account api key.
  • Added new endpoint DELETE /sapi/v1/broker/subAccountApi/ipRestriction/ipList to delete IP restriction for sub-account api key.

2020-09-02

  • Added new endpoint GET /sapi/v1/broker/rebate/futures/recentRecord to get futures commision rebate record.
  • Added new endpoint POST /sapi/v1/broker/transfer/futures to transfer futures asset directly.
  • Added new endpoint GET /sapi/v1/broker/transfer/futures to get futures transfer history.

2020-08-25

  • Added parameters page and size in endpoint GET /sapi/v1/broker/rebate/recentRecord.

2020-07-29

  • Added new endpoint POST /sapi/v1/broker/subAccount/blvt to enable leverage token for sub-account.

2020-07-21

  • Added parameters page and size in endpoint GET /sapi/v1/broker/subAccount.

2020-07-10

  • Added default limit 500 in endpoint GET /sapi/v1/broker/transfer.

2020-06-15

  • Added new endpoint GET /sapi/v1/broker/subAccount/spotSummary to query sub accounts spot asset.
  • Added new endpoint GET /sapi/v1/broker/subAccount/marginSummary to query sub accounts margin asset.
  • Added new endpoint GET /sapi/v1/broker/subAccount/futuresSummary to query sub accounts futures asset.

2020-06-12

  • Added new endpoint GET /sapi/v1/broker/rebate/recentRecord to query broker commission rebate recent record.

2020-06-11

  • Added new endpoint GET /sapi/v1/broker/subAccount/depositHist to query sub accounts deposit history.

2020-04-22

  • New fields in response to GET /sapi/v1/broker/subAccountApi/commission/futures and POST /sapi/v1/broker/subAccountApi/commission/futures:
    • makerCommission for current futures commission ratio for maker;
    • takerCommission for current futures commission ratio for taker;

2020-04-03

  • Added new endpoint POST /sapi/v1/broker/subAccount/bnbBurn/spot to enable or disable BNB Burn for sub-account spot and margin.

  • Added new endpoint POST /sapi/v1/broker/subAccount/bnbBurn/marginInterest to enable or disable BNB Burn for sub-account margin interest.

  • Added new endpoint GET /sapi/v1/broker/subAccount/bnbBurn/status to get BNB Burn status for sub-account.

2020-03-27

  • Added parameters clientTranId in endpoints:
    • POST /sapi/v1/broker/transfer,
    • GET /sapi/v1/broker/transfer.

2020-02-12

  • The below endpoints will be released in the future:
    • new endpoint GET /sapi/v1/broker/rebate/recentRecord to query broker commission rebate recent record.
    • new endpoint GET /sapi/v1/broker/rebate/historicalRecord to get broker commission rebate historical record.

2019-12-23

  • Added new endpoint POST /sapi/v1/broker/subAccountApi/commission/futures to change sub-account futures commission adjustment.

  • Added new endpoint GET /sapi/v1/broker/subAccountApi/commission/futures to query sub-account futures commission adjustment.

2019-11-11

  • Added parameters marginTrade and futuresTrade in endpoints:

    • POST /sapi/v1/broker/subAccountApi,
    • POST /sapi/v1/broker/subAccountApi/permission.

  • Added keys marginTrade and futuresTrade in responses to endpoints:

    • POST /sapi/v1/broker/subAccountApi,
    • GET /sapi/v1/broker/subAccountApi,
    • POST /sapi/v1/broker/subAccountApi/permission.

  • Added parameters marginMakerCommission and marginTakerCommission in endpoint POST /sapi/v1/broker/subAccountApi/commission.

  • Added keys marginMakerCommission and marginTakerCommission in responses to endpoints:

    • POST /sapi/v1/broker/subAccountApi/commission,
    • Get /sapi/v1/broker/subAccount/.

  • Added new endpoint POST /sapi/v1/broker/subAccount/margin for setting subaccount enable on margin.

  • Added new endpoint POST /sapi/v1/broker/subAccount/futures for setting subaccount enable on futures.