### Expanded URL Examples Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/configuration-reference.md Examples of how the base URL placeholder resolves for production and testnet environments. ```text https://api.binance.com/api/v3/account (Production) https://testnet.binance.vision/api/v3/account (Testnet) ``` -------------------------------- ### JSON Response Example Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/README.md Standard format for displaying API response examples using triple backticks. ```json {"example": "response"} ``` -------------------------------- ### API Response Example Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/authentication.md Standard JSON response for a successful GET request. ```json { "data": "Normal" } ``` -------------------------------- ### Account Trade List Response Example Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Example JSON response structure for the account trade list endpoint. ```json [ { "symbol": "BNBBTC", "id": 28457, "orderId": 100234, "orderListId": -1, "price": "4.00000100", "qty": "12.00000000", "quoteQty": "48.000012", "commission": "10.10000000", "commissionAsset": "BNB", "time": 1499865549590, "isBuyer": true, "isMaker": false, "isBestMatch": true } ] ``` -------------------------------- ### CM Futures Pair Examples Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Examples of pair naming conventions for COIN-M futures contracts. ```text BTCUSD_PERP - Bitcoin perpetual ETHUSD_PERP - Ethereum perpetual BTCUSD_240930 - Bitcoin quarterly (expires 2024-09-30) ``` -------------------------------- ### Get Deposit Address Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-wallet-api.md Example JSON response containing the deposit address and associated metadata. ```json { "address": "1HPn8Pzt7YcVFaeJT7ClWDV4bNHVkeKwq1", "coin": "BTC", "tag": "", "url": "https://www.blockchain.com/btc/address/1HPn8Pzt7YcVFaeJT7ClWDV4bNHVkeKwq1" } ``` -------------------------------- ### GET Account Status Request Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/authentication.md Example of a read-only request using the API key header. ```http GET /sapi/v1/account/status Headers: X-MBX-APIKEY: vmPUZE6mv9SD5VNHk4HlWFsOa6aFbA ``` -------------------------------- ### Query Order Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Example response containing order status and details. ```json { "symbol": "BTCUSDT", "orderId": 28, "orderListId": -1, "clientOrderId": "6gCrw2kRZvke0RCqVLX1mY", "price": "63.57600000", "origQty": "0.69300000", "executedQty": "0.69300000", "cummulativeQuoteQty": "44.08968582", "status": "FILLED", "timeInForce": "GTC", "type": "MARKET", "side": "SELL", "time": 1507725176595, "updateTime": 1507725176595, "isWorking": true, "workingTime": 1507725176595, "origQuoteOrderQty": "0.00000000", "selfTradePreventionMode": "NONE" } ``` -------------------------------- ### Configure recvWindow Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/authentication.md Example of increasing the request validity window for unstable network conditions. ```javascript // Increase to 10 seconds { timestamp: Date.now(), recvWindow: 10000 } ``` -------------------------------- ### Get Deposit History Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-wallet-api.md Example JSON array containing deposit transaction records. ```json [ { "id": "769800519366885376", "coin": "BTC", "network": "BTC", "address": "1HPn8Pzt7YcVFaeJT7ClWDV4bNHVkeKwq1", "addressTag": "", "txId": "14d60c23b56c2157a51620e6c84f1cd34c5c1bcc42616ef1ecd19977a927cb45", "insertTime": 1599621997000, "amount": "0.01000000", "confirmTimes": "1", "status": 1, "unlockConfirm": 0, "walletType": 0 } ] ``` -------------------------------- ### Place Order Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Example JSON response for a successfully placed order with FULL response type. ```json { "orderId": 1917589, "symbol": "BTCUSDT", "pair": "BTCUSDT", "status": "NEW", "clientOrderId": "test", "price": "9500", "avgPrice": "0.00", "origQty": "1.0", "executedQty": "0", "cumQty": "0", "cumQuote": "0", "timeInForce": "GTC", "type": "LIMIT", "reduceOnly": false, "closePosition": false, "side": "BUY", "positionSide": "BOTH", "stopPrice": "0", "workingType": "CONTRACT_PRICE", "priceProtect": false, "origType": "LIMIT", "updateTime": 1566818724722 } ``` -------------------------------- ### GET /sapi/v1/margin/allOrders Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Retrieves all margin orders for a symbol. ```APIDOC ## GET /sapi/v1/margin/allOrders ### Description Returns a list of all margin orders for a specific symbol. ### Method GET ### Endpoint /sapi/v1/margin/allOrders ### Parameters #### Query Parameters - **symbol** (string) - Required - Trading pair - **isIsolated** (string) - Optional - true for isolated, false for cross - **orderId** (integer) - Optional - Start from this order ID - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **limit** (integer) - Optional - Max 500, default 500 - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ``` -------------------------------- ### IP Whitelist Configuration Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/configuration-reference.md Example format for IP addresses allowed in the Binance API restriction settings. ```text 128.0.0.1 192.168.1.100 203.0.113.0/24 ``` -------------------------------- ### Spot Trading Pair Examples Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/types-and-enums.md Common naming conventions for spot trading pairs. ```text BTCUSDT - Bitcoin to USDT ETHUSDT - Ethereum to USDT BNBUSDT - Binance Coin to USDT BUSDUSDT - Binance USD to USDT ``` -------------------------------- ### GET /sapi/v1/margin/openOrders Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Retrieves all open margin orders. ```APIDOC ## GET /sapi/v1/margin/openOrders ### Description Returns a list of all open margin orders. ### Method GET ### Endpoint /sapi/v1/margin/openOrders ### Parameters #### Query Parameters - **symbol** (string) - Optional - Trading pair - **isIsolated** (string) - Optional - true for isolated, false for cross - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ``` -------------------------------- ### GET /sapi/v1/margin/order Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Queries an existing margin order. ```APIDOC ## GET /sapi/v1/margin/order ### Description Retrieves details of a specific margin order. ### Method GET ### Endpoint /sapi/v1/margin/order ### Parameters #### Query Parameters - **symbol** (string) - Required - Trading pair - **isIsolated** (string) - Optional - true for isolated, false for cross - **orderId** (integer) - Optional - Order ID - **origClientOrderId** (string) - Optional - Client order ID - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ``` -------------------------------- ### Place Market Buy Order via Postman Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Example configuration for a POST request to place a market order using Postman variables. ```http POST {{url}}/api/v3/order Headers: X-MBX-APIKEY: {{api-key}} Content-Type: application/x-www-form-urlencoded Body: symbol=BTCUSDT side=BUY type=MARKET quantity=0.001 timestamp={{timestamp}} signature={{signature}} ``` -------------------------------- ### GET /sapi/v1/capital/config/getall Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-wallet-api.md Retrieves comprehensive information about all coins, including network details, deposit/withdrawal status, and fees. ```APIDOC ## GET /sapi/v1/capital/config/getall ### Description Retrieves comprehensive information about all coins, including network details, deposit/withdrawal status, and fees. ### Method GET ### Endpoint /sapi/v1/capital/config/getall ### Parameters #### Query Parameters - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of coin objects with networks information, deposit status, withdrawal status, withdraw fee, deposit fee, and min quantity requirements ``` -------------------------------- ### Account Information Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Example JSON response containing account commission rates, trading permissions, and asset balances. ```json { "makerCommission": 10, "takerCommission": 10, "buyerCommission": 0, "sellerCommission": 0, "canTrade": true, "canWithdraw": true, "canDeposit": true, "brokered": false, "requireSelfTradePrevention": false, "preventedMatchId": 0, "preventedQuantity": "0.00000000", "accountType": "SPOT", "balances": [ { "asset": "BTC", "free": "4723846.89", "locked": "0.00" } ], "permissions": [ "SPOT" ] } ``` -------------------------------- ### GET /sapi/v1/margin/account Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/api-families.md Retrieves a cross-margin account overview. ```APIDOC ## GET /sapi/v1/margin/account ### Description Retrieves a cross-margin account overview. ### Method GET ### Endpoint https://api.binance.com/sapi/v1/margin/account ``` -------------------------------- ### POST Request Body Parameters Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/configuration-reference.md Example of enabled parameters for application/x-www-form-urlencoded requests. ```text symbol=BTCUSDT side=BUY type=MARKET ``` -------------------------------- ### GET /sapi/v1/margin/repay Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Query repayment records for margin trading. ```APIDOC ## GET /sapi/v1/margin/repay ### Description Retrieve a list of repayment records. ### Method GET ### Endpoint /sapi/v1/margin/repay ### Parameters #### Query Parameters - **asset** (string) - Required - Asset - **txId** (integer) - Optional - Transaction ID - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **current** (integer) - Optional - Current page (default 1) - **size** (integer) - Optional - Page size (max 100, default 10) - **archived** (string) - Optional - Include archived records - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - Array of repay transaction objects ``` -------------------------------- ### GET /api/v3/allOrders Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Retrieves all account orders for a symbol. ```APIDOC ## GET /api/v3/allOrders ### Description Retrieves all account orders for a symbol, including filled and canceled orders. ### Method GET ### Endpoint /api/v3/allOrders ### Parameters #### Query Parameters - **symbol** (string) - Required - Trading pair - **orderId** (integer) - Optional - Start from this order ID - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **limit** (integer) - Optional - Max 1000, default 500 - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ``` -------------------------------- ### Account Information Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Example JSON response containing account balances, margin details, and position information. ```json { "feeTier": 2, "canTrade": true, "canDeposit": true, "canWithdraw": true, "updateTime": 123456789, "totalInitialMargin": "0.00000000", "totalMaintMargin": "0.00000000", "totalWalletBalance": "23.12000000", "totalUnrealizedProfit": "0.80000000", "totalMarginBalance": "24.12000000", "totalPositionInitialMargin": "0.00000000", "totalOpenOrderInitialMargin": "0.00000000", "totalCrossWalletBalance": "23.12000000", "totalCrossUnPnl": "0.80000000", "availableBalance": "24.12000000", "maxWithdrawAmount": "23.12000000", "positions": [ { "symbol": "BTCUSDT", "initialMargin": "0", "maintMargin": "0", "unrealizedProfit": "0", "positionInitialMargin": "0", "openOrderInitialMargin": "0", "leverage": "20", "maxNotionalValue": "500000", "bidNotional": "0", "askNotional": "0", "positionSide": "BOTH", "isolated": false, "updateTime": 0 } ], "assets": [ { "asset": "USDT", "walletBalance": "23.12000000", "unrealizedProfit": "0.80000000", "marginBalance": "24.12000000", "maintMargin": "0", "initialMargin": "0", "positionInitialMargin": "0", "openOrderInitialMargin": "0", "crossWalletBalance": "23.12000000", "crossUnPnl": "0.80000000", "availableBalance": "24.12000000", "maxWithdrawAmount": "23.12000000", "marginAvailable": true, "updateTime": 1625474304765 } ], "canOpenPositionMode": false, "tradeGroupId": 0, "positionMode": { "dualSidePosition": false }, "uid": 354937868 } ``` -------------------------------- ### Postman Environment Variables Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/authentication.md Example configuration for API key and secret variables in Postman. ```json { "key": "api-key", "value": "vmPUZE6mv9SD5VNHk4HlWFsOa6aFbA", "type": "secret", "enabled": true }, { "key": "api-secret", "value": "NhqPtmdSJYdKjVHjA7PZj4Mge3R5YnhG", "type": "secret", "enabled": true } ``` -------------------------------- ### GET /fapi/v1/order Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Queries the status of an existing order. ```APIDOC ## GET /fapi/v1/order ### Description Queries the status of an existing order. ### Method GET ### Endpoint /fapi/v1/order ### Parameters #### Query Parameters - **symbol** (string) - Required - Trading pair - **orderId** (integer) - Optional - Order ID - **origClientOrderId** (string) - Optional - Client order ID - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ``` -------------------------------- ### GET /fapi/v1/openOrders Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves all currently open orders for the user. ```APIDOC ## GET /fapi/v1/openOrders ### Description Retrieves all currently open orders for the user. ### Method GET ### Endpoint /fapi/v1/openOrders ### Parameters #### Query Parameters - **symbol** (string) - Optional - Trading pair - **recvWindow** (integer) - Optional - Max 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of open order objects ``` -------------------------------- ### GET /api/v3/account Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/INDEX.md Retrieves current account information. ```APIDOC ## GET /api/v3/account ### Description Retrieves current account information, including balances and permissions. ### Method GET ### Endpoint /api/v3/account ### Authentication Requires API Key and Signature. ``` -------------------------------- ### Place Margin Order Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Example JSON response for a successfully placed margin order with FULL response type. ```json { "symbol": "BTCUSDT", "orderId": 28, "clientOrderId": "6gCrw2kRZvke0RCqVLX1mY", "transactTime": 1507725176595, "price": "0.00000000", "origQty": "10.00000000", "executedQty": "10.00000000", "cummulativeQuoteQty": "635.76000000", "status": "FILLED", "timeInForce": "GTC", "type": "MARKET", "side": "SELL", "marginBuyBorrowAmount": 5.05, "marginBuyBorrowAsset": "BNB", "isIsolated": false, "fills": [ { "price": "63.576", "qty": "0.693", "commission": "0.000000", "commissionAsset": "BNB", "tradeId": 1234 } ] } ``` -------------------------------- ### GET /sapi/v1/margin/interestHistory Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Query interest history for margin trading. ```APIDOC ## GET /sapi/v1/margin/interestHistory ### Description Retrieve interest history records. ### Method GET ### Endpoint /sapi/v1/margin/interestHistory ### Parameters #### Query Parameters - **asset** (string) - Optional - Asset - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **current** (integer) - Optional - Current page (default 1) - **size** (integer) - Optional - Page size (max 100) - **archived** (string) - Optional - Include archived records - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - Array of interest objects ``` -------------------------------- ### GET /sapi/v1/asset/assetDividend Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-wallet-api.md Retrieves the asset dividend record for the user. ```APIDOC ## GET /sapi/v1/asset/assetDividend ### Description Retrieves the asset dividend record for the user. ### Method GET ### Endpoint /sapi/v1/asset/assetDividend ### Parameters #### Query Parameters - **asset** (string) - Optional - Asset symbol - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **limit** (integer) - Optional - Max 500 - **offset** (integer) - Optional - Offset - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response - Array of dividend records ``` -------------------------------- ### GET /sapi/v1/margin/loan Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Query loan records for margin trading. ```APIDOC ## GET /sapi/v1/margin/loan ### Description Retrieve a list of loan records. ### Method GET ### Endpoint /sapi/v1/margin/loan ### Parameters #### Query Parameters - **asset** (string) - Required - Asset - **txId** (integer) - Optional - Transaction ID - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **current** (integer) - Optional - Current page (default 1) - **size** (integer) - Optional - Page size (max 100, default 10) - **archived** (string) - Optional - Include archived records - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **asset** (string) - Asset name - **principal** (string) - Principal amount - **timestamp** (integer) - Timestamp - **accountId** (integer) - Account ID - **txId** (string) - Transaction ID - **isIsolated** (boolean) - Isolated margin status #### Response Example [ { "asset": "BTC", "principal": "0.10000000", "timestamp": 1555056425000, "accountId": 27896985, "txId": "100000001", "isIsolated": false } ] ``` -------------------------------- ### Generate UTC Millisecond Timestamps Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/types-and-enums.md Examples of generating the required UTC millisecond timestamp format in different environments. ```text JavaScript: Date.now() // 1634814000000 Python: int(time.time() * 1000) // 1634814000000 Unix seconds × 1000: // 1634814 × 1000 = 1634814000000 ``` -------------------------------- ### GET /api/v3/account Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/api-families.md Retrieves account information and balances for the Spot account. ```APIDOC ## GET /api/v3/account ### Description Retrieves account information and balances for the Spot account. ### Method GET ### Endpoint https://api.binance.com/api/v3/account ``` -------------------------------- ### GET /api/v3/openOrders Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Retrieves all currently open orders for the account. ```APIDOC ## GET /api/v3/openOrders ### Description Retrieves all currently open orders for the account. ### Method GET ### Endpoint /api/v3/openOrders ### Parameters #### Query Parameters - **symbol** (string) - Optional - Trading pair - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response - Array of open order objects ``` -------------------------------- ### Disabled Body Parameters Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/configuration-reference.md Example showing how disabled parameters are represented in the request body. ```text # recvWindow is disabled, so not sent # recvWindow=5000 ``` -------------------------------- ### Commission Rates Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Example JSON response showing maker and taker commission rates for a given symbol. ```json { "symbol": "BTCUSDT", "standardCommission": { "maker": "0.001", "taker": "0.001" }, "taxCommission": { "maker": "0.0", "taker": "0.0" } } ``` -------------------------------- ### GET /fapi/v1/pmAccountOverview Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves a combined portfolio overview for the Portfolio Margin account, including asset values, liabilities, and margin levels. ```APIDOC ## GET /fapi/v1/pmAccountOverview ### Description Retrieves a combined portfolio overview for the Portfolio Margin account. ### Method GET ### Endpoint /fapi/v1/pmAccountOverview ### Parameters #### Query Parameters - **timestamp** (long) - Required - Current timestamp - **signature** (string) - Required - API signature - **recvWindow** (long) - Optional - Request timeout window ### Response #### Success Response (200) - **Total asset value** (decimal) - Total asset value in USDT - **Total liability** (decimal) - Total liability - **Total maintenance margin** (decimal) - Total maintenance margin - **Margin level** (decimal) - Current margin level - **Cross-collateral status** (boolean) - Status of cross-collateral ``` -------------------------------- ### GET /fapi/v1/fundingRate Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves the funding rate for a trading pair. ```APIDOC ## GET /fapi/v1/fundingRate ### Description Retrieves the funding rate for a trading pair. ### Method GET ### Endpoint /fapi/v1/fundingRate ### Parameters #### Query Parameters - **symbol** (string) - Required - Trading pair - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **limit** (integer) - Optional - Default 100, max 1000 - **recvWindow** (integer) - Optional - Max 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of funding rate objects ``` -------------------------------- ### GET /api/v3/openOrderList Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Retrieves all currently open OCO order lists. ```APIDOC ## GET /api/v3/openOrderList ### Description Retrieves all open OCO order lists. ### Method GET ### Endpoint /api/v3/openOrderList ### Parameters #### Query Parameters - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of open OCO order list objects ``` -------------------------------- ### GET /api/v3/myAllocations Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Retrieves a list of allocation objects based on the provided query parameters. ```APIDOC ## GET /api/v3/myAllocations ### Description Retrieves a list of allocation objects for the authenticated user. ### Method GET ### Endpoint /api/v3/myAllocations ### Parameters #### Query Parameters - **symbol** (string) - Optional - Trading pair - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **fromId** (integer) - Optional - Start from this ID - **limit** (integer) - Optional - Max 100 - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of allocation objects ``` -------------------------------- ### Get Coins Information Endpoint Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-wallet-api.md Endpoint for retrieving comprehensive configuration details for all supported coins. ```http GET /sapi/v1/capital/config/getall ``` -------------------------------- ### GET /sapi/v1/isolated/margin/forceLiquidationRecord Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Retrieves the liquidation records for isolated margin accounts. ```APIDOC ## GET /sapi/v1/isolated/margin/forceLiquidationRecord ### Description Retrieves the liquidation records for isolated margin accounts. ### Method GET ### Endpoint /sapi/v1/isolated/margin/forceLiquidationRecord ### Parameters #### Query Parameters - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **isolatedCreated** (boolean) - Optional - Only isolated created pairs - **symbol** (string) - Optional - Trading symbol - **size** (integer) - Optional - Page size (max 100) - **current** (integer) - Optional - Current page - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of liquidation records ``` -------------------------------- ### Get Account Information Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves current account balance and position details. Requires authentication. ```http GET /fapi/v3/account ``` -------------------------------- ### Get Open Positions Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves current position risk information. Requires authentication. ```http GET /fapi/v3/positionRisk ``` -------------------------------- ### Cross-Margin Transfer Response Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Example response structure for a successful cross-margin transfer. ```json { "tranId": 100000001 } ``` -------------------------------- ### Project File Structure Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/README.md Visual representation of the project directory layout. ```text output/ ├── README.md ← You are here ├── overview.md ← Project overview ├── api-families.md ← All 26 API families ├── authentication.md ← Auth and signing ├── configuration-reference.md ← Postman setup ├── types-and-enums.md ← Types and constants ├── endpoints-spot-api.md ← Spot trading (48 endpoints) ├── endpoints-margin-trading-api.md ← Margin trading (61 endpoints) ├── endpoints-wallet-api.md ← Wallet operations (49 endpoints) └── endpoints-futures-apis.md ← Futures/Options/Portfolio (254 endpoints) ``` -------------------------------- ### GET /api/v3/myTrades Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-spot-api.md Retrieves account trade history. ```APIDOC ## GET /api/v3/myTrades ### Description Retrieves account trade history. ### Method GET ### Endpoint /api/v3/myTrades ### Parameters #### Query Parameters - **symbol** (string) - Required - Trading pair - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **fromId** (integer) - Optional - Start from this trade ID - **limit** (integer) - Optional - Max 1000, default 500 - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - Array of trade objects #### Response Example [ { "symbol": "BNBBTC", "id": 28457, "orderId": 100234, "orderListId": -1, "price": "4.00000100", "qty": "12.00000000", "quoteQty": "48.000012", "commission": "10.10000000", "commissionAsset": "BNB", "time": 1499865549590, "isBuyer": true, "isMaker": false, "isBestMatch": true } ] ``` -------------------------------- ### GET /fapi/v3/account Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves the current account information, including balances, margin details, and position information. ```APIDOC ## GET /fapi/v3/account ### Description Retrieves the current account information, including balances, margin details, and position information. ### Method GET ### Endpoint /fapi/v3/account ### Parameters #### Query Parameters - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature - **recvWindow** (integer) - Optional - Max 60000ms ### Response #### Success Response (200) - **feeTier** (integer) - Fee tier - **canTrade** (boolean) - Whether trading is enabled - **canDeposit** (boolean) - Whether deposit is enabled - **canWithdraw** (boolean) - Whether withdrawal is enabled - **totalWalletBalance** (string) - Total wallet balance - **positions** (array) - List of open positions - **assets** (array) - List of assets ``` -------------------------------- ### GET /fapi/v1/pmPositionRisk Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves position information specifically for Portfolio Margin accounts, including contribution and maintenance ratios. ```APIDOC ## GET /fapi/v1/pmPositionRisk ### Description Retrieves an array of position objects with portfolio-specific risk metrics. ### Method GET ### Endpoint /fapi/v1/pmPositionRisk ### Parameters #### Query Parameters - **timestamp** (long) - Required - Current timestamp - **signature** (string) - Required - API signature - **recvWindow** (long) - Optional - Request timeout window - **symbol** (string) - Optional - Trading symbol ### Response #### Success Response (200) - **Cross-collateral position multiplier** (decimal) - Multiplier for cross-collateral - **Portfolio margin contribution** (decimal) - Contribution to portfolio margin - **Maintenance margin ratio** (decimal) - Maintenance margin ratio ``` -------------------------------- ### GET /fapi/v1/income Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves account income history. ```APIDOC ## GET /fapi/v1/income ### Description Retrieves account income history. ### Method GET ### Endpoint /fapi/v1/income ### Parameters #### Query Parameters - **symbol** (string) - Optional - Trading pair - **incomeType** (string) - Optional - Income type (e.g., TRANSFER, FUNDING_FEE) - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **limit** (integer) - Optional - Default 100, max 1000 - **recvWindow** (integer) - Optional - Max 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of income history objects ``` -------------------------------- ### GET /fapi/v1/userTrades Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-futures-apis.md Retrieves account trade history. ```APIDOC ## GET /fapi/v1/userTrades ### Description Retrieves account trade history. ### Method GET ### Endpoint /fapi/v1/userTrades ### Parameters #### Query Parameters - **symbol** (string) - Required - Trading pair - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **fromId** (integer) - Optional - Start from trade ID - **limit** (integer) - Optional - Default 500, max 1000 - **recvWindow** (integer) - Optional - Max 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of trade objects ``` -------------------------------- ### Sign and Execute Binance API Requests with cURL Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/authentication.md Uses OpenSSL to generate a signature and executes a POST request via cURL. ```bash #!/bin/bash API_KEY="vmPUZE6mv9SD5VNHk4HlWFsOa6aFbA" SECRET_KEY="NhqPtmdSJYdKjVHjA7PZj4Mge3R5YnhG" # Build query string QUERY="symbol=BTCUSDT&side=BUY&type=MARKET&quantity=0.001×tamp=$(date +%s)000" # Generate signature SIGNATURE=$(echo -n "$QUERY" | openssl dgst -sha256 -hmac "$SECRET_KEY" -hex | sed 's/^.* //') # Make request curl -X POST "https://api.binance.com/api/v3/order" \ -H "X-MBX-APIKEY: $API_KEY" \ -d "$QUERY&signature=$SIGNATURE" ``` -------------------------------- ### GET /api/v3/order Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/INDEX.md Queries the status of an existing order. ```APIDOC ## GET /api/v3/order ### Description Check an order's status by symbol and order ID. ### Method GET ### Endpoint /api/v3/order ### Authentication Requires API Key and Signature. ``` -------------------------------- ### View File Dependency Tree Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/INDEX.md Visual representation of the documentation file hierarchy and cross-references. ```text README.md ├── Links to all other documents ├── References overview.md for intro ├── References configuration-reference.md for setup └── References api-families.md for directory overview.md ├── Summarizes all 26 APIs └── References api-families.md for details api-families.md ├── References endpoints-spot-api.md ├── References endpoints-margin-trading-api.md ├── References endpoints-wallet-api.md ├── References endpoints-futures-apis.md └── Describes all 26 API families authentication.md └── Standalone (referenced by others) configuration-reference.md └── Standalone (referenced by README) endpoints-spot-api.md ├── References types-and-enums.md for types └── References authentication.md for signing endpoints-margin-trading-api.md ├── References types-and-enums.md for margin types └── References authentication.md for signing endpoints-wallet-api.md ├── References types-and-enums.md for network types └── References authentication.md for signing endpoints-futures-apis.md ├── References types-and-enums.md for leverage/margin └── References authentication.md for signing types-and-enums.md └── Referenced by all endpoint documents ``` -------------------------------- ### POST /api/v3/order Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/api-families.md Places a new order on the Spot market. ```APIDOC ## POST /api/v3/order ### Description Places a new order on the Spot market. ### Method POST ### Endpoint https://api.binance.com/api/v3/order ``` -------------------------------- ### GET /sapi/v1/capital/withdraw/history Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/api-families.md Retrieves the history of withdrawal transactions. ```APIDOC ## GET /sapi/v1/capital/withdraw/history ### Description Fetch the withdrawal history for the user account. ### Method GET ### Endpoint /sapi/v1/capital/withdraw/history ``` -------------------------------- ### POST /sapi/v3/asset/getUserAsset Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-wallet-api.md Queries the user's asset balances and optionally includes BTC valuation. ```APIDOC ## POST /sapi/v3/asset/getUserAsset ### Description Queries the user's asset balances and optionally includes BTC valuation. ### Method POST ### Endpoint /sapi/v3/asset/getUserAsset ### Parameters #### Query Parameters - **asset** (string) - Optional - Asset symbol - **needBtcValuation** (boolean) - Optional - Include BTC valuation - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **Array** (object) - Array of user asset objects with balances and valuation ``` -------------------------------- ### GET /sapi/v1/isolated/margin/account Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Retrieves details for an isolated margin account. ```APIDOC ## GET /sapi/v1/isolated/margin/account ### Description Get information about the isolated margin account. ### Method GET ### Endpoint /sapi/v1/isolated/margin/account ### Parameters #### Query Parameters - **symbols** (string) - Optional - Comma-separated trading symbols - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **totalAssetOfBtc** (string) - Total asset in BTC - **totalLiabilityOfBtc** (string) - Total liability in BTC - **totalNetAssetOfBtc** (string) - Total net asset in BTC - **assets** (array) - List of isolated margin assets #### Response Example { "totalAssetOfBtc": "0.00000000", "totalLiabilityOfBtc": "0.00000000", "totalNetAssetOfBtc": "0.00000000", "assets": [] } ``` -------------------------------- ### Implement Dynamic URL Selection Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/configuration-reference.md This script maps environment names to their respective base URL variables and retrieves the appropriate endpoint for the current request. ```javascript const environmentUrlKeyMap = { production: 'prod_url', // api.binance.com prod: 'prod_url', // api.binance.com testnet: 'testnet_url', // testnet.binance.vision demo: 'demo_url' // testnet.binance.vision }; const selectedUrlKey = environmentUrlKeyMap[normalizedEnvironment] || 'prod_url'; const selectedUrl = pm.variables.get(selectedUrlKey) || pm.variables.get('prod_url'); ``` -------------------------------- ### GET /sapi/v1/margin/transfer Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-margin-trading-api.md Retrieves the transfer history for cross-margin accounts. ```APIDOC ## GET /sapi/v1/margin/transfer ### Description Query the transfer history for cross-margin accounts. ### Method GET ### Endpoint /sapi/v1/margin/transfer ### Parameters #### Query Parameters - **asset** (string) - Optional - Asset symbol - **type** (string) - Optional - IN or OUT - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **current** (integer) - Optional - Current page (default 1) - **size** (integer) - Optional - Page size (default 10) - **archived** (string) - Optional - Include archived records - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ``` -------------------------------- ### GET /sapi/v1/asset/dribblet Source: https://github.com/binance/binance-api-postman/blob/master/_autodocs/endpoints-wallet-api.md Retrieves the dust log history for the user. ```APIDOC ## GET /sapi/v1/asset/dribblet ### Description Retrieves the dust log history for the user. ### Method GET ### Endpoint /sapi/v1/asset/dribblet ### Parameters #### Query Parameters - **startTime** (integer) - Optional - Start time in milliseconds - **endTime** (integer) - Optional - End time in milliseconds - **offset** (integer) - Optional - Pagination offset - **limit** (integer) - Optional - Number of records (default 20, max 100) - **recvWindow** (integer) - Optional - Valid for up to 60000ms - **timestamp** (integer) - Required - Current UTC milliseconds - **signature** (string) - Required - Request signature ### Response #### Success Response (200) - **totalTransferBtc** (string) - Total transferred BTC - **totalTransferBnb** (string) - Total transferred BNB - **transferHistory** (array) - List of transfer records ### Response Example { "totalTransferBtc": "0.00000000", "totalTransferBnb": "0.00000000", "transferHistory": [ { "operateTime": 1615985535000, "tranId": 38924206, "transferredAmount": "0.00132256", "serviceChargeAmount": "0.00002699", "uid": "62", "fromAsset": "ETH" } ] } ```