Server Details
Binance MCP server — 340 tools for AI agent integration. Hosted by Junct.
- Status
- Healthy
- Last Tested
- Transport
- Streamable HTTP
- URL
- Repository
- junct-bot/binance-mcp
- GitHub Stars
- 0
See and control every tool call
Available Tools
340 toolsdelete_api_v3_open_ordersInspect
Cancel all Open Orders on a Symbol (TRADE) — Cancels all active orders on a symbol. This includes OCO orders.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_api_v3_orderInspect
Cancel Order (TRADE) — Cancel an active order.
Either orderId or origClientOrderId must be sent.
Weight(IP): 1 Returns: { symbol: string, origClientOrderId: string, orderId: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_api_v3_order_listInspect
Cancel OCO (TRADE) — Cancel an entire Order List
Canceling an individual leg will cancel the entire OCO
Weight(IP): 1 Returns: { orderListId: number, contingencyType: string, listStatusType: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_api_v3_user_data_streamInspect
Close a ListenKey (USER_STREAM) — Close out a user data stream.
Weight: 2
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_algo_futures_orderInspect
Cancel Algo Order(TRADE) — Cancel an active order.
You need to enable Futures Trading Permission for the api key which requests this endpoint.
Base URL: https://api.binance.com
Weight(IP): 1 Returns: { algoId: number, success: boolean, code: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| algoId | Yes | Eg. 14511 | |
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_algo_spot_orderInspect
Cancel Algo Order — Cancel an open TWAP order
Weight(IP): 1 Returns: { algoId: number, success: boolean, code: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| algoId | Yes | query parameter: algoId (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_margin_isolated_accountInspect
Disable Isolated Margin Account (TRADE) — Disable isolated margin account for a specific symbol. Each trading pair can only be deactivated once every 24 hours .
Weight(UID): 300 Returns: { success: boolean, symbol: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_margin_open_ordersInspect
Margin Account Cancel all Open Orders on a Symbol (TRADE) — - Cancels all active orders on a symbol for margin account.
This includes OCO orders.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_margin_orderInspect
Margin Account Cancel Order (TRADE) — Cancel an active order for margin account.
Either orderId or origClientOrderId must be sent.
Weight(IP): 10 Returns: { symbol: string, orderId: number, origClientOrderId: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_margin_order_listInspect
Margin Account Cancel OCO (TRADE) — Cancel an entire Order List for a margin account
Canceling an individual leg will cancel the entire OCO
Either
orderListIdorlistClientOrderIdmust be provided
Weight(UID): 1 Returns: { orderListId: number, contingencyType: string, listStatusType: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_sub_account_sub_account_api_ip_restriction_ip_listInspect
Delete IP List for a Sub-account API Key (For Master Account) — Weight(UID): 3000 Returns: { ipRestrict: string, ipList: string[], updateTime: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_user_data_streamInspect
Close a ListenKey (USER_STREAM) — Close out a user data stream.
Weight: 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
delete_sapi_v1_user_data_stream_isolatedInspect
Close a ListenKey (USER_STREAM) — Close out a user data stream.
Weight: 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_accountInspect
Account Information (USER_DATA) — Get current account information.
Weight(IP): 20 Returns: { makerCommission: number, takerCommission: number, buyerCommission: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_account_commissionInspect
Query Commission Rates (USER_DATA) — Get current account commission rates.
Weight: 20 Returns: { symbol: string, standardCommission: { maker: string, taker: string, buyer: string, seller: string }, taxCommission: { maker: string, taker: string, buyer: string, seller: string }, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_agg_tradesInspect
Compressed/Aggregate Trades List — Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.
If
fromId,startTime, andendTimeare not sent, the most recent aggregate trades will be returned.Note that if a trade has the following values, this was a duplicate aggregate trade and marked as invalid:
p = '0' // price
q = '0' // qty
f = -1 // first_trade_id
l = -1 // last_trade_id
Weight(IP): 2
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_all_order_listInspect
Query all OCO (USER_DATA) — Retrieves all OCO based on provided optional parameters
Weight(IP): 20
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_all_ordersInspect
All Orders (USER_DATA) — Get all account orders; active, canceled, or filled..
If
orderIdis set, it will get orders >= thatorderId. Otherwise most recent orders are returned.For some historical orders
cummulativeQuoteQtywill be < 0, meaning the data is not available at this time.If
startTimeand/orendTimeprovided,orderIdis not required
Weight(IP): 20
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_avg_priceInspect
Current Average Price — Current average price for a symbol.
Weight(IP): 2 Returns: { mins: number, price: string, closeTime: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_depthInspect
Order Book — | Limit | Weight(IP) | |---------------------|-------------| | 1-100 | 5 | | 101-500 | 25 | | 501-1000 | 50 | | 1001-5000 | 250 | Returns: { lastUpdateId: number, bids: string[][], asks: string[][] }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | If limit > 5000, then the response will truncate to 5000 | |
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_exchange_infoInspect
Exchange Information — Current exchange trading rules and symbol information
If any symbol provided in either symbol or symbols do not exist, the endpoint will throw an error.
All parameters are optional.
permissions can support single or multiple values (e.g. SPOT, ["MARGIN","LEVERAGED"])
If permissions parameter not provided, the default values will be ["SPOT","MARGIN","LEVERAGED"].
To display all permissions you need to specify them explicitly. (e.g. SPOT, MARGIN,...)
Examples of Symbol Permissions Interpretation from the Response:
[["A","B"]] means you may place an order if
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_historical_tradesInspect
Old Trade Lookup — Get older market trades.
Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_klinesInspect
Kline/Candlestick Data — Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.
If
startTimeandendTimeare not sent, the most recent klines are returned.
Weight(IP): 2
| Name | Required | Description | Default |
|---|---|---|---|
| interval | Yes | kline intervals | |
| timeZone | No | Default: 0 (UTC) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_my_allocationsInspect
Query Allocations (USER_DATA) — Retrieves allocations resulting from SOR order placement.
Weight: 20
Supported parameter combinations: Parameters Response symbol allocations from oldest to newest symbol + startTime oldest allocations since startTime symbol + endTime newest allocations until endTime symbol + startTime + endTime allocations within the time range symbol + fromAllocationId allocations by allocation ID symbol + orderId allocations related to a
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| fromAllocationId | No | query parameter: fromAllocationId (number) |
get_api_v3_my_prevented_matchesInspect
Query Prevented Matches — Displays the list of orders that were expired because of STP.
For additional information on what a Prevented match is, as well as Self Trade Prevention (STP), please refer to our STP FAQ page.
These are the combinations supported:
symbol + preventedMatchId
symbol + orderId
symbol + orderId + fromPreventedMatchId (limit will default to 500)
symbol + orderId + fromPreventedMatchId + limit
Weight(IP):
Case Weight If symbol is invalid: 2 Querying by preventedMatchId: 2 Querying by orderId: 20
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| fromPreventedMatchId | No | query parameter: fromPreventedMatchId (number) |
get_api_v3_my_tradesInspect
Account Trade List (USER_DATA) — Get trades for a specific account and symbol.
If fromId is set, it will get id >= that fromId. Otherwise most recent orders are returned.
The time between startTime and endTime can't be longer than 24 hours. These are the supported combinations of all parameters:
symbol
symbol + orderId
symbol + startTime
symbol + endTime
symbol + fromId
symbol + startTime + endTime
symbol+ orderId + fromId
Weight(IP): 20
| Name | Required | Description | Default |
|---|---|---|---|
| orderId | No | This can only be used in combination with symbol. | |
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_open_order_listInspect
Query Open OCO (USER_DATA) — Weight(IP): 6
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_open_ordersInspect
Current Open Orders (USER_DATA) — Get all open orders on a symbol. Careful when accessing this with no symbol.
Weight(IP):
6for a single symbol;80when the symbol parameter is omitted;
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_orderInspect
Query Order (USER_DATA) — Check an order's status.
Either
orderIdororigClientOrderIdmust be sent.For some historical orders
cummulativeQuoteQtywill be < 0, meaning the data is not available at this time.
Weight(IP): 4 Returns: { symbol: string, orderId: number, orderListId: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_order_listInspect
Query OCO (USER_DATA) — Retrieves a specific OCO based on provided optional parameters
Weight(IP): 4 Returns: { orderListId: number, contingencyType: string, listStatusType: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_pingInspect
Test Connectivity — Test connectivity to the Rest API.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_api_v3_rate_limit_orderInspect
Query Current Order Count Usage (TRADE) — Displays the user's current order count usage for all intervals.
Weight(IP): 40
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_tickerInspect
Rolling window price change statistics — The window used to compute statistics is typically slightly wider than requested windowSize.
openTime for /api/v3/ticker always starts on a minute, while the closeTime is the current time of the request. As such, the effective window might be up to 1 minute wider than requested.
E.g. If the closeTime is 1641287867099 (January 04, 2022 09:17:47:099 UTC) , and the windowSize is 1d. the openTime will be: 1641201420000 (January 3, 2022, 09:17:00 UTC)
Weight(IP): 4 for each requested symbol regardless of windowSize.
The weight for this request will cap a
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Supported values: FULL or MINI. If none provided, the default is FULL | |
| undefined | No | undefined parameter: undefined (unknown) | |
| windowSize | No | Defaults to 1d if no parameter provided. Supported windowSize values: 1m,2m....59m for minutes 1h, 2h....23h - for hours 1d...7d - for days. Units cannot be combined (e.g. 1d2h is not allowed) |
get_api_v3_ticker_24hrInspect
24hr Ticker Price Change Statistics — 24 hour rolling window price change statistics. Careful when accessing this with no symbol.
If the symbol is not sent, tickers for all symbols will be returned in an array.
Weight(IP):
2for a single symbol;80when the symbol parameter is omitted;
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_ticker_book_tickerInspect
Symbol Order Book Ticker — Best price/qty on the order book for a symbol or symbols.
If the symbol is not sent, bookTickers for all symbols will be returned in an array.
Weight(IP):
2for a single symbol;4when the symbol parameter is omitted;
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_ticker_priceInspect
Symbol Price Ticker — Latest price for a symbol or symbols.
If the symbol is not sent, prices for all symbols will be returned in an array.
Weight(IP):
2for a single symbol;4when the symbol parameter is omitted;
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_ticker_trading_dayInspect
Trading Day Ticker — Price change statistics for a trading day.
Notes:
Supported values for timeZone:
Hours and minutes (e.g. -1:00, 05:45)
Only hours (e.g. 0, 8, 4)
Weight:
4for each requested symbol.The weight for this request will cap at
200once the number of symbols in the request is more than50.
| Name | Required | Description | Default |
|---|---|---|---|
| timeZone | No | Default: 0 (UTC) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_timeInspect
Check Server Time — Test connectivity to the Rest API and get the current server time.
Weight(IP): 1 Returns: { serverTime: number }.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_api_v3_tradesInspect
Recent Trades List — Get recent trades.
Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_api_v3_ui_klinesInspect
UIKlines — The request is similar to klines having the same parameters and response.
uiKlines return modified kline data, optimized for presentation of candlestick charts.
Weight(IP): 2
| Name | Required | Description | Default |
|---|---|---|---|
| interval | Yes | kline intervals | |
| timeZone | No | Default: 0 (UTC) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_account_api_restrictionsInspect
Get API Key Permission (USER_DATA) — Weight(IP): 1 Returns: { ipRestrict: boolean, createTime: number, enableInternalTransfer: boolean, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_account_api_trading_statusInspect
Account API Trading Status (USER_DATA) — Fetch account API trading status with details.
Weight(IP): 1 Returns: { data: { isLocked: boolean, plannedRecoverTime: number, triggerCondition: { GCR: number, IFER: number, UFR: number }, indicators: { BTCUSDT: { i: string, c: number, v: number, t: number }[] }, updateTime: number } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_account_infoInspect
Account info (USER_DATA) — Fetch account info detail.
Weight(IP): 1 Returns: { vipLevel: number, isMarginEnabled: boolean, isFutureEnabled: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_account_snapshotInspect
Daily Account Snapshot (USER_DATA) — - The query time period must be less than 30 days
Support query within the last one month only
If startTimeand endTime not sent, return records of the last 7 days by default
Weight(IP): 2400
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | query parameter: type ("SPOT" | "MARGIN" | "FUTURES") | |
| limit | No | query parameter: limit (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_account_statusInspect
Account Status (USER_DATA) — Fetch account status detail.
Weight(IP): 1 Returns: { data: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_algo_futures_historical_ordersInspect
Query Historical Algo Orders (USER_DATA) — - You need to enable Futures Trading Permission for the api key which requests this endpoint.
Base URL: https://api.binance.com
Weight(IP): 1 Returns: { total: number, orders: { algoId: number, symbol: string, side: string, positionSide: string, totalQty: string, executedQty: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_algo_futures_open_ordersInspect
Query Current Algo Open Orders (USER_DATA) — - You need to enable Futures Trading Permission for the api key which requests this endpoint.
Base URL: https://api.binance.com
Weight(IP): 1 Returns: { total: number, orders: { algoId: number, symbol: string, side: string, positionSide: string, totalQty: string, executedQty: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_algo_futures_sub_ordersInspect
Query Sub Orders (USER_DATA) — - You need to enable Futures Trading Permission for the api key which requests this endpoint.
Base URL: https://api.binance.com
Weight(IP): 1 Returns: { total: number, executedQty: string, executedAmt: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| algoId | Yes | query parameter: algoId (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_algo_spot_historical_ordersInspect
Query Historical Algo Orders — Get all historical SPOT TWAP orders
Weight(IP): 1 Returns: { total: number, orders: { algoId: number, symbol: string, side: string, totalQty: string, executedQty: string, executedAmt: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_algo_spot_open_ordersInspect
Query Current Algo Open Orders — Get all open SPOT TWAP orders
Weight(IP): 1 Returns: { total: number, orders: { algoId: number, symbol: string, side: string, totalQty: string, executedQty: string, executedAmt: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_algo_spot_sub_ordersInspect
Query Sub Orders — Get respective sub orders for a specified algoId
Weight(IP): 1 Returns: { total: number, executedQty: string, executedAmt: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| algoId | Yes | query parameter: algoId (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_asset_asset_detailInspect
Asset Detail (USER_DATA) — Fetch details of assets supported on Binance.
Please get network and other deposit or withdraw details from
GET /sapi/v1/capital/config/getall.
Weight(IP): 1 Returns: { CTR: { minWithdrawAmount: string, depositStatus: boolean, withdrawFee: number, withdrawStatus: boolean, depositTip: string } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_asset_asset_dividendInspect
Asset Dividend Record (USER_DATA) — Query asset Dividend Record
Weight(IP): 10 Returns: { rows: { id: number, amount: string, asset: string, divTime: number, enInfo: string, tranId: number }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | query parameter: limit (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_asset_convert_transfer_query_by_pageInspect
Query Convert Transfer (USER_DATA) — Weight(UID): 5 Returns: { total: number, rows: { tranId: number, type: number, time: number, deductedAsset: string, deductedAmount: string, targetAsset: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | If it is blank, we will match deducted asset and target asset. | |
| tranId | No | The transaction id | |
| endTime | Yes | UTC timestamp in ms | |
| startTime | Yes | UTC timestamp in ms | |
| undefined | No | undefined parameter: undefined (unknown) | |
| accountType | No | MAIN: main account. CARD: funding account. If it is blank, we will query spot and card wallet, otherwise, we just query the corresponding wallet |
get_sapi_v1_asset_custody_transfer_historyInspect
Query User Delegation History(For Master Account) (USER_DATA) — Query User Delegation History
Weight(IP): 60 Returns: { total: number, rows: { clientTranId: string, transferType: string, asset: string, amount: string, time: number }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | query parameter: type (string) | |
| Yes | query parameter: email (string) | ||
| endTime | Yes | query parameter: endTime (number) | |
| startTime | Yes | query parameter: startTime (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_asset_dribbletInspect
DustLog(USER_DATA) — Weight(IP): 1 Returns: { total: number, userAssetDribblets: { operateTime: number, totalTransferedAmount: string, totalServiceChargeAmount: string, transId: number, userAssetDribbletDetails: { transId: number, serviceChargeAmount: string, amount: string, operateTime: number, transferedAmount: string, fromAsset: string }[] }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| accountType | No | SPOT or MARGIN, default SPOT |
get_sapi_v1_asset_ledger_transfer_cloud_mining_query_by_pageInspect
Get Cloud-Mining payment and refund history (USER_DATA) — The query of Cloud-Mining payment and refund history
Weight(UID): 600 Returns: { total: number, rows: { createTime: number, tranId: number, type: number, asset: string, amount: string, status: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | If it is blank, we will query all assets | |
| tranId | No | The transaction id | |
| endTime | Yes | UTC timestamp in ms | |
| startTime | Yes | UTC timestamp in ms | |
| undefined | No | undefined parameter: undefined (unknown) | |
| clientTranId | No | The unique flag |
get_sapi_v1_asset_trade_feeInspect
Trade Fee (USER_DATA) — Fetch trade fee
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_asset_transferInspect
Query User Universal Transfer History (USER_DATA) — - fromSymbol must be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
toSymbolmust be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGINSupport query within the last 6 months only
If
startTimeandendTimenot sent, return records of the last 7 days by default
Weight(IP): 1 Returns: { total: number, rows: { asset: string, amount: string, type: string, status: string, tranId: number, timestamp: number }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_asset_wallet_balanceInspect
Query User Wallet Balance (USER_DATA) — Query User Wallet Balance
Weight(IP): 60
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_blvt_redeem_recordInspect
Redemption Record (USER_DATA) — - Only the data of the latest 90 days is available
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | query parameter: id (number) | |
| limit | No | default 1000, max 1000 | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_blvt_subscribe_recordInspect
Query Subscription Record (USER_DATA) — - Only the data of the latest 90 days is available
Weight(IP): 1 Returns: { id: number, tokenName: string, amount: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | query parameter: id (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_blvt_token_infoInspect
BLVT Info (MARKET_DATA) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_blvt_user_limitInspect
BLVT User Limit Info (USER_DATA) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_bnb_burnInspect
Get BNB Burn Status(USER_DATA) — Weight(IP): 1 Returns: { spotBNBBurn: boolean, interestBNBBurn: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_c2c_order_match_list_user_order_historyInspect
Get C2C Trade History (USER_DATA) — - If startTimestamp and endTimestamp are not sent, the recent 30-day data will be returned.
The max interval between startTimestamp and endTimestamp is 30 days.
Weight(IP): 1 Returns: { code: string, message: string, data: { orderNumber: string, advNo: string, tradeType: string, asset: string, fiat: string, fiatSymbol: string, ... }[], ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | default 100, max 100 | |
| tradeType | Yes | query parameter: tradeType ("BUY" | "SELL") | |
| undefined | No | undefined parameter: undefined (unknown) | |
| endTimestamp | No | UTC timestamp in ms | |
| startTimestamp | No | UTC timestamp in ms |
get_sapi_v1_capital_config_getallInspect
All Coins' Information (USER_DATA) — Get information of coins (available for deposit and withdraw) for user.
Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_capital_contract_convertible_coinsInspect
Query auto-converting stable coins (USER_DATA) — Get a user's auto-conversion settings in deposit/withdrawal
Weight(UID): 600' Returns: { convertEnabled: boolean, coins: string[], exchangeRates: { USDC: string, TUSD: string, USDP: string } }.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v1_capital_deposit_addressInspect
Deposit Address (supporting network) (USER_DATA) — Fetch deposit address with network.
If network is not send, return with default network of the coin.
You can get network and isDefault in networkList in the response of Get /sapi/v1/capital/config/getall (HMAC SHA256).
Weight(IP): 10 Returns: { address: string, coin: string, tag: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_capital_deposit_address_listInspect
Fetch deposit address list with network (USER_DATA) — Fetch deposit address list with network.
Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| coin | Yes | query parameter: coin (string) | |
| network | No | query parameter: network (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_capital_deposit_hisrecInspect
Deposit History(supporting network) (USER_DATA) — Fetch deposit history.
Please notice the default
startTimeandendTimeto make sure that time interval is within 0-90 days.If both
startTimeandendTimeare sent, time betweenstartTimeandendTimemust be less than 90 days.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | * `0` - pending * `6` - credited but cannot withdraw * `1` - success | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_capital_deposit_sub_addressInspect
Sub-account Spot Assets Summary (For Master Account) — Fetch sub-account deposit address
Weight(IP): 1 Returns: { address: string, coin: string, tag: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_capital_deposit_sub_hisrecInspect
Sub-account Deposit History (For Master Account) — Fetch sub-account deposit history
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | query parameter: limit (number) | |
| status | No | 0(0:pending,6: credited but cannot withdraw, 1:success) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_capital_withdraw_address_listInspect
Fetch withdraw address list (USER_DATA) — Fetch withdraw address list
Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v1_capital_withdraw_historyInspect
Withdraw History (supporting network) (USER_DATA) — Fetch withdraw history.
This endpoint specifically uses per second UID rate limit, user's total second level IP rate limit is 180000/second. Response from the endpoint contains header key X-SAPI-USED-UID-WEIGHT-1S, which defines weight used by the current IP.
networkmay not be in the response for old withdraw.Please notice the default
startTimeandendTimeto make sure that time interval is within 0-90 days.If both
startTimeandendTimeare sent, time betweenstartTimeandendTimemust be less than 90 daysIf withdr
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | * `0` - Email Sent * `1` - Cancelled * `2` - Awaiting Approval * `3` - Rejected * `4` - Processing * `5` - Failure * `6` - Completed | |
| undefined | No | undefined parameter: undefined (unknown) | |
| withdrawOrderId | No | query parameter: withdrawOrderId (string) |
get_sapi_v1_convert_asset_infoInspect
Query order quantity precision per asset (USER_DATA) — Query for supported asset precision information
Weight(IP): 100
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_convert_exchange_infoInspect
List All Convert Pairs — Query for all convertible token pairs and the tokens’ respective upper/lower limits
Weight(IP): 3000
| Name | Required | Description | Default |
|---|---|---|---|
| toAsset | No | User receives coin | |
| fromAsset | No | User spends coin |
get_sapi_v1_convert_limit_query_open_ordersInspect
Query limit open orders (USER_DATA) — Enable users to query for all existing limit orders
Weight(UID): 3000 Returns: { list: { quoteId: string, orderId: number, orderStatus: string, fromAsset: string, fromAmount: string, toAsset: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_convert_order_statusInspect
Order status (USER_DATA) — Query order status by order ID.
Weight(UID): 100 Returns: { orderId: number, orderStatus: string, fromAsset: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| orderId | No | query parameter: orderId (string) | |
| quoteId | No | query parameter: quoteId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_convert_trade_flowInspect
Get Convert Trade History (USER_DATA) — - The max interval between startTime and endTime is 30 days.
Weight(UID): 3000 Returns: { list: { quoteId: string, orderId: number, orderStatus: string, fromAsset: string, fromAmount: string, toAsset: string, ... }[], startTime: number, endTime: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | default 100, max 1000 | |
| endTime | Yes | UTC timestamp in ms | |
| startTime | Yes | UTC timestamp in ms | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_copy_trading_futures_lead_symbolInspect
Get Futures Lead Trading Symbol Whitelist(USER_DATA) — Get Futures Lead Trading Symbol Whitelist
Weight(IP): 20 Returns: { code: string, message: string, data: { symbol: string, baseAsset: string, quoteAsset: string } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_copy_trading_futures_user_statusInspect
Get Futures Lead Trader Status(TRADE) — Get Futures Lead Trader Status
Weight(UID): 20 Returns: { code: string, message: string, data: { isLeadTrader: boolean, time: number }, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_dci_product_accountsInspect
Check Dual Investment accounts(USER_DATA) — Check Dual Investment accounts
Weight(IP): 1 Returns: { totalAmountInBTC: string, totalAmountInUSDT: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_dci_product_listInspect
Get Dual Investment product list(USER_DATA) — Get Dual Investment product list
Weight(IP): 1 Returns: { total: number, list: { id: string, investCoin: string, exercisedCoin: string, strikePrice: string, duration: number, settleDate: number, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| investCoin | Yes | Asset used for subscribing, e.g.: if you subscribe to a high sell product (call option), you should input: - optionType: CALL, - exercisedCoin: USDT, - investCoin: BNB; if you subscribe to a low buy product (put option), you should input: - optionType: PUT, - exercisedCoin: BNB, - investCoin: USDT; | |
| optionType | Yes | Input CALL or PUT | |
| exercisedCoin | Yes | Target exercised asset, e.g.: if you subscribe to a high sell product (call option), you should input: - optionType: CALL, - exercisedCoin: USDT, - investCoin: BNB; if you subscribe to a low buy product (put option), you should input: - optionType: PUT, - exercisedCoin: BNB, - investCoin: USDT; |
get_sapi_v1_dci_product_positionsInspect
Get Dual Investment positions(USER_DATA) — Get Dual Investment positions (batch)
Weight(IP): 1 Returns: { total: number, list: { id: string, investCoin: string, exercisedCoin: string, subscriptionAmount: string, strikePrice: string, duration: number, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | - PENDING: Products are purchasing, will give results later; - PURCHASE_SUCCESS: purchase successfully; - SETTLED: Products are finish settling; - PURCHASE_FAIL: fail to purchase; - REFUNDING: refund ongoing; - REFUND_SUCCESS: refund to spot account successfully; - SETTLING: Products are settling. If don't fill this field, will response all the position status. | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_eth_staking_eth_history_rate_historyInspect
Get WBETH Rate History (USER_DATA) — - The time between startTime and endTime cannot be longer than 3 months.
If startTime and endTime are both not sent, then the last 30 days' data will be returned.
If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned.
If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.
Weight(IP): 150 Returns: { rows: { annualPercentageRate: string, exchangeRate: string, time: number }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_eth_staking_eth_history_redemption_historyInspect
Get ETH redemption history (USER_DATA) — - The time between startTime and endTime cannot be longer than 3 months.
If startTime and endTime are both not sent, then the last 30 days' data will be returned.
If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned.
If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.
Weight(IP): 150 Returns: { rows: { time: number, arrivalTime: number, asset: string, amount: string, status: string, distributeAsset: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_eth_staking_eth_history_rewards_historyInspect
Get BETH rewards distribution history(USER_DATA) — - The time between startTime and endTime cannot be longer than 3 months.
If startTime and endTime are both not sent, then the last 30 days' data will be returned.
If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned.
If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.
Weight(IP): 150 Returns: { rows: { time: number, asset: string, holding: string, amount: string, annualPercentageRate: string, status: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_eth_staking_eth_history_staking_historyInspect
Get ETH staking history (USER_DATA) — - The time between startTime and endTime cannot be longer than 3 months.
If startTime and endTime are both not sent, then the last 30 days' data will be returned.
If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned.
If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.
Weight(IP): 150 Returns: { rows: { time: number, asset: string, amount: string, status: string, distributeAmount: string, conversionRatio: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_eth_staking_eth_history_wbeth_rewards_historyInspect
Get WBETH rewards history(USER_DATA) — - The time between startTime and endTime cannot be longer than 3 months.
If startTime and endTime are both not sent, then the last 30 days' data will be returned.
If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned.
If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.
Weight(IP): 150 Returns: { estRewardsInETH: string, rows: { time: number, amountInETH: string, holding: string, holdingInETH: string, annualPercentageRate: string }[], total: number
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_eth_staking_eth_quotaInspect
Get current ETH staking quota (USER_DATA) — Weight(IP): 150 Returns: { leftStakingPersonalQuota: string, leftRedemptionPersonalQuota: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_eth_staking_wbeth_history_unwrap_historyInspect
Get WBETH unwrap history (USER_DATA) — - The time between startTime and endTime cannot be longer than 3 months.
If startTime and endTime are both not sent, then the last 30 days' data will be returned.
If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned.
If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.
Weight(IP): 150 Returns: { rows: { time: number, fromAsset: string, fromAmount: string, toAsset: string, toAmount: string, exchangeRate: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_eth_staking_wbeth_history_wrap_historyInspect
Get WBETH wrap history (USER_DATA) — - The time between startTime and endTime cannot be longer than 3 months.
If startTime and endTime are both not sent, then the last 30 days' data will be returned.
If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned.
If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.
Weight(IP): 150 Returns: { rows: { time: number, fromAsset: string, fromAmount: string, toAsset: string, toAmount: string, exchangeRate: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_fiat_ordersInspect
Fiat Deposit/Withdraw History (USER_DATA) — - If beginTime and endTime are not sent, the recent 30-day data will be returned.
Weight(UID): 90000 Returns: { code: string, message: string, data: { orderNo: string, fiatCurrency: string, indicatedAmount: string, amount: string, totalFee: string, method: string, ... }[], ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_fiat_paymentsInspect
Fiat Payments History (USER_DATA) — - If beginTime and endTime are not sent, the recent 30-day data will be returned.
Weight(IP): 1 Returns: { code: string, message: string, data: { orderNo: string, sourceAmount: string, fiatCurrency: string, obtainAmount: string, cryptoCurrency: string, totalFee: string, ... }[], ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_futures_hist_data_linkInspect
Get Future TickLevel Orderbook Historical Data Download Link (USER_DATA) — Weight(IP): 1 Returns: { data: { day: string, url: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | query parameter: symbol (string) | |
| dataType | Yes | query parameter: dataType ("T_DEPTH" | "S_DEPTH") | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_futures_transferInspect
Get Future Account Transaction History List (USER_DATA) — Weight(IP): 10 Returns: { rows: { asset: string, tranId: number, amount: string, type: string, timestamp: number, status: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_giftcard_buy_code_token_limitInspect
Fetch Token Limit (USER_DATA) — This API is to help you verify which tokens are available for you to purchase fixed-value gift cards as mentioned in section 2 and it's limitation.
Weight(IP): 1 Returns: { code: string, message: string, data: { coin: string, fromMin: string, fromMax: string }, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| baseToken | Yes | The token you want to pay, example BUSD | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_giftcard_cryptography_rsa_public_keyInspect
Fetch RSA Public Key (USER_DATA) — This API is for fetching the RSA Public Key. This RSA Public key will be used to encrypt the card code. Please note that the RSA Public key fetched is valid only for the current day.
Weight(IP): 1 Returns: { code: string, message: string, data: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_giftcard_verifyInspect
Verify a Binance Code (USER_DATA) — This API is for verifying whether the Binance Code is valid or not by entering Binance Code or reference number.
Please note that if you enter the wrong binance code 5 times within an hour, you will no longer be able to verify any binance code for that hour.
Weight(IP): 1 Returns: { code: string, message: string, data: { valid: boolean, token: string, amount: string }, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| referenceNo | Yes | reference number |
get_sapi_v1_lending_auto_invest_all_assetInspect
Query all source asset and target asset (USER_DATA) — Query all source assets and target assets
Weight(IP): 1 Returns: { targetAssets: string[], sourceAssets: string[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_lending_auto_invest_history_listInspect
Query subscription transaction history — Query subscription transaction history of a plan
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| planId | No | query parameter: planId (number) | |
| planType | No | query parameter: planType ("SINGLE" | "PORTFOLIO" | "INDEX" | "ALL") | |
| undefined | No | undefined parameter: undefined (unknown) | |
| targetAsset | No | query parameter: targetAsset (number) |
get_sapi_v1_lending_auto_invest_index_infoInspect
Query Index Details(USER_DATA) — Query index details
Weight(IP): 1 Returns: { indexId: number, indexName: string, status: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| indexId | Yes | query parameter: indexId (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_lending_auto_invest_index_user_summaryInspect
Query Index Linked Plan Position Details(USER_DATA) — Details on users Index-Linked plan position details
Weight(IP): 1 Returns: { indexId: number, totalInvestedInUSD: string, currentInvestedInUSD: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| indexId | Yes | query parameter: indexId (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_lending_auto_invest_one_off_statusInspect
Query One-Time Transaction Status (USER_DATA) — Transaction status for one-time transaction
Weight(IP): 1 Returns: { transactionId: number, status: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| requestId | No | query parameter: requestId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| transactionId | Yes | query parameter: transactionId (number) |
get_sapi_v1_lending_auto_invest_plan_idInspect
Query holding details of the plan — Query holding details of the plan
Weight(IP): 1 Returns: { planValueInUSD: string, planValueInBTC: string, pnlInUSD: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | No | query parameter: planId (number) | |
| requestId | No | query parameter: requestId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_lending_auto_invest_plan_listInspect
Get list of plans — Query plan lists
Weight(IP): 1 Returns: { planValueInUSD: string, planValueInBTC: string, pnlInUSD: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| planType | Yes | query parameter: planType (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_lending_auto_invest_rebalance_historyInspect
Index Linked Plan Rebalance Details (USER_DATA) — Get the history of Index Linked Plan Redemption transactions
Max 30 day difference between startTime and endTime If no startTime and endTime, default to show past 30 day records
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_lending_auto_invest_redeem_historyInspect
Index Linked Plan Redemption History (USER_DATA) — Get the history of Index Linked Plan Redemption transactions
Max 30 day difference between startTime and endTime If no startTime and endTime, default to show past 30 day records
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| requestId | Yes | query parameter: requestId (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_lending_auto_invest_source_asset_listInspect
Query source asset list (USER_DATA) — Query Source Asset to be used for investment
Weight(IP): 1 Returns: { feeRate: string, sourceAssets: { sourceAsset: string, assetMinAmount: string, assetMaxAmount: string, scale: string, flexibleAmount: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| indexId | No | query parameter: indexId (number) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| usageType | Yes | query parameter: usageType (string) | |
| targetAsset | No | query parameter: targetAsset (string) | |
| flexibleAllowedToUse | No | query parameter: flexibleAllowedToUse (boolean) |
get_sapi_v1_lending_auto_invest_target_asset_listInspect
Get target asset list (USER_DATA) — Weight(IP): 1 Returns: { targetAssets: string, autoInvestAssetList: { targetAsset: string, roiAndDimensionTypeList: { simulateRoi: string, dimensionValue: string, dimensionUnit: string }[] }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| targetAsset | No | query parameter: targetAsset (string) |
get_sapi_v1_lending_auto_invest_target_asset_roi_listInspect
Get target asset ROI data (USER_DATA) — ROI return list for target asset
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| hisRoiType | Yes | query parameter: hisRoiType (string) |
get_sapi_v1_lending_project_listInspect
Get Fixed/Activity Project List(USER_DATA) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_lending_project_position_listInspect
Get Fixed/Activity Project Position (USER_DATA) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_borrow_historyInspect
Get Crypto Loans Borrow History (USER_DATA) — - If startTime and endTime are not sent, the recent 90-day data will be returned.
The max interval between startTime and endTime is 180 days.
Weight(IP): 400 Returns: { rows: { orderId: number, loanCoin: string, initialLoanAmount: string, hourlyInterestRate: string, loanTerm: string, collateralCoin: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | default 10, max 100 | |
| orderId | No | orderId in POST /sapi/v1/loan/borrow | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_collateral_dataInspect
Get Collateral Assets Data (USER_DATA) — Get LTV information and collateral limit of collateral assets. The collateral limit is shown in USD value.
Weight(IP): 400 Returns: { rows: { collateralCoin: string, initialLTV: string, marginCallLTV: string, liquidationLTV: string, maxLimit: string, vipLevel: number }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_incomeInspect
Get Crypto Loans Income History (USER_DATA) — - If startTime and endTime are not sent, the recent 7-day data will be returned.
The max interval between startTime and endTime is 30 days.
Weight(UID): 6000
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | All types will be returned by default. * `borrowIn` * `collateralSpent` * `repayAmount` * `collateralReturn` - Collateral return after repayment * `addCollateral` * `removeCollateral` * `collateralReturnAfterLiquidation` | |
| limit | No | default 20, max 100 | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_loanable_dataInspect
Get Loanable Assets Data (USER_DATA) — Get interest rate and borrow limit of loanable assets. The borrow limit is shown in USD value.
Weight(IP): 400 Returns: { rows: { loanCoin: string, _7dHourlyInterestRate: string, _7dDailyInterestRate: string, _14dHourlyInterestRate: string, _14dDailyInterestRate: string, _30dHourlyInterestRate: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_ltv_adjustment_historyInspect
Get Loan LTV Adjustment History (USER_DATA) — If startTime and endTime are not sent, the recent 90-day data will be returned. The max interval between startTime and endTime is 180 days.
Weight(IP): 400 Returns: { rows: { loanCoin: string, collateralCoin: string, direction: string, amount: string, preLTV: string, afterLTV: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | default 10, max 100 | |
| orderId | No | Order ID | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_ongoing_ordersInspect
Get Loan Ongoing Orders (USER_DATA) — Weight(IP): 300 Returns: { rows: { orderId: number, loanCoin: string, totalDebt: string, residualInterest: string, collateralCoin: string, collateralAmount: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | default 10, max 100 | |
| current | No | Current querying page. Start from 1; default:1, max:1000 | |
| orderId | No | orderId in POST /sapi/v1/loan/borrow | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_repay_collateral_rateInspect
Check Collateral Repay Rate (USER_DATA) — Get the the rate of collateral coin / loan coin when using collateral repay, the rate will be valid within 8 second.
Weight(IP): 6000 Returns: { loanCoin: string, collateralCoin: string, repayAmount: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| repayAmount | Yes | repay amount of loanCoin |
get_sapi_v1_loan_repay_historyInspect
Get Loan Repayment History (USER_DATA) — If startTime and endTime are not sent, the recent 90-day data will be returned. The max interval between startTime and endTime is 180 days.
Weight(IP): 400 Returns: { rows: { loanCoin: string, repayAmount: string, collateralCoin: string, collateralUsed: string, collateralReturn: string, repayType: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | default 10, max 100 | |
| orderId | No | Order ID | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_vip_collateral_accountInspect
Check Locked Value of VIP Collateral Account (USER_DATA) — VIP loan is available for VIP users only.
Weight(IP): 6000 Returns: { rows: { collateralAccountId: string, collateralCoin: string, collateralValue: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| collateralAccountId | No | query parameter: collateralAccountId (number) |
get_sapi_v1_loan_vip_collateral_dataInspect
Get Collateral Asset Data (USER_DATA) — Get collateral asset data.
Weight(IP): 400 Returns: { rows: { collateralCoin: string, _1stCollateralRatio: string, _1stCollateralRange: string, _2ndCollateralRatio: string, _2ndCollateralRange: string, _3rdCollateralRatio: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_vip_loanable_dataInspect
Get Loanable Assets Data — Get interest rate and borrow limit of loanable assets. The borrow limit is shown in USD value.
Weight(IP): 400 Returns: { total: number, rows: { loanCoin: string, _flexibleDailyInterestRate: string, _flexibleYearlyInterestRate: string, _30dDailyInterestRate: string, _30dYearlyInterestRate: string, _60dDailyInterestRate: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_vip_ongoing_ordersInspect
Get VIP Loan Ongoing Orders (USER_DATA) — VIP loan is available for VIP users only.
Weight(IP): 400 Returns: { rows: { orderId: number, loanCoin: string, totalDebt: string, residualInterest: string, collateralAccountId: string, collateralCoin: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default 10; max 100. | |
| undefined | No | undefined parameter: undefined (unknown) | |
| collateralAccountId | No | query parameter: collateralAccountId (number) |
get_sapi_v1_loan_vip_repay_historyInspect
Get VIP Loan Repayment History (USER_DATA) — VIP loan is available for VIP users only.
Weight(IP): 400 Returns: { rows: { loanCoin: string, repayAmount: string, collateralCoin: string, repayStatus: string, repayTime: string, orderId: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default 10; max 100. | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_vip_request_dataInspect
Query Application Status (USER_DATA) — Get Application Status
Weight(UID): 400 Returns: { total: number, rows: { loanAccountId: string, orderId: string, requestId: string, loanCoin: string, loanAmount: string, collateralAccountId: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_loan_vip_request_interest_rateInspect
Get Borrow Interest Rate (USER_DATA) — Get borrow interest rate.
Weight(UID): 400
| Name | Required | Description | Default |
|---|---|---|---|
| loanCoin | No | Max 10 assets, Multiple split by "," | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_managed_subaccount_account_snapshotInspect
Managed sub-account snapshot (For Investor Master Account) — - The query time period must be less then 30 days
Support query within the last one month only
If
startTimeandendTimenot sent, return records of the last 7 days by default
Weight(IP): 2400 Returns: { code: number, msg: string, snapshotVos: { data: { balances: { asset: unknown, free: unknown, locked: unknown }[], totalAssetOfBtc: string }, type: string, updateTime: number }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | "SPOT", "MARGIN"(cross), "FUTURES"(UM) | |
| limit | No | min 7, max 30, default 7 | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_managed_subaccount_assetInspect
Managed sub-account asset details(For Investor Master Account) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_managed_subaccount_deposit_addressInspect
Get Managed Sub-account Deposit Address (For Investor Master Account) — Get investor's managed sub-account deposit address
Weight(UID): 1 Returns: { coin: string, address: string, tag: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_managed_subaccount_fetch_future_assetInspect
Query Managed Sub-account Futures Asset Details (For Investor Master Account) — Investor can use this api to query managed sub account futures asset details Returns: { code: number, message: string, snapshotVos: { type: string, updateTime: number, data: { assets: { asset: unknown, marginBalance: unknown, walletBalance: unknown }[], position: { symbol: unknown, entryPrice: unknown, markPrice: unknown, positionAmt: unknown }[] } }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_managed_subaccount_infoInspect
Query Managed Sub-account List (For Investor) — Get investor's managed sub-account list.
Weight(UID): 60 Returns: { total: number, managerSubUserInfoVoList: { rootUserId: number, managersubUserId: number, bindParentUserId: number, email: string, insertTimeStamp: number, bindParentEmail: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_managed_subaccount_margin_assetInspect
Query Managed Sub-account Margin Asset Details (For Investor Master Account) — Investor can use this api to query managed sub account margin asset details Returns: { marginLevel: string, totalAssetOfBtc: string, totalLiabilityOfBtc: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_managed_subaccount_query_trans_logInspect
Query Managed Sub Account Transfer Log (For Trading Team Sub Account)(USER_DATA) — Query Managed Sub Account Transfer Log (For Trading Team Sub Account)
Weight(UID): 60 Returns: { count: number, managerSubTransferHistoryVos: { fromEmail: string, fromAccountType: string, toEmail: string, toAccountType: string, asset: string, amount: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| transfers | Yes | Transfer Direction | |
| undefined | No | undefined parameter: undefined (unknown) | |
| transferFunctionAccountType | Yes | Transfer function account type |
get_sapi_v1_managed_subaccount_query_trans_log_for_investorInspect
Query Managed Sub Account Transfer Log (For Investor Master Account) — 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.
Weight(IP): 1 Returns: { count: number, managerSubTransferHistoryVos: { fromEmail: string, fromAccountType: string, toEmail: string, toAccountType: string, asset: string, amount: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| transfers | No | Transfer Direction (FROM/TO) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| transferFunctionAccountType | No | Transfer function account type (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE) |
get_sapi_v1_managed_subaccount_query_trans_log_for_trade_parentInspect
Query Managed Sub Account Transfer Log (For Trading Team Master Account) — Trading team can use this api to query managed sub account transfer log. This endpoint is available for trading team 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
Weight(IP): 60 Returns: { count: number, managerSubTransferHistoryVos: { fromEmail: string, fromAccountType: string, toEmail: string, toAccountType: string, asset: string, amount: string, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| transfers | No | Transfer Direction (FROM/TO) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| transferFunctionAccountType | No | Transfer function account type (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE) |
get_sapi_v1_margin_accountInspect
Query Cross Margin Account Details (USER_DATA) — Weight(IP): 10 Returns: { created: boolean, borrowEnabled: boolean, marginLevel: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_all_assetsInspect
Get All Margin Assets (MARKET_DATA) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_all_order_listInspect
Query Margin Account's all OCO (USER_DATA) — Retrieves all OCO for a specific margin account based on provided optional parameters
Weight(IP): 200
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default Value: 500; Max Value: 1000 | |
| fromId | No | If supplied, neither `startTime` or `endTime` can be provided | |
| symbol | No | Mandatory for isolated margin, not supported for cross margin | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_all_ordersInspect
Query Margin Account's All Orders (USER_DATA) — - If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned.
For some historical orders
cummulativeQuoteQtywill be < 0, meaning the data is not available at this time.
Weight(IP): 200
Request Limit: 60 times/min per IP
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_all_pairsInspect
Get All Cross Margin Pairs (MARKET_DATA) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_available_inventoryInspect
Query Margin Available Inventory (USER_DATA) — Margin available Inventory query
Weight(UID): 50 Returns: { assets: { MATIC: string, STPT: string, TVK: string, SHIB: string }, updateTime: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | query parameter: type ("MARGIN" | "ISOLATED") | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_borrow_repayInspect
Query borrow/repay records in Margin account(USER_DATA) — Query borrow/repay records in Margin account
txId or startTime must be sent. txId takes precedence. Response in descending order
If an asset is sent, data within 30 days before endTime; If an asset is not sent, data within 7 days before endTime
If neither startTime nor endTime is sent, the recent 7-day data will be returned.
startTime set as endTime - 7 days by default, endTime set as current time by default
Weight(IP): 10 Returns: { rows: { isolatedSymbol: string, amount: string, asset: string, interest: string, principal: st
| Name | Required | Description | Default |
|---|---|---|---|
| txId | No | tranId in POST /sapi/v1/margin/loan | |
| type | Yes | BORROW or REPAY | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_capital_flowInspect
Get cross or isolated margin capital flow(USER_DATA) — Get cross or isolated margin capital flow
Weight(IP): 100
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | query parameter: type ("TRANSFER" | "BORROW" | "REPAY" | "BUY_INCOME" | "BUY_EXPENSE" | "SELL_INCOME" | "SELL_EXPENSE" | "TRADING_COMMISSION" | "BUY_LIQUIDATION" | "SELL_LIQUIDATION" | "REPAY_LIQUIDATION" | "OTHER_LIQUIDATION" | "LIQUIDATION_FEE" | "SMALL_BALANCE_CONVERT" | "COMMISSION_RETURN" | "SMALL_CONVERT") | |
| limit | No | The number of data items returned each time is limited. Default 500; Max 1000. | |
| fromId | No | If fromId is set, the data with id > fromId will be returned. Otherwise the latest data will be returned | |
| symbol | No | Required when querying isolated data | |
| startTime | No | Only supports querying the data of the last 90 days | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_cross_margin_collateral_ratioInspect
Cross margin collateral ratio (MARKET_DATA) — Weight(IP): 100
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v1_margin_cross_margin_dataInspect
Query Cross Margin Fee Data (USER_DATA) — Get cross margin fee data collection with any vip level or user's current specific data as https://www.binance.com/en/margin-fee
Weight(IP): 1 when coin is specified; 5 when the coin parameter is omitted
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_delist_scheduleInspect
Get tokens or symbols delist schedule for cross margin and isolated margin (MARKET_DATA) — Get tokens or symbols delist schedule for cross margin and isolated margin
Weight(IP): 100
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_exchange_small_liabilityInspect
Get Small Liability Exchange Coin List (USER_DATA) — Query the coins which can be small liability exchange
Weight(UID): 100
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_exchange_small_liability_historyInspect
Get Small Liability Exchange History (USER_DATA) — Get Small liability Exchange History
Weight(UID): 100 Returns: { total: number, rows: { asset: string, amount: string, targetAsset: string, targetAmount: string, bizType: string, timestamp: number }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_force_liquidation_recInspect
Get Force Liquidation Record (USER_DATA) — - Response in descending order
Weight(IP): 1 Returns: { rows: { avgPrice: string, executedQty: string, orderId: number, price: string, qty: string, side: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_interest_historyInspect
Get Interest History (USER_DATA) — - Response in descending order
If
isolatedSymbolis not sent, crossed margin data will be returnedSet
archivedtotrueto query data from 6 months agotypein response has 4 enums:PERIODICinterest charged per hourON_BORROWfirst interest charged on borrowPERIODIC_CONVERTEDinterest charged per hour converted into BNBON_BORROW_CONVERTEDfirst interest charged on borrow converted into BNB
Weight(IP): 1 Returns: { rows: { isolatedSymbol: string, asset: string, interest: string, interestAccuredTime: number, interestRat
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_interest_rate_historyInspect
Margin Interest Rate History (USER_DATA) — The max interval between startTime and endTime is 30 days.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_isolated_accountInspect
Query Isolated Margin Account Info (USER_DATA) — - If "symbols" is not sent, all isolated assets will be returned.
If "symbols" is sent, only the isolated assets of the sent symbols will be returned.
Weight(IP): 10 Returns: { assets: { baseAsset: { asset: string, borrowEnabled: boolean, borrowed: string, free: string, interest: string, locked: string, ... }, quoteAsset: { asset: string, borrowEnabled: boolean, borrowed: string, free: string, interest: string, locked: string, ... }, symbol: string, isolatedCreated: boolean, enabled: boolean, marginLevel: string, ... }[], totalAssetOfBtc: str
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_isolated_account_limitInspect
Query Enabled Isolated Margin Account Limit (USER_DATA) — Query enabled isolated margin account limit.
Weight(IP): 1 Returns: { enabledAccount: number, maxAccount: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_isolated_all_pairsInspect
Get All Isolated Margin Symbol(USER_DATA) — Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_isolated_margin_dataInspect
Query Isolated Margin Fee Data (USER_DATA) — Get isolated margin fee data collection with any vip level or user's current specific data as https://www.binance.com/en/margin-fee
Weight(IP): 1 when a single is specified; 10 when the symbol parameter is omitted
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_isolated_margin_tierInspect
Query Isolated Margin Tier Data (USER_DATA) — Get isolated margin tier data collection with any tier as https://www.binance.com/en/margin-data
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| tier | No | All margin tier data will be returned if tier is omitted | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_leverage_bracketInspect
Query Liability Coin Leverage Bracket in Cross Margin Pro Mode (MARKET_DATA) — Liability Coin Leverage Bracket in Cross Margin Pro Mode
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v1_margin_max_borrowableInspect
Query Max Borrow (USER_DATA) — - If isolatedSymbol is not sent, crossed margin data will be sent.
borrowLimitis also available from https://www.binance.com/en/margin-fee
Weight(IP): 50 Returns: { amount: string, borrowLimit: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_max_transferableInspect
Query Max Transfer-Out Amount (USER_DATA) — - If isolatedSymbol is not sent, crossed margin data will be sent.
Weight(IP): 50 Returns: { amount: string, borrowLimit: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_my_tradesInspect
Query Margin Account's Trade List (USER_DATA) — - If fromId is set, it will get orders >= that fromId. Otherwise most recent trades are returned.
Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_next_hourly_interest_rateInspect
Get a future hourly interest rate (USER_DATA) — Get user the next hourly estimate interest
Weight(UID): 100
| Name | Required | Description | Default |
|---|---|---|---|
| assets | No | List of assets, separated by commas, up to 20 | |
| undefined | No | undefined parameter: undefined (unknown) | |
| isIsolated | No | for isolated margin or not, "TRUE", "FALSE" |
get_sapi_v1_margin_open_order_listInspect
Query Margin Account's Open OCO (USER_DATA) — Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | No | Mandatory for isolated margin, not supported for cross margin | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_open_ordersInspect
Query Margin Account's Open Orders (USER_DATA) — - If the symbol is not sent, orders for all symbols will be returned in an array.
When all symbols are returned, the number of requests counted against the rate limiter is equal to the number of symbols currently trading on the exchange
If isIsolated ="TRUE", symbol must be sent.
Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_orderInspect
Query Margin Account's Order (USER_DATA) — - Either orderId or origClientOrderId must be sent.
For some historical orders
cummulativeQuoteQtywill be < 0, meaning the data is not available at this time.
Weight(IP): 10 Returns: { clientOrderId: string, cummulativeQuoteQty: string, executedQty: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_order_listInspect
Query Margin Account's OCO (USER_DATA) — Retrieves a specific OCO based on provided optional parameters
Either
orderListIdororigClientOrderIdmust be provided
Weight(IP): 10 Returns: { orderListId: number, contingencyType: string, listStatusType: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | No | Mandatory for isolated margin, not supported for cross margin | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_price_indexInspect
Query Margin PriceIndex (MARKET_DATA) — Weight(IP): 10 Returns: { calcTime: number, price: string, symbol: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_rate_limit_orderInspect
Query Current Margin Order Count Usage (TRADE) — Displays the user's current margin order count usage for all intervals.
Weight(IP): 20
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | No | isolated symbol, mandatory for isolated margin | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_trade_coeffInspect
Get Summary of Margin account (USER_DATA) — Get personal margin level information
Weight(IP): 10 Returns: { normalBar: string, marginCallBar: string, forceLiquidationBar: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | Email Address | ||
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_margin_transferInspect
Get Cross Margin Transfer History (USER_DATA) — - Response in descending order
Returns data for last 7 days by default
Set
archivedtotrueto query data from 6 months ago
Weight(IP): 1 Returns: { rows: { amount: string, asset: string, status: string, timestamp: number, txId: number, type: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_hash_transfer_config_details_listInspect
Hashrate Resale List (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { configDetails: { configId: number, poolUsername: string, toPoolUsername: string, algoName: string, hashRate: number, startDay: number, ... }[], totalNum: number, pageSize: number } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_hash_transfer_profit_detailsInspect
Hashrate Resale Details (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { profitTransferDetails: { poolUsername: string, toPoolUsername: string, algoName: string, hashRate: number, day: number, amount: number, ... }[], totalNum: number, pageSize: number } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_payment_listInspect
Earnings List (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { accountProfits: { time: number, type: number, hashTransfer: number, transferAmount: number, dayHashRate: number, profitAmount: number, ... }[], totalNum: number, pageSize: number } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_payment_otherInspect
Extra Bonus List (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { otherProfits: { time: number, coinName: string, type: number, profitAmount: number, status: number }[], totalNum: number, pageSize: number } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_payment_uidInspect
Mining Account Earning (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { accountProfits: { time: number, coinName: string, type: number, puid: number, subName: string, amount: number }[], totalNum: number, pageSize: number } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_pub_algo_listInspect
Acquiring Algorithm (MARKET_DATA) — Weight(IP): 1 Returns: { code: number, msg: string, data: { algoName: string, algoId: number, poolIndex: number, unit: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v1_mining_pub_coin_listInspect
Acquiring CoinName (MARKET_DATA) — Weight(IP): 1 Returns: { code: number, msg: string, data: { coinName: string, coinId: number, poolIndex: number, algoId: number, algoName: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v1_mining_statistics_user_listInspect
Account List (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { type: string, userName: string, list: { time: number, hashrate: string, reject: string }[] }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_statistics_user_statusInspect
Statistic List (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { fifteenMinHashRate: string, dayHashRate: string, validNum: number, invalidNum: number, profitToday: { BTC: string, BSV: string, BCH: string }, profitYesterday: { BTC: string, BSV: string, BCH: string }, ... } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_worker_detailInspect
Request for Detail Miner List (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { workerName: string, type: string, hashrateDatas: { time: number, hashrate: string, reject: number }[] }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_mining_worker_listInspect
Request for Miner List (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: { workerDatas: { workerId: string, workerName: string, status: number, hashRate: number, dayHashRate: number, rejectRate: number, ... }[], totalNum: number, pageSize: number } }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_nft_history_depositInspect
Get NFT Deposit History(USER_DATA) — - The max interval between startTime and endTime is 90 days.
If startTime and endTime are not sent, the recent 7 days' data will be returned.
Weight(UID): 3000 Returns: { total: number, list: { network: string, txID: number, contractAdrress: string, tokenId: string, timestamp: number }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_nft_history_transactionsInspect
Get NFT Transaction History (USER_DATA) — - The max interval between startTime and endTime is 90 days.
If startTime and endTime are not sent, the recent 7 days' data will be returned.
Weight(UID): 3000 Returns: { total: number, list: { orderNo: string, tokens: { network: string, tokenId: string, contractAddress: string }[], tradeTime: number, tradeAmount: string, tradeCurrency: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| orderType | Yes | 0: purchase order, 1: sell order, 2: royalty income, 3: primary market order, 4: mint fee | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_nft_history_withdrawInspect
Get NFT Withdraw History (USER_DATA) — - The max interval between startTime and endTime is 90 days.
If startTime and endTime are not sent, the recent 7 days' data will be returned.
Weight(UID): 3000 Returns: { total: number, list: { network: string, txID: string, contractAdrress: string, tokenId: string, timestamp: number, fee: number, ... }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_nft_user_get_assetInspect
Get NFT Asset (USER_DATA) — Weight(UID): 3000 Returns: { total: number, list: { network: string, contractAddress: string, tokenId: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_pay_transactionsInspect
Get Pay Trade History (USER_DATA) — - If startTime and endTime are not sent, the recent 90 days' data will be returned.
The max interval between startTime and endTime is 90 days.
Support for querying orders within the last 18 months.
Weight(UID): 3000 Returns: { code: string, message: string, data: { orderType: string, transactionId: string, transactionTime: number, amount: string, currency: string, walletType: number, ... }[], ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | default 100, max 100 | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_portfolio_accountInspect
Portfolio Margin Account (USER_DATA) — Get the account info
'Weight(IP): 1' Returns: { uniMMR: string, accountEquity: string, actualEquity: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_portfolio_asset_index_priceInspect
Query Portfolio Margin Asset Index Price (MARKET_DATA) — Query Portfolio Margin Asset Index Price
Weight(IP):
1 if send asset
50 if not send asset
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) |
get_sapi_v1_portfolio_collateral_rateInspect
Portfolio Margin Collateral Rate (MARKET_DATA) — Portfolio Margin Collateral Rate.
Weight(IP): 50
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v1_portfolio_interest_historyInspect
Query Classic Portfolio Margin Negative Balance Interest History (USER_DATA) — Query interest history of negative balance for portfolio margin.
Weight(IP): 50
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_portfolio_margin_asset_leverageInspect
Get Portfolio Margin Asset Leverage (USER_DATA) — Weight(IP): 50
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v1_portfolio_pm_loanInspect
Portfolio Margin Bankruptcy Loan Amount (USER_DATA) — Query Portfolio Margin Bankruptcy Loan Amount.
Weight(UID): 500 Returns: { asset: string, amount: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_portfolio_repay_futures_switchInspect
Get Auto-repay-futures Status (USER_DATA) — Query Auto-repay-futures Status
Weight(IP): 30 Returns: { autoRepay: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_rebate_tax_queryInspect
Get Spot Rebate History Records (USER_DATA) — - The max interval between startTime and endTime is 90 days.
If startTime and endTime are not sent, the recent 7 days' data will be returned.
The earliest startTime is supported on June 10, 2020
Weight(UID): 3000 Returns: { status: string, type: string, code: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | default 1 | |
| endTime | No | UTC timestamp in ms | |
| startTime | No | UTC timestamp in ms | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_accountInspect
Simple Account (USER_DATA) — Weight(IP): 150 Returns: { totalAmountInBTC: string, totalAmountInUSDT: string, totalFlexibleAmountInBTC: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_flexible_history_collateral_recordInspect
Get Collateral Record (USER_DATA) — Weight(IP): 150 Returns: { rows: { amount: string, productId: string, asset: string, createTime: number, type: string, productName: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| productId | No | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_flexible_history_rate_historyInspect
Get Rate History (USER_DATA) — Weight(IP): 150 Returns: { rows: { productId: string, asset: string, annualPercentageRate: string, time: number }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| productId | Yes | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_flexible_history_redemption_recordInspect
Get Flexible Redemption Record (USER_DATA) — Weight(IP): 150 Returns: { rows: { amount: string, asset: string, time: number, projectId: string, redeemId: number, destAccount: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| redeemId | No | query parameter: redeemId (string) | |
| productId | No | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_flexible_history_rewards_recordInspect
Get Flexible Rewards History (USER_DATA) — Weight(IP): 150 Returns: { rows: { asset: string, rewards: string, projectId: string, type: string, time: number }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | "BONUS", "REALTIME", "REWARDS" | |
| asset | No | query parameter: asset (string) | |
| productId | No | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_flexible_history_subscription_recordInspect
Get Flexible Subscription Record (USER_DATA) — Weight(IP): 150 Returns: { rows: { amount: string, asset: string, time: number, purchaseId: number, productId: string, type: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| productId | No | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| purchaseId | No | query parameter: purchaseId (string) |
get_sapi_v1_simple_earn_flexible_listInspect
Get Simple Earn Flexible Product List (USER_DATA) — Get available Simple Earn flexible product list
Weight(IP): 150 Returns: { rows: { asset: string, latestAnnualPercentageRate: string, tierAnnualPercentageRate: { 0-5BTC: number, 5-10BTC: number }, airDropPercentageRate: string, canPurchase: boolean, canRedeem: boolean, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_flexible_personal_left_quotaInspect
Get Flexible Personal Left Quota (USER_DATA) — Weight(IP): 150 Returns: { leftPersonalQuota: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| productId | Yes | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_flexible_positionInspect
Get Flexible Product Position (USER_DATA) — Weight(IP): 150 Returns: { rows: { totalAmount: string, tierAnnualPercentageRate: { 0-5BTC: number, 5-10BTC: number }, latestAnnualPercentageRate: string, yesterdayAirdropPercentageRate: string, asset: string, airDropAsset: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| productId | No | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_flexible_subscription_previewInspect
Get Flexible Subscription Preview (USER_DATA) — Weight(IP): 150 Returns: { totalAmount: string, rewardAsset: string, airDropAsset: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | query parameter: amount (number) | |
| productId | Yes | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_locked_history_redemption_recordInspect
Get Locked Redemption Record (USER_DATA) — Weight(IP): 150 Returns: { rows: { positionId: string, redeemId: number, time: number, asset: string, lockPeriod: string, amount: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| redeemId | No | query parameter: redeemId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| positionId | No | query parameter: positionId (string) |
get_sapi_v1_simple_earn_locked_history_rewards_recordInspect
Get Locked Rewards History (USER_DATA) — Weight(IP): 150 Returns: { rows: { positionId: string, time: number, asset: string, lockPeriod: string, amount: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| positionId | No | query parameter: positionId (string) |
get_sapi_v1_simple_earn_locked_history_subscription_recordInspect
Get Locked Subscription Record (USER_DATA) — Weight(IP): 150 Returns: { rows: { positionId: string, purchaseId: number, projectId: string, time: number, asset: string, amount: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| purchaseId | No | query parameter: purchaseId (string) |
get_sapi_v1_simple_earn_locked_listInspect
Get Simple Earn Locked Product List (USER_DATA) — Weight(IP): 150 Returns: { rows: { projectId: string, detail: { asset: string, rewardAsset: string, duration: number, renewable: boolean, isSoldOut: boolean, apr: string, ... }, quota: { totalPersonalQuota: string, minimum: string } }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_locked_personal_left_quotaInspect
Get Locked Personal Left Quota (USER_DATA) — Weight(IP): 150 Returns: { leftPersonalQuota: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | query parameter: projectId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_simple_earn_locked_positionInspect
Get Locked Product Position (USER_DATA) — Weight(IP): 150 Returns: { rows: { positionId: string, parentPositionId: string, projectId: string, asset: string, amount: string, purchaseTime: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | query parameter: asset (string) | |
| projectId | No | query parameter: projectId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| positionId | No | query parameter: positionId (string) |
get_sapi_v1_simple_earn_locked_set_redeem_optionInspect
Set Locked Product Redeem Option(USER_DATA) — Set redeem option for Locked product
Weight(IP): 50 Returns: { success: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| redeemTo | No | SPOT,FLEXIBLE, default FLEXIBLE | |
| undefined | No | undefined parameter: undefined (unknown) | |
| positionId | Yes | query parameter: positionId (string) |
get_sapi_v1_simple_earn_locked_subscription_previewInspect
Get Locked Subscription Preview (USER_DATA) — Weight(IP): 150
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | query parameter: amount (number) | |
| projectId | Yes | query parameter: projectId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| autoSubscribe | No | true or false, default true. |
get_sapi_v1_spot_delist_scheduleInspect
Get symbols delist schedule for spot (MARKET_DATA) — Get symbols delist schedule for spot
Weight(IP): 100
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_futures_accountInspect
Detail on Sub-account's Futures Account (For Master Account) — Weight(IP): 10 Returns: { email: string, asset: string, assets: { asset: string, initialMargin: string, maintenanceMargin: string, marginBalance: string, maxWithdrawAmount: string, openOrderInitialMargin: string, ... }[], ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | query parameter: email (string) | ||
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_futures_account_summaryInspect
Summary of Sub-account's Futures Account (For Master Account) — Weight(IP): 1 Returns: { totalInitialMargin: string, totalMaintenanceMargin: string, totalMarginBalance: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_futures_internal_transferInspect
Sub-account Futures Asset Transfer History (For Master Account) — Weight(IP): 1 Returns: { success: boolean, futuresType: number, transfers: { from: string, to: string, asset: string, qty: string, tranId: number, time: number }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default value: 50, Max value: 500 | |
| undefined | No | undefined parameter: undefined (unknown) | |
| futuresType | Yes | 1:USDT-margined Futures, 2: Coin-margined Futures |
get_sapi_v1_sub_account_futures_position_riskInspect
Futures Position-Risk of Sub-account (For Master Account) — Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_listInspect
Query Sub-account List (For Master Account) — Weight(IP): 1 Returns: { subAccounts: { email: string, isFreeze: boolean, createTime: number, isManagedSubAccount: boolean, isAssetManagementSubAccount: boolean }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default 1; max 200 | |
| isFreeze | No | query parameter: isFreeze ("true" | "false") | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_margin_accountInspect
Detail on Sub-account's Margin Account (For Master Account) — Weight(IP): 10 Returns: { email: string, marginLevel: string, totalAssetOfBtc: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_margin_account_summaryInspect
Summary of Sub-account's Margin Account (For Master Account) — Weight(IP): 10 Returns: { totalAssetOfBtc: string, totalLiabilityOfBtc: string, totalNetAssetOfBtc: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_spot_summaryInspect
Sub-account Spot Assets Summary (For Master Account) — Get BTC valued asset summary of subaccounts.
Weight(IP): 1 Returns: { totalCount: number, masterAccountTotalAsset: string, spotSubUserAssetBtcVoList: { email: string, totalAsset: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| size | No | Default:10 Max:20 | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_statusInspect
Sub-account's Status on Margin/Futures (For Master Account) — - If no email sent, all sub-accounts' information will be returned.
Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_sub_account_api_ip_restrictionInspect
Get IP Restriction for a Sub-account API Key (For Master Account) — Weight(UID): 3000 Returns: { ipRestrict: string, ipList: string[], updateTime: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_sub_transfer_historyInspect
Sub-account Spot Asset Transfer History (For Master Account) — - fromEmail and toEmail cannot be sent at the same time.
Return fromEmail equal master account email by default.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default 1 | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_transaction_statisticsInspect
Query Sub-account Transaction Statistics (For Master Account) — Query Sub-account Transaction statistics (For Master Account).
Weight(UID): 60 Returns: { recent30BtcTotal: string, recent30BtcFuturesTotal: string, recent30BtcMarginTotal: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_transfer_sub_user_historyInspect
Sub-account Transfer History (For Sub-account) — - If type is not sent, the records of type 2: transfer out will be returned by default.
If
startTimeandendTimeare not sent, the recent 30-day data will be returned.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | * `1` - transfer in * `2` - transfer out | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_sub_account_universal_transferInspect
Universal Transfer History (For Master Account) — - fromEmail and toEmail cannot be sent at the same time.
Return
fromEmailequal master account email by default.The query time period must be less then 30 days.
If startTime and endTime not sent, return records of the last 30 days by default.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default 500, Max 500 | |
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v1_system_statusInspect
System Status (System) — Fetch system status.
Weight(IP): 1 Returns: { status: number, msg: string }.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
get_sapi_v2_eth_staking_accountInspect
ETH Staking account V2(USER_DATA) — Weight(IP): 150 Returns: { holdingInETH: string, holdings: { wbethAmount: string, bethAmount: string }, thirtyDaysProfitInETH: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v2_loan_flexible_borrow_historyInspect
Borrow - Get Flexible Loan Borrow History (USER_DATA) — - If startTime and endTime are not sent, the recent 90-day data will be returned.
The max interval between startTime and endTime is 180 days.
Weight(IP): 400 Returns: { total: number, rows: { loanCoin: string, initialLoanAmount: string, collateralCoin: string, initialCollateralAmount: string, borrowTime: number, status: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v2_loan_flexible_collateral_dataInspect
Get Flexible Loan Collateral Assets Data (USER_DATA) — Get LTV information and collateral limit of flexible loan's collateral assets. The collateral limit is shown in USD value.
Weight(IP): 400 Returns: { rows: { collateralCoin: string, initialLTV: string, marginCallLTV: string, liquidationLTV: string, maxLimit: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v2_loan_flexible_loanable_dataInspect
Get Flexible Loan Assets Data (USER_DATA) — Get interest rate and borrow limit of flexible loanable assets. The borrow limit is shown in USD value.
Weight(IP): 400 Returns: { rows: { loanCoin: string, flexibleInterestRate: string, flexibleMinLimit: string, flexibleMaxLimit: string }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v2_loan_flexible_ltv_adjustment_historyInspect
Adjust LTV - Get Flexible Loan LTV Adjustment History (USER_DATA) — - If startTime and endTime are not sent, the recent 90-day data will be returned.
The max interval between startTime and endTime is 180 days.
Weight(IP): 400 Returns: { rows: { loanCoin: string, collateralCoin: string, direction: string, collateralAmount: string, preLTV: string, afterLTV: string, ... }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v2_loan_flexible_ongoing_ordersInspect
Borrow - Get Flexible Loan Ongoing Orders (USER_DATA) — Weight(IP): 300 Returns: { total: number, rows: { loanCoin: string, totalDebt: string, collateralCoin: string, collateralAmount: string, currentLTV: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v2_loan_flexible_repay_historyInspect
Repay - Get Flexible Loan Repayment History (USER_DATA) — - If startTime and endTime are not sent, the recent 90-day data will be returned.
The max interval between startTime and endTime is 180 days.
Weight(IP): 400 Returns: { rows: { loanCoin: string, repayAmount: string, collateralCoin: string, collateralReturn: string, repayStatus: string, repayTime: number }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v2_portfolio_collateral_rateInspect
Portfolio Margin Pro Tiered Collateral Rate(USER_DATA) — Portfolio Margin PRO Tiered Collateral Rate
Weight(IP): 50
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v2_sub_account_futures_accountInspect
Detail on Sub-account's Futures Account V2 (For Master Account) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| futuresType | Yes | * `1` - USDT Margined Futures * `2` - COIN Margined Futures |
get_sapi_v2_sub_account_futures_account_summaryInspect
Summary of Sub-account's Futures Account V2 (For Master Account) — Weight(IP): 10
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Default 10, Max 20 | |
| undefined | No | undefined parameter: undefined (unknown) | |
| futuresType | Yes | * `1` - USDT Margined Futures * `2` - COIN Margined Futures |
get_sapi_v2_sub_account_futures_position_riskInspect
Futures Position-Risk of Sub-account V2 (For Master Account) — Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| futuresType | Yes | * `1` - USDT Margined Futures * `2` - COIN Margined Futures |
get_sapi_v3_sub_account_assetsInspect
Sub-account Assets (For Master Account) — Fetch sub-account assets
Weight(IP): 1 Returns: { balances: { asset: string, free: number, locked: number }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
get_sapi_v4_sub_account_assetsInspect
Query Sub-account Assets (For Master Account) — Fetch sub-account assets
Weight(UID): 60 Returns: { balances: { asset: string, free: string, locked: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_api_v3_orderInspect
New Order (TRADE) — Send in a new order.
LIMIT_MAKERareLIMITorders that will be rejected if they would immediately match and trade as a taker.STOP_LOSSandTAKE_PROFITwill execute aMARKETorder when thestopPriceis reached.Any
LIMITorLIMIT_MAKERtype order can be made an iceberg order by sending anicebergQty.Any order with an
icebergQtyMUST havetimeInForceset toGTC.MARKETorders usingquantityspecifies how much a user wants to buy or sell based on the market price.MARKETorders usingquoteOrderQtyspecifies the amount the user wan
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_api_v3_order_cancel_replaceInspect
Cancel an Existing Order and Send a New Order (Trade) — Cancels an existing order and places a new order on the same symbol.
Filters and Order Count are evaluated before the processing of the cancellation and order placement occurs.
A new order that was not attempted (i.e. when newOrderResult: NOT_ATTEMPTED), will still increase the order count by 1.
Weight(IP): 1 Returns: { cancelResult: string, newOrderResult: string, cancelResponse: { symbol: string, origClientOrderId: string, orderId: number, orderListId: number, clientOrderId: string, price: string, ... }, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| cancelOrderId | No | Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence. | |
| cancelReplaceMode | Yes | - `STOP_ON_FAILURE` If the cancel request fails, the new order placement will not be attempted. - `ALLOW_FAILURES` If new order placement will be attempted even if cancel request fails. | |
| cancelNewClientOrderId | No | Used to uniquely identify this cancel. Automatically generated by default | |
| cancelOrigClientOrderId | No | Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence. |
post_api_v3_order_list_ocoInspect
New Order list - OCO (TRADE) — Send in an one-cancels-the-other (OCO) pair, where activation of one order immediately cancels the other.
An
OCOhas 2 orders called the above order and below order.One of the orders must be a
LIMIT_MAKERorder and the other must beSTOP_LOSSorSTOP_LOSS_LIMITorder.Price restrictions:
If the
OCOis on theSELLside:LIMIT_MAKERprice > Last Traded Price > stopPriceIf the
OCOis on theBUYside:LIMIT_MAKERprice < Last Traded Price < stopPrice
OCOs add 2 orders to the unfilled order count,
EXCHANGE_MAX_ORDERSfilter,
| Name | Required | Description | Default |
|---|---|---|---|
| aboveType | Yes | Supported values : `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER` | |
| belowType | Yes | Supported values : `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER` | |
| undefined | No | undefined parameter: undefined (unknown) | |
| abovePrice | No | query parameter: abovePrice (number) | |
| belowPrice | No | Can be used if `belowType` is `STOP_LOSS_LIMIT` or `LIMIT_MAKER` to specify the limit price. | |
| aboveStopPrice | No | Can be used if `aboveType` is `STOP_LOSS` or `STOP_LOSS_LIMIT`. Either `aboveStopPrice` or `aboveTrailingDelta` or both, must be specified. | |
| belowStopPrice | No | Can be used if `belowType` is `STOP_LOSS` or `STOP_LOSS_LIMIT`. Either `belowStopPrice` or `belowTrailingDelta` or both, must be specified. | |
| aboveIcebergQty | No | Note that this can only be used if `aboveTimeInForce` is `GTC`. | |
| aboveStrategyId | No | Arbitrary numeric value identifying the above order within an order strategy. | |
| belowIcebergQty | No | Note that this can only be used if `belowTimeInForce` is `GTC`. | |
| belowStrategyId | No | Arbitrary numeric value identifying the below order within an order strategy. | |
| aboveTimeInForce | No | Required if the `aboveType` is `STOP_LOSS_LIMIT`. | |
| belowTimeInForce | No | Required if the `belowType` is `STOP_LOSS_LIMIT`. | |
| aboveStrategyType | No | Arbitrary numeric value identifying the above order strategy. Values smaller than 1000000 are reserved and cannot be used. | |
| belowStrategyType | No | Arbitrary numeric value identifying the below order strategy. Values smaller than 1000000 are reserved and cannot be used. | |
| listClientOrderId | No | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `aboveClientOrderId` and the `belowCLientOrderId`. | |
| aboveClientOrderId | No | Arbitrary unique ID among open orders for the above order. Automatically generated if not sent | |
| aboveTrailingDelta | No | query parameter: aboveTrailingDelta (number) | |
| belowClientOrderId | No | Arbitrary unique ID among open orders for the below order. Automatically generated if not sent | |
| belowTrailingDelta | No | query parameter: belowTrailingDelta (number) |
post_api_v3_order_list_otoInspect
New Order List - OTO (TRADE) — Places an OTO.
An
OTO(One-Triggers-the-Other) is an order list comprised of 2 orders.The first order is called the working order and must be
LIMITorLIMIT_MAKER. Initially, only the working order goes on the order book.The second order is called the pending order. It can be any order type except for
MARKETorders using parameterquoteOrderQty. The pending order is only placed on the order book when the working order gets fully filled.If either the working order or the pending order is cancelled individually, the other order in the order l
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| listClientOrderId | No | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. | |
| pendingStrategyId | No | Arbitrary numeric value identifying the pending order within an order strategy. | |
| workingStrategyId | No | Arbitrary numeric value identifying the working order within an order strategy. | |
| pendingStrategyType | No | Arbitrary numeric value identifying the pending order strategy. Values smaller than 1000000 are reserved and cannot be used. | |
| workingStrategyType | No | Arbitrary numeric value identifying the working order strategy. Values smaller than 1000000 are reserved and cannot be used. |
post_api_v3_order_list_otocoInspect
New Order List - OTOCO (TRADE) — Place an OTOCO.
An
OTOCO(One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders.The first order is called the working order and must be
LIMITorLIMIT_MAKER. Initially, only the working order goes on the order book.The behavior of the working order is the same as the
OTO.
OTOCOhas 2 pending orders (pending above and pending below), forming anOCOpair. The pending orders are only placed on the order book when the working order gets fully filled.The rules of the pending above and pending below follow the same
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| listClientOrderId | No | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. | |
| workingStrategyId | No | Arbitrary numeric value identifying the working order within an order strategy. | |
| workingStrategyType | No | Arbitrary numeric value identifying the working order strategy. Values smaller than 1000000 are reserved and cannot be used. | |
| pendingAboveStrategyId | No | Arbitrary numeric value identifying the pending above order within an order strategy. | |
| pendingBelowStrategyId | No | Arbitrary numeric value identifying the pending below order within an order strategy. | |
| pendingAboveStrategyType | No | Arbitrary numeric value identifying the pending above order strategy. Values smaller than 1000000 are reserved and cannot be used. | |
| pendingBelowStrategyType | No | Arbitrary numeric value identifying the pending below order strategy. Values smaller than 1000000 are reserved and cannot be used. |
post_api_v3_order_testInspect
Test New Order (TRADE) — Test new order creation and signature/recvWindow long. Creates and validates a new order but does not send it into the matching engine.
Weight(IP):
Without computeCommissionRates:
1With computeCommissionRates:
20
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| computeCommissionRates | No | Default: false |
post_api_v3_sor_orderInspect
New order using SOR (TRADE) — Weight(IP): 6 Returns: { symbol: string, orderId: number, orderListId: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| price | No | query parameter: price (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
post_api_v3_sor_order_testInspect
Test new order using SOR (TRADE) — Test new order creation and signature/recvWindow using smart order routing (SOR). Creates and validates a new order but does not send it into the matching engine.
Weight(IP):
Without computeCommissionRates:
1With computeCommissionRates:
20
| Name | Required | Description | Default |
|---|---|---|---|
| price | No | query parameter: price (number) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| computeCommissionRates | No | Default: false |
post_api_v3_user_data_streamInspect
Create a ListenKey (USER_STREAM) — Start a new user data stream.
The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.
Weight: 2 Returns: { listenKey: string }.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
post_sapi_v1_account_disable_fast_withdraw_switchInspect
Disable Fast Withdraw Switch (USER_DATA) — - This request will disable fastwithdraw switch under your account.
You need to enable "trade" option for the api key which requests this endpoint.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_account_enable_fast_withdraw_switchInspect
Enable Fast Withdraw Switch (USER_DATA) — - This request will enable fastwithdraw switch under your account. You need to enable "trade" option for the api key which requests this endpoint.
When Fast Withdraw Switch is on, transferring funds to a Binance account will be done instantly. There is no on-chain transaction, no transaction ID and no withdrawal fee.
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_algo_futures_new_order_twapInspect
Time-Weighted Average Price(Twap) New Order (TRADE) — Send in a Twap new order. Only support on USDⓈ-M Contracts.
You need to enable Futures Trading Permission for the api key which requests this endpoint. Base URL: https://api.binance.com
Total Algo open orders max allowed: 10 orders.
Leverage of symbols and position mode will be the same as your futures account settings. You can set up through the trading page or fapi.
Receiving "success": true does not mean that your order will be executed. Please use the query order endpoints(GET sapi/v1/algo/futures/openOrders or GET sapi/v1/algo/
| Name | Required | Description | Default |
|---|---|---|---|
| duration | Yes | Duration for TWAP orders in seconds. [300, 86400];Less than 5min => defaults to 5 min; Greater than 24h => defaults to 24h | |
| quantity | Yes | Quantity of base asset; The notional (quantity * mark price(base asset)) must be more than the equivalent of 10,000 USDT and less than the equivalent of 1,000,000 USDT | |
| undefined | No | undefined parameter: undefined (unknown) | |
| limitPrice | No | Limit price of the order; If it is not sent, will place order by market price by default | |
| reduceOnly | No | 'true' or 'false'. Default 'false'; Cannot be sent in Hedge Mode; Cannot be sent when you open a position | |
| clientAlgoId | No | A unique id among Algo orders (length should be 32 characters), If it is not sent, we will give default value |
post_sapi_v1_algo_futures_new_order_vpInspect
Volume Participation(VP) New Order (TRADE) — Send in a VP new order. Only support on USDⓈ-M Contracts.
You need to enable
Futures Trading Permissionfor the api key which requests this endpoint.Base URL: https://api.binance.com
Total Algo open orders max allowed: 10 orders.
Leverage of symbols and position mode will be the same as your futures account settings. You can set up through the trading page or fapi.
Receiving "success": true does not mean that your order will be executed. Please use the query order endpoints(GET sapi/v1/algo/futures/openOrders or GET sapi/v1/algo/futur
| Name | Required | Description | Default |
|---|---|---|---|
| urgency | Yes | Represent the relative speed of the current execution; ENUM: LOW, MEDIUM, HIGH | |
| quantity | Yes | Quantity of base asset; The notional (quantity * mark price(base asset)) must be more than the equivalent of 10,000 USDT and less than the equivalent of 1,000,000 USDT | |
| undefined | No | undefined parameter: undefined (unknown) | |
| limitPrice | No | Limit price of the order; If it is not sent, will place order by market price by default | |
| reduceOnly | No | 'true' or 'false'. Default 'false'; Cannot be sent in Hedge Mode; Cannot be sent when you open a position | |
| clientAlgoId | No | A unique id among Algo orders (length should be 32 characters), If it is not sent, we will give default value |
post_sapi_v1_algo_spot_new_order_twapInspect
Time-Weighted Average Price (Twap) New Order — Place a new spot TWAP order with Algo service.
Weight(UID): 3000 Returns: { clientAlgoId: string, success: boolean, code: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| duration | Yes | query parameter: duration (number) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| limitPrice | No | query parameter: limitPrice (number) | |
| clientAlgoId | No | query parameter: clientAlgoId (string) |
post_sapi_v1_asset_convert_transferInspect
Convert Transfer (USER_DATA) — Convert transfer, convert between BUSD and stablecoins. If the clientId has been used before, will not do the convert transfer, the original transfer will be returned.
Weight(UID): 5 Returns: { tranId: number, status: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| targetAsset | Yes | Target asset you want to convert | |
| clientTranId | Yes | The unique flag, the min length is 20 |
post_sapi_v1_asset_dustInspect
Dust Transfer (USER_DATA) — Convert dust assets to BNB.
Weight(UID): 10 Returns: { totalServiceCharge: string, totalTransfered: string, transferResult: { amount: string, fromAsset: string, operateTime: number, serviceChargeAmount: string, tranId: number, transferedAmount: string }[] }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | Yes | The asset being converted. For example, asset=BTC&asset=USDT | |
| undefined | No | undefined parameter: undefined (unknown) | |
| accountType | No | SPOT or MARGIN, default SPOT |
post_sapi_v1_asset_dust_btcInspect
Get Assets That Can Be Converted Into BNB (USER_DATA) — Weight(IP): 1 Returns: { details: { asset: string, assetFullName: string, amountFree: string, toBTC: string, toBNB: string, toBNBOffExchange: string, ... }[], totalTransferBtc: string, totalTransferBNB: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| accountType | No | SPOT or MARGIN, default SPOT |
post_sapi_v1_asset_get_funding_assetInspect
Funding Wallet (USER_DATA) — - Currently supports querying the following business assets:Binance Pay, Binance Card, Binance Gift Card, Stock Token
Weight(IP): 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_asset_transferInspect
User Universal Transfer (USER_DATA) — You need to enable Permits Universal Transfer option for the api key which requests this endpoint.
fromSymbolmust be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGINtoSymbolmust be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
ENUM of transfer types:
MAIN_UMFUTURE Spot account transfer to USDⓈ-M Futures account
MAIN_CMFUTURE Spot account transfer to COIN-M Futures account
MAIN_MARGIN Spot account transfer to Margin(cross)account
UMFUTURE_MAIN USDⓈ-M Futures account transf
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_blvt_redeemInspect
Redeem BLVT (USER_DATA) — Weight(IP): 1 Returns: { id: number, status: string, tokenName: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_blvt_subscribeInspect
Subscribe BLVT (USER_DATA) — Weight(IP): 1 Returns: { id: number, status: string, tokenName: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| cost | Yes | Spot balance | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_bnb_burnInspect
Toggle BNB Burn On Spot Trade And Margin Interest (USER_DATA) — - "spotBNBBurn" and "interestBNBBurn" should be sent at least one.
Weight(IP): 1 Returns: { spotBNBBurn: boolean, interestBNBBurn: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| spotBNBBurn | No | Determines whether to use BNB to pay for trading fees on SPOT | |
| interestBNBBurn | No | Determines whether to use BNB to pay for margin loan's interest |
post_sapi_v1_capital_contract_convertible_coinsInspect
Switch on/off BUSD and stable coins conversion (USER_DATA) (USER_DATA) — User can use it to turn on or turn off the BUSD auto-conversion from/to a specific stable coin.
Weight(UID): 600'
| Name | Required | Description | Default |
|---|---|---|---|
| coin | Yes | Must be USDC, USDP or TUSD | |
| enable | Yes | true: turn on the auto-conversion. false: turn off the auto-conversion |
post_sapi_v1_capital_deposit_credit_applyInspect
One click arrival deposit apply (USER_DATA) — Apply deposit credit for expired address (One click arrival)
Weight(IP): 1 Returns: { code: string, message: string, data: boolean, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| txId | No | Deposit txId, used when depositId is not specified | |
| depositId | No | Deposit record Id, priority use | |
| subUserId | No | query parameter: subUserId (number) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| subAccountId | No | query parameter: subAccountId (number) |
post_sapi_v1_capital_withdraw_applyInspect
Withdraw (USER_DATA) — Submit a withdraw request.
If
networknot send, return with default network of the coin.You can get
networkandisDefaultinnetworkListof a coin in the response ofGet /sapi/v1/capital/config/getall (HMAC SHA256).
Weight(IP): 1 Returns: { id: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | query parameter: name (string) | |
| address | Yes | query parameter: address (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| addressTag | No | Secondary address identifier for coins like XRP,XMR etc. | |
| walletType | No | The wallet type for withdraw,0-Spot wallet, 1- Funding wallet. Default is Spot wallet | |
| withdrawOrderId | No | Client id for withdraw | |
| transactionFeeFlag | No | When making internal transfer - `true` -> returning the fee to the destination account; - `false` -> returning the fee back to the departure account. |
post_sapi_v1_convert_accept_quoteInspect
Accept Quote (TRADE) — Accept the offered quote by quote ID.
Weight(UID): 500 Returns: { orderId: string, createTime: number, orderStatus: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| quoteId | Yes | query parameter: quoteId (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_convert_get_quoteInspect
Send quote request (USER_DATA) — Request a quote for the requested token pairs
Weight(UID): 200 Returns: { quoteId: string, ratio: string, inverseRatio: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| toAsset | Yes | query parameter: toAsset (string) | |
| toAmount | No | When specified, it is the amount you will be debited after the conversion | |
| fromAsset | Yes | query parameter: fromAsset (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| validTime | No | 10s, 30s, 1m, 2m, default 10s | |
| fromAmount | No | When specified, it is the amount you will be debited after the conversion | |
| walletType | No | SPOT or FUNDING. Default is SPOT |
post_sapi_v1_convert_limit_cancel_orderInspect
Cancel limit order (USER_DATA) — Enable users to cancel a limit order
Weight(UID): 200 Returns: { orderId: number, status: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| orderId | Yes | query parameter: orderId (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_convert_limit_place_orderInspect
Place limit order (USER_DATA) — Enable users to place a limit order
baseAsset or quoteAsset can be determined via exchangeInfo endpoint.
Limit price is defined from baseAsset to quoteAsset.
Either baseAmount or quoteAmount is used.
Weight(UID): 500 Returns: { orderId: number, status: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| baseAmount | No | Base asset amount. (One of baseAmount or quoteAmount is required) | |
| limitPrice | Yes | Symbol limit price (from baseAsset to quoteAsset) | |
| walletType | No | SPOT or FUNDING or SPOT_FUNDING. It is to use which type of assets. Default is SPOT. | |
| expiredType | No | 1_D, 3_D, 7_D, 30_D (D means day) | |
| quoteAmount | No | Quote asset amount. (One of baseAmount or quoteAmount is required) |
post_sapi_v1_dci_product_auto_compound_edit_statusInspect
Change Auto-Compound status(USER_DATA) — Change Auto-Compound status
15:31 ~ 16:00 UTC+8 This function is disabled
Weight(IP): 1
Rate Limit: Maximum 1 time/s per account Returns: { positionId: string, autoCompoundPlan: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| positionId | Yes | Get positionId from /sapi/v1/dci/product/positions |
post_sapi_v1_dci_product_subscribeInspect
Subscribe Dual Investment products(USER_DATA) — Subscribe Dual Investment products
Products are not available.means that the APR changes to lower value, or the orders are not available.Failedis a system or network errors.
Weight(IP): 1 Returns: { positionId: number, investCoin: string, exercisedCoin: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | get id from /sapi/v1/dci/product/list | |
| orderId | Yes | get orderId from /sapi/v1/dci/product/list | |
| undefined | No | undefined parameter: undefined (unknown) | |
| depositAmount | Yes | query parameter: depositAmount (number) |
post_sapi_v1_eth_staking_eth_redeemInspect
Redeem ETH (TRADE) — Redeem WBETH or BETH and get ETH
You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.
Weight(IP): 150 Returns: { success: boolean, arrivalTime: number, ethAmount: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| asset | No | WBETH or BETH, default to BETH | |
| amount | Yes | Amount in BETH, limit 8 decimals | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_eth_staking_wbeth_wrapInspect
Wrap BETH(TRADE) — - You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.
Weight(IP): 150 Returns: { success: boolean, wbethAmount: string, exchangeRate: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Amount in BETH, limit 4 decimals | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_futures_transferInspect
New Future Account Transfer (USER_DATA) — Execute transfer between spot account and futures account.
Weight(IP): 1 Returns: { tranId: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | 1: transfer from spot account to USDT-Ⓜ futures account. 2: transfer from USDT-Ⓜ futures account to spot account. 3: transfer from spot account to COIN-Ⓜ futures account. 4: transfer from COIN-Ⓜ futures account to spot account. | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_giftcard_buy_codeInspect
Buy a Binance Code (TRADE) — This API is for buying a fixed-value Binance Code, which means your Binance Code will be redeemable to a token that is different to the token that you are paying in. If the token you’re paying and the redeemable token are the same, please use the Create Binance Code endpoint. You can use supported crypto currency or fiat token as baseToken to buy Binance Code that is redeemable to your chosen faceToken. Once successfully purchased, the amount of baseToken would be deducted from your funding wallet.
To get started with, please make sure:
You have a Binance accoun
| Name | Required | Description | Default |
|---|---|---|---|
| baseToken | Yes | The token you want to pay, example BUSD | |
| faceToken | Yes | The token you want to buy, example BNB. If faceToken = baseToken, it's the same as createCode endpoint. | |
| undefined | No | undefined parameter: undefined (unknown) | |
| baseTokenAmount | Yes | The base token asset quantity, example 1.002 |
post_sapi_v1_giftcard_create_codeInspect
Create a Binance Code (USER_DATA) — This API is for creating a Binance Code. To get started with, please make sure:
You have a Binance account
You have passed kyc
You have a sufficient balance in your Binance funding wallet
You need Enable Withdrawals for the API Key which requests this endpoint.
Daily creation volume: 2 BTC / 24H Daily creation times: 200 Codes / 24H
Weight(IP): 1 Returns: { code: string, message: string, data: { referenceNo: string, code: string, expiredTime: number }, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| token | Yes | The coin type contained in the Binance Code | |
| amount | Yes | The amount of the coin | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_giftcard_redeem_codeInspect
Redeem a Binance Code (USER_DATA) — This API is for redeeming the Binance Code. Once redeemed, the coins will be deposited in your funding wallet.
Please note that if you enter the wrong code 5 times within 24 hours, you will no longer be able to redeem any Binance Code that day.
Weight(IP): 1 Returns: { code: string, message: string, data: { token: string, amount: string, referenceNo: string, identityNo: string }, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | Binance Code | |
| undefined | No | undefined parameter: undefined (unknown) | |
| externalUid | No | Each external unique ID represents a unique user on the partner platform. The function helps you to identify the redemption behavior of different users, such as redemption frequency and amount. It also helps risk and limit control of a single account, such as daily limit on redemption volume, frequency, and incorrect number of entries. This will also prevent a single user account reach the partner's daily redemption limits. We strongly recommend you to use this feature and transfer us the User ID of your users if you have different users redeeming Binance codes on your platform. To protect user data privacy, you may choose to transfer the user id in any desired format (max. 400 characters). |
post_sapi_v1_lending_auto_invest_one_offInspect
One Time Transaction(TRADE) — One time transaction
Weight(IP): 1 Returns: { transactionId: number, waitSecond: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | No | query parameter: planId (number) | |
| details | No | query parameter: details ({ targetAsset: string, percentage: number }[]) | |
| indexId | No | query parameter: indexId (number) | |
| requestId | No | query parameter: requestId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| sourceType | Yes | query parameter: sourceType (string) | |
| sourceAsset | Yes | query parameter: sourceAsset (string) | |
| subscriptionAmount | Yes | query parameter: subscriptionAmount (number) | |
| flexibleAllowedToUse | No | query parameter: flexibleAllowedToUse (boolean) |
post_sapi_v1_lending_auto_invest_plan_addInspect
Investment plan creation (USER_DATA) — Post an investment plan creation
Weight(IP): 1 Returns: { planId: number, nextExecutionDateTime: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| IndexId | No | query parameter: IndexId (number) | |
| details | Yes | query parameter: details ({ targetAsset: string, percentage: number }[]) | |
| planType | Yes | query parameter: planType ("SINGLE" | "PORTFOLIO" | "INDEX") | |
| requestId | No | query parameter: requestId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| sourceType | Yes | query parameter: sourceType ("MAIN_SITE" | "TR") | |
| sourceAsset | Yes | query parameter: sourceAsset (string) | |
| subscriptionCycle | Yes | query parameter: subscriptionCycle ("H1" | "H4" | "H8" | "H12" | "WEEKLY" | "DAILY" | "MONTHLY" | "BI_WEEKLY") | |
| subscriptionAmount | Yes | query parameter: subscriptionAmount (number) | |
| flexibleAllowedToUse | No | query parameter: flexibleAllowedToUse (boolean) | |
| subscriptionStartDay | No | query parameter: subscriptionStartDay (number) | |
| subscriptionStartTime | Yes | query parameter: subscriptionStartTime (number) | |
| subscriptionStartWeekday | No | query parameter: subscriptionStartWeekday ("MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN") |
post_sapi_v1_lending_auto_invest_plan_editInspect
Investment plan adjustment — Query Source Asset to be used for investment
Weight(IP): 1 Returns: { planId: number, nextExecutionDateTime: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | query parameter: planId (number) | |
| details | No | query parameter: details ({ targetAsset: string, percentage: number }[]) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| sourceAsset | Yes | query parameter: sourceAsset (string) | |
| subscriptionCycle | Yes | query parameter: subscriptionCycle ("H1" | "H4" | "H8" | "H12" | "WEEKLY" | "DAILY" | "MONTHLY" | "BI_WEEKLY") | |
| subscriptionAmount | Yes | query parameter: subscriptionAmount (number) | |
| flexibleAllowedToUse | No | query parameter: flexibleAllowedToUse (boolean) | |
| subscriptionStartDay | No | query parameter: subscriptionStartDay (number) | |
| subscriptionStartTime | Yes | query parameter: subscriptionStartTime (number) | |
| subscriptionStartWeekday | No | query parameter: subscriptionStartWeekday ("MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN") |
post_sapi_v1_lending_auto_invest_plan_edit_statusInspect
Change Plan Status — Change Plan Status
Weight(IP): 1 Returns: { planId: number, nextExecutionDateTime: number, status: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | query parameter: planId (number) | |
| status | Yes | query parameter: status ("ONGOING" | "PAUSED" | "REMOVED") | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_lending_auto_invest_redeemInspect
Index Linked Plan Redemption (TRADE) — To redeem index-Linked plan holdings
Weight(IP): 1 Returns: { redemptionId: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| indexId | Yes | PORTFOLIO plan's Id | |
| requestId | No | sourceType + unique, transactionId and requestId cannot be empty at the same time | |
| undefined | No | undefined parameter: undefined (unknown) | |
| redemptionPercentage | Yes | user redeem percentage,10/20/100. |
post_sapi_v1_lending_customized_fixed_purchaseInspect
Purchase Fixed/Activity Project (USER_DATA) — Weight(IP): 1 Returns: { purchaseId: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_lending_position_changedInspect
Change Fixed/Activity Position to Daily Position (USER_DATA) — - PositionId is mandatory parameter for fixed position.
Weight(IP): 1 Returns: { dailyPurchaseId: number, success: boolean, time: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_loan_adjust_ltvInspect
Crypto Loan Adjust LTV (TRADE) — Weight(UID): 6000 Returns: { loanCoin: string, collateralCoin: string, direction: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Amount | |
| orderId | Yes | Order ID | |
| direction | Yes | 'ADDITIONAL', 'REDUCED' | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_loan_borrowInspect
Crypto Loan Borrow (TRADE) — Weight(UID): 6000 Returns: { loanCoin: string, loanAmount: string, collateralCoin: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| loanTerm | Yes | 7/14/30/90/180 days | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_loan_customize_margin_callInspect
Crypto Loan Customize Margin Call (TRADE) — Customize margin call for ongoing orders only.
Weight(UID): 6000 Returns: { rows: { orderId: string, collateralCoin: string, preMarginCall: string, afterMarginCall: string, customizeTime: number }[], total: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| orderId | No | Mandatory when collateralCoin is empty. Send either orderId or collateralCoin, if both parameters are sent, take orderId only. | |
| undefined | No | undefined parameter: undefined (unknown) | |
| marginCall | Yes | query parameter: marginCall (number) |
post_sapi_v1_loan_repayInspect
Crypto Loan Repay (TRADE) — Weight(UID): 6000
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Default: 1. 1 for 'repay with borrowed coin'; 2 for 'repay with collateral'. | |
| amount | Yes | Repayment Amount | |
| orderId | Yes | Order ID | |
| undefined | No | undefined parameter: undefined (unknown) | |
| collateralReturn | No | Default: TRUE. TRUE: Return extra collateral to spot account; FALSE: Keep extra collateral in the order. |
post_sapi_v1_loan_vip_borrowInspect
VIP Loan Borrow — VIP loan is available for VIP users only.
Weight(UID): 6000 Returns: { loanAccountId: string, requestId: string, loanCoin: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| loanTerm | No | query parameter: loanTerm (number) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| loanAmount | Yes | query parameter: loanAmount (number) | |
| loanAccountId | Yes | query parameter: loanAccountId (number) | |
| collateralCoin | Yes | query parameter: collateralCoin (string) | |
| isFlexibleRate | Yes | query parameter: isFlexibleRate ("TRUE" | "FALSE") | |
| collateralAccountId | Yes | query parameter: collateralAccountId (string) |
post_sapi_v1_loan_vip_renewInspect
VIP Loan Renew — VIP loan is available for VIP users only.
Weight(UID): 6000 Returns: { loanAccountId: string, loanCoin: string, loanAmount: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| loanTerm | No | query parameter: loanTerm (number) | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_loan_vip_repayInspect
VIP Loan Repay (TRADE) — VIP loan is available for VIP users only.
Weight(UID): 6000 Returns: { loanCoin: string, repayAmount: string, remainingPrincipal: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_managed_subaccount_depositInspect
Deposit assets into the managed sub-account(For Investor Master Account) — Weight(IP): 1 Returns: { tranId: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_managed_subaccount_withdrawInspect
Withdrawl assets from the managed sub-account(For Investor Master Account) — Weight(IP): 1 Returns: { tranId: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| transferDate | No | Withdrawals is automatically occur on the transfer date(UTC0). If a date is not selected, the withdrawal occurs right now |
post_sapi_v1_margin_borrow_repayInspect
Margin account borrow/repay(MARGIN) — Margin account borrow/repay(MARGIN)
Weight(UID): 3000 Returns: { tranId: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | BORROW or REPAY | |
| undefined | No | undefined parameter: undefined (unknown) | |
| isIsolated | Yes | TRUE for isolated margin, FALSE for crossed margin |
post_sapi_v1_margin_isolated_accountInspect
Enable Isolated Margin Account (TRADE) — Enable isolated margin account for a specific symbol.
Weight(UID): 300 Returns: { success: boolean, symbol: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_margin_manual_liquidationInspect
Margin manual liquidation(MARGIN) — Margin manual liquidation
Weight(UID): 3000
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | query parameter: type ("MARGIN" | "ISOLATED") | |
| symbol | No | query parameter: symbol (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_margin_max_leverageInspect
Adjust cross margin max leverage (USER_DATA) — Adjust cross margin max leverage
Weight(UID): 3000 Returns: { success: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| maxLeverage | Yes | Can only adjust 3 or 5 |
post_sapi_v1_margin_orderInspect
Margin Account New Order (TRADE) — Post a new order for margin account.
Weight(UID): 6
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| autoRepayAtCancel | Yes | query parameter: autoRepayAtCancel (boolean) |
post_sapi_v1_margin_order_ocoInspect
Margin Account New OCO (TRADE) — Send in a new OCO for a margin account
Price Restrictions:
SELL: Limit Price > Last Price > Stop Price
BUY: Limit Price < Last Price < Stop Price
Quantity Restrictions:
Both legs must have the same quantity
ICEBERG quantities however do not have to be the same.
Order Rate Limit
OCO counts as 2 orders against the order rate limit.
Weight(UID): 6 Returns: { orderListId: number, contingencyType: string, listStatusType: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_margin_order_otoInspect
Margin Account New OTO (TRADE) — Post a new OTO order for margin account:
An
OTO(One-Triggers-the-Other) is an order list comprised of 2 ordersThe first order is called the working order and must be
LIMITorLIMIT_MAKER. Initially, only the working order goes on the order book.The second order is called the pending order. It can be any order type except for
MARKETorders using parameterquoteOrderQty. The pending order is only placed on the order book when the working order gets fully filled.If either the working order or the pending order is cancelled individually, the
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| sideEffectType | No | Default `NO_SIDE_EFFECT` | |
| autoRepayAtCancel | No | Only when MARGIN_BUY 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 | |
| listClientOrderId | No | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. |
post_sapi_v1_margin_order_otocoInspect
Margin Account New OTOCO (TRADE) — Post a new OTOCO order for margin account:
An
OTOCO(One-Triggers-the-Other-Cancel-the-Other) is an order list comprised of 3 ordersThe first order is called the working order and must be
LIMITorLIMIT_MAKER. Initially, only the working order goes on the order book.The behavior of the working order is the same as the
OTO.
OTOCOhas 2 pending orders (pending above and pending below), forming anOCOpair. The pending orders are only placed on the order book when the working order gets fully filled.The rules of the pending above a
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| sideEffectType | No | Default `NO_SIDE_EFFECT` | |
| autoRepayAtCancel | No | Only when MARGIN_BUY 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 | |
| listClientOrderId | No | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`. |
post_sapi_v1_mining_hash_transfer_configInspect
Hashrate Resale Request (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_mining_hash_transfer_config_cancelInspect
Cancel Hashrate Resale configuration (USER_DATA) — Weight(IP): 5 Returns: { code: number, msg: string, data: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_portfolio_asset_collectionInspect
Fund Collection by Asset (USER_DATA) — Transfers specific asset from Futures Account to Margin account
Weight(IP): 60 Returns: { msg: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_portfolio_auto_collectionInspect
Fund Auto-collection (USER_DATA) — Transfers all assets from Futures Account to Margin account
Weight(IP): 1500 Returns: { msg: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_portfolio_bnb_transferInspect
BNB Transfer (USER_DATA) — BNB transfer can be between Margin Account and USDM Account
Weight(IP): 1500 Returns: { tranId: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| transferSide | Yes | query parameter: transferSide ("TO_UM" | "FROM_UM") |
post_sapi_v1_portfolio_repayInspect
Portfolio Margin Bankruptcy Loan Repay (USER_DATA) — Repay Portfolio Margin Bankruptcy Loan.
Weight(UID): 3000 Returns: { tranId: number }.
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | query parameter: from (string) | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_portfolio_repay_futures_negative_balanceInspect
Repay futures Negative Balance (USER_DATA) — Repay futures Negative Balance
Weight(IP): 1500 Returns: { msg: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_portfolio_repay_futures_switchInspect
Change Auto-repay-futures Status (USER_DATA) — Change Auto-repay-futures Status
Weight(IP): 1500 Returns: { msg: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_simple_earn_flexible_redeemInspect
Redeem Flexible Product (TRADE) — Weight(IP): 1
Rate Limit: 1/3s per account Returns: { redeemId: number, success: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| amount | No | if redeemAll is false, amount is mandatory | |
| productId | Yes | query parameter: productId (string) | |
| redeemAll | No | true or false, default to false | |
| undefined | No | undefined parameter: undefined (unknown) | |
| destAccount | No | SPOT,FUND,ALL, default SPOT |
post_sapi_v1_simple_earn_flexible_set_auto_subscribeInspect
Set Flexible Auto Subscribe (USER_DATA) — Weight(IP): 150 Returns: { success: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| productId | Yes | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| autoSubscribe | Yes | true or false |
post_sapi_v1_simple_earn_flexible_subscribeInspect
Subscribe Flexible Product (TRADE) — Weight(IP): 1
Rate Limit: 1/3s per account Returns: { purchaseId: number, success: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | query parameter: amount (number) | |
| productId | Yes | query parameter: productId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| autoSubscribe | No | true or false, default true. | |
| sourceAccount | No | SPOT,FUND,ALL, default SPOT |
post_sapi_v1_simple_earn_locked_redeemInspect
Redeem Locked Product (TRADE) — Weight(IP): 1
Rate Limit: 1/3s per account Returns: { redeemId: number, success: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| positionId | Yes | 1234 |
post_sapi_v1_simple_earn_locked_set_auto_subscribeInspect
Set Locked Auto Subscribe (USER_DATA) — Weight(IP): 150 Returns: { success: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| positionId | Yes | query parameter: positionId (string) | |
| autoSubscribe | Yes | true or false |
post_sapi_v1_simple_earn_locked_subscribeInspect
Subscribe Locked Product (TRADE) — Weight(IP): 1
Rate Limit: 1/3s per account Returns: { purchaseId: number, positionId: string, success: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | query parameter: amount (number) | |
| redeemTo | No | SPOT,FLEXIBLE, default FLEXIBLE | |
| projectId | Yes | query parameter: projectId (string) | |
| undefined | No | undefined parameter: undefined (unknown) | |
| autoSubscribe | No | true or false, default true. | |
| sourceAccount | No | SPOT,FUND,ALL, default SPOT |
post_sapi_v1_sub_account_blvt_enableInspect
Enable Leverage Token for Sub-account (For Master Account) — Weight(IP): 1 Returns: { email: string, enableBlvt: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| enableBlvt | Yes | Only true for now |
post_sapi_v1_sub_account_eoptions_enableInspect
Enable Options for Sub-account (For Master Account)(USER_DATA) — Enable Options for Sub-account (For Master Account).
Weight(IP): 1 Returns: { email: string, isEOptionsEnabled: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_sub_account_futures_enableInspect
Enable Futures for Sub-account (For Master Account) — Weight(IP): 1 Returns: { email: string, isFuturesEnabled: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_sub_account_futures_internal_transferInspect
Sub-account Futures Asset Transfer (For Master Account) — - Master account can transfer max 2000 times a minute
Weight(IP): 1 Returns: { success: boolean, txnId: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| futuresType | Yes | 1:USDT-margined Futures,2: Coin-margined Futures |
post_sapi_v1_sub_account_futures_transferInspect
Transfer for Sub-account (For Master Account) — Weight(IP): 1 Returns: { txnId: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | * `1` - transfer from subaccount's spot account to its USDT-margined futures account * `2` - transfer from subaccount's USDT-margined futures account to its spot account * `3` - transfer from subaccount's spot account to its COIN-margined futures account * `4` - transfer from subaccount's COIN-margined futures account to its spot account | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_sub_account_margin_enableInspect
Enable Margin for Sub-account (For Master Account) — Weight(IP): 1 Returns: { email: string, isMarginEnabled: boolean }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_sub_account_margin_transferInspect
Margin Transfer for Sub-account (For Master Account) — Weight(IP): 1 Returns: { txnId: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | * `1` - transfer from subaccount's spot account to margin account * `2` - transfer from subaccount's margin account to its spot account | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_sub_account_transfer_sub_to_masterInspect
Transfer to Master (For Sub-account) — Weight(IP): 1 Returns: { txnId: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_sub_account_transfer_sub_to_subInspect
Transfer to Sub-account of Same Master (For Sub-account) — Weight(IP): 1 Returns: { txnId: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v1_sub_account_universal_transferInspect
Universal Transfer (For Master Account) — - You need to enable "internal transfer" option for the api key which requests this endpoint.
Transfer from master account by default if fromEmail is not sent.
Transfer to master account by default if toEmail is not sent.
Supported transfer scenarios:
Master account SPOT transfer to sub-account SPOT,USDT_FUTURE,COIN_FUTURE,MARGIN(Cross),ISOLATED_MARGIN
Sub-account SPOT,USDT_FUTURE,COIN_FUTURE,MARGIN(Cross),ISOLATED_MARGIN transfer to master account SPOT
Transfer between two sub-account SPOT accounts
Weight(IP): 1 Returns: { tranId: n
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | No | Only supported under ISOLATED_MARGIN type | |
| undefined | No | undefined parameter: undefined (unknown) | |
| toAccountType | Yes | query parameter: toAccountType ("SPOT" | "USDT_FUTURE" | "COIN_FUTURE" | "MARGIN" | "ISOLATED_MARGIN") | |
| fromAccountType | Yes | query parameter: fromAccountType ("SPOT" | "USDT_FUTURE" | "COIN_FUTURE" | "MARGIN" | "ISOLATED_MARGIN") |
post_sapi_v1_sub_account_virtual_sub_accountInspect
Create a Virtual Sub-account(For Master Account) — - This request will generate a virtual sub account under your master account.
You need to enable "trade" option for the api key which requests this endpoint.
Weight(IP): 1 Returns: { email: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| subAccountString | Yes | Please input a string. We will create a virtual email using that string for you to register |
post_sapi_v1_user_data_streamInspect
Create a ListenKey (USER_STREAM) — Start a new user data stream.
The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.
Weight: 1 Returns: { listenKey: string }.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
post_sapi_v1_user_data_stream_isolatedInspect
Generate a Listen Key (USER_STREAM) — Start a new user data stream.
The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.
Weight: 1 Returns: { listenKey: string }.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
post_sapi_v2_eth_staking_eth_stakeInspect
Subscribe ETH Staking V2(TRADE) — Stake ETH to get WBETH
You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.
Weight(IP): 150 Returns: { success: boolean, wbethAmount: string, conversionRatio: string }.
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Amount in ETH, limit 4 decimals | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v2_loan_flexible_adjust_ltvInspect
Adjust LTV - Flexible Loan Adjust LTV (TRADE) — - API Key needs Spot & Margin Trading permission for this endpoint
Weight(UID): 6000 Returns: { loanCoin: string, collateralCoin: string, direction: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| direction | Yes | query parameter: direction ("ADDITIONAL" | "REDUCED") | |
| undefined | No | undefined parameter: undefined (unknown) | |
| adjustmentAmount | Yes | query parameter: adjustmentAmount (number) |
post_sapi_v2_loan_flexible_borrowInspect
Borrow - Flexible Loan Borrow (TRADE) — - Only available for master account
Weight(UID): 6000 Returns: { loanCoin: string, loanAmount: string, collateralCoin: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v2_loan_flexible_repayInspect
Repay - Flexible Loan Repay (TRADE) — - repayAmount is mandatory even fullRepayment = FALSE
Weight(IP): 6000 Returns: { loanCoin: string, collateralCoin: string, remainingDebt: string, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) | |
| repayAmount | Yes | repay amount of loanCoin | |
| fullRepayment | No | Default: FALSE. TRUE: Full repayment; FALSE: Partial repayment, based on loanAmount | |
| collateralReturn | No | Default: TRUE. TRUE: Return extra collateral to earn account; FALSE: Keep extra collateral in the order, and lower LTV. |
post_sapi_v2_sub_account_sub_account_api_ip_restrictionInspect
Update IP Restriction for Sub-Account API key (For Master Account) — Update IP Restriction for Sub-Account API key
Weight(UID): 3000 Returns: { status: string, ipList: string[], updateTime: number, ... }.
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | IP Restriction status. 1 = IP Unrestricted. 2 = Restrict access to trusted IPs only. 3 = Restrict access to users' trusted third party IPs only | |
| undefined | No | undefined parameter: undefined (unknown) |
post_sapi_v3_asset_get_user_assetInspect
User Asset (USER_DATA) — Get user assets, just for positive data.
Weight(IP): 5
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
put_api_v3_user_data_streamInspect
Ping/Keep-alive a ListenKey (USER_STREAM) — Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes.
Weight: 2
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
put_sapi_v1_user_data_streamInspect
Ping/Keep-alive a ListenKey (USER_STREAM) — Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes.
Weight: 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
put_sapi_v1_user_data_stream_isolatedInspect
Ping/Keep-alive a Listen Key (USER_STREAM) — Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes.
Weight: 1
| Name | Required | Description | Default |
|---|---|---|---|
| undefined | No | undefined parameter: undefined (unknown) |
To claim this server, publish a /.well-known/glama.json file on your server's domain with the following structure:
{
"$schema": "https://glama.ai/mcp/schemas/connector.json",
"maintainers": [
{
"email": "your-email@example.com"
}
]
}The email address must match the email associated with your Glama account. Once verified, the server will appear as claimed by you.
Control your server's listing on Glama, including description and metadata
Receive usage reports showing how your server is being used
Get monitoring and health status updates for your server
The connector status is unhealthy when Glama is unable to successfully connect to the server. This can happen for several reasons:
The server is experiencing an outage
The URL of the server is wrong
Credentials required to access the server are missing or invalid
If you are the owner of this MCP connector and would like to make modifications to the listing, including providing test credentials for accessing the server, please contact support@glama.ai.
Discussions
No comments yet. Be the first to start the discussion!
Your Connectors
Sign in to create a connector for this server.