@clawhub-binance-skills-hub-9cf4002445
Use binance-cli for Binance Spot, Futures (USD-S), and Convert. Requires auth.
---
name: binance
description: Use binance-cli for Binance Spot, Futures (USD-S), and Convert. Requires auth.
metadata:
version: 1.1.0
author: Binance
openclaw:
requires:
bins:
- binance-cli
install:
- kind: node
package: '@binance/binance-cli'
bins: [binance-cli]
label: Install binance-cli (npm)
license: MIT
---
# Binance
Use `binance-cli` for Binance Spot, Futures (USD-S), and Convert. Requires auth.
> **PREREQUISITE:** Read [`auth.md`](./references/auth.md) for auth, global flags, and security rules.
## Helper Commands
| Command | Description |
|---------|-------------|
| [`algo`](./references/algo.md) | Algo Trading |
| [`alpha`](./references/alpha.md) | Alpha |
| [`c2c`](./references/c2c.md) | C2C |
| [`convert`](./references/convert.md) | Convert |
| [`copy-trading`](./references/copy-trading.md) | Copy Trading |
| [`crypto-loan`](./references/crypto-loan.md) | Crypto Loan |
| [`derivatives-options`](./references/derivatives-options.md) | Derivatives Trading (Options) |
| [`derivatives-portfolio-margin`](./references/derivatives-portfolio-margin.md) | Derivatives Trading (Portfolio Margin) |
| [`derivatives-portfolio-margin-pro`](./references/derivatives-portfolio-margin-pro.md) | Derivatives Trading (Portfolio Margin Pro) |
| [`dual-investment`](./references/dual-investment.md) | Dual Investment |
| [`fiat`](./references/fiat.md) | Fiat |
| [`futures-coin`](./references/futures-coin.md) | Derivatives Trading (COIN-M Futures) |
| [`futures-usds`](./references/futures-usds.md) | Derivatives Trading (USDS-M Futures) |
| [`gift-card`](./references/gift-card.md) | Gift Card |
| [`margin-trading`](./references/margin-trading.md) | Margin Trading |
| [`mining`](./references/mining.md) | Mining |
| [`pay`](./references/pay.md) | Pay |
| [`rebate`](./references/rebate.md) | Rebate |
| [`simple-earn`](./references/simple-earn.md) | Simple Earn |
| [`spot`](./references/spot.md) | Spot Trading |
| [`staking`](./references/staking.md) | Staking |
| [`sub-account`](./references/sub-account.md) | Sub Account |
| [`vip-loan`](./references/vip-loan.md) | VIP Loan |
| [`wallet`](./references/wallet.md) | Wallet |
## Notes
- ⚠️ **Prod transactions** — always ask user to type `CONFIRM` before executing.
- Append `--profile <name>` to any command to use a non-active profile.
- All authenticated endpoints accept optional `--recvWindow <ms>` (max 60 000).
- Timestamps (`startTime`, `endTime`) are Unix ms.
- For endpoints not listed in the skill, use `binance-cli request (GET|POST|PUT...) <url> [--signed]`. Any Parameters can be added to the request (e.g: `--param1 value --param2 value`).
FILE:LICENSE.md
MIT License
Copyright (c) 2026 Binance
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FILE:CHANGELOG.md
# Changelog
## 1.1.0 - 2026-04-11
- Added support for the following products:
- Algo Trading
- Alpha
- C2C
- Copy Trading
- Crypto Loan
- Derivatives Trading (COIN-M Futures)
- Derivatives Trading (Options)
- Derivatives Trading (Portfolio Margin)
- Derivatives Trading (Portfolio Margin Pro)
- Dual Investment
- Fiat
- Gift Card
- Margin Trading
- Mining
- Pay
- Rebate
- Simple Earn
- Staking
- Sub Account
- VIP Loan
- Wallet
## 1.0.1 - 2026-04-09
- Renamed BINANCE_API_SECRET to BINANCE_SECRET_KEY
## 1.0.0 - 2026-04-08
- Initial release
FILE:references/pay.md
## Pay (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-pay-trade-history | [`start-time` `end-time` `limit`] | Get Pay Trade History |
FILE:references/alpha.md
## Market Data
| Endpoint | Key params | Description |
|---|---|---|
| aggregated-trades | `symbol` [`from-id` `start-time` `end-time` `limit`] | Aggregated Trades |
| get-exchange-info | [] | Get Exchange Info |
| klines | `symbol` `interval` [`limit` `start-time` `end-time`] | Klines (Candlestick Data) |
| ticker | `symbol` [] | Ticker (24hr Price Statistics) |
| token-list | [] | Token List |
FILE:references/gift-card.md
## Market Data (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| create-a-dual-token-gift-card | `base-token` `face-token` `base-token-amount` [] | Create a dual-token gift card(fixed value, discount feature) |
| create-a-single-token-gift-card | `token` `amount` [] | Create a single-token gift card |
| fetch-rsa-public-key | [] | Fetch RSA Public Key |
| fetch-token-limit | `base-token` [] | Fetch Token Limit |
| redeem-a-binance-gift-card | `code` [`external-uid`] | Redeem a Binance Gift Card |
| verify-binance-gift-card-by-gift-card-number | `reference-no` [] | Verify Binance Gift Card by Gift Card Number |
FILE:references/derivatives-portfolio-margin.md
## Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-balance | [`asset`] | Account Balance |
| account-information | [] | Account Information |
| bnb-transfer | `amount` `transfer-side` [] | BNB transfer |
| change-auto-repay-futures-status | `auto-repay` [] | Change Auto-repay-futures Status |
| change-cm-initial-leverage | `symbol` `leverage` [] | Change CM Initial Leverage |
| change-cm-position-mode | `dual-side-position` [] | Change CM Position Mode |
| change-um-initial-leverage | `symbol` `leverage` [] | Change UM Initial Leverage |
| change-um-position-mode | `dual-side-position` [] | Change UM Position Mode |
| cm-notional-and-leverage-brackets | [`symbol`] | CM Notional and Leverage Brackets |
| fund-auto-collection | [] | Fund Auto-collection |
| fund-collection-by-asset | `asset` [] | Fund Collection by Asset |
| get-auto-repay-futures-status | [] | Get Auto-repay-futures Status |
| get-cm-account-detail | [] | Get CM Account Detail |
| get-cm-current-position-mode | [] | Get CM Current Position Mode |
| get-cm-income-history | [`symbol` `income-type` `start-time` `end-time` `page` `limit`] | Get CM Income History |
| get-download-id-for-um-futures-order-history | `start-time` `end-time` [] | Get Download Id For UM Futures Order History |
| get-download-id-for-um-futures-trade-history | `start-time` `end-time` [] | Get Download Id For UM Futures Trade History |
| get-download-id-for-um-futures-transaction-history | `start-time` `end-time` [] | Get Download Id For UM Futures Transaction History |
| get-margin-borrow-loan-interest-history | [`asset` `start-time` `end-time` `current` `size` `archived`] | Get Margin Borrow/Loan Interest History |
| get-um-account-detail | [] | Get UM Account Detail |
| get-um-account-detail-v2 | [] | Get UM Account Detail V2 |
| get-um-current-position-mode | [] | Get UM Current Position Mode |
| get-um-futures-order-download-link-by-id | `download-id` [] | Get UM Futures Order Download Link by Id |
| get-um-futures-trade-download-link-by-id | `download-id` [] | Get UM Futures Trade Download Link by Id |
| get-um-futures-transaction-download-link-by-id | `download-id` [] | Get UM Futures Transaction Download Link by Id |
| get-um-income-history | [`symbol` `income-type` `start-time` `end-time` `page` `limit`] | Get UM Income History |
| get-user-commission-rate-for-cm | `symbol` [] | Get User Commission Rate for CM |
| get-user-commission-rate-for-um | `symbol` [] | Get User Commission Rate for UM |
| margin-max-borrow | `asset` [] | Margin Max Borrow |
| portfolio-margin-um-trading-quantitative-rules-indicators | [`symbol`] | Portfolio Margin UM Trading Quantitative Rules Indicators |
| query-cm-position-information | [`margin-asset` `pair`] | Query CM Position Information |
| query-margin-loan-record | `asset` [`tx-id` `start-time` `end-time` `current` `size` `archived`] | Query Margin Loan Record |
| query-margin-max-withdraw | `asset` [] | Query Margin Max Withdraw |
| query-margin-repay-record | `asset` [`tx-id` `start-time` `end-time` `current` `size` `archived`] | Query Margin repay Record |
| query-portfolio-margin-negative-balance-interest-history | [`asset` `start-time` `end-time` `size`] | Query Portfolio Margin Negative Balance Interest History |
| query-um-position-information | [`symbol`] | Query UM Position Information |
| query-user-negative-balance-auto-exchange-record | `start-time` `end-time` [] | Query User Negative Balance Auto Exchange Record |
| query-user-rate-limit | [] | Query User Rate Limit |
| repay-futures-negative-balance | [] | Repay futures Negative Balance |
| um-futures-account-configuration | [] | UM Futures Account Configuration |
| um-futures-symbol-configuration | [`symbol`] | UM Futures Symbol Configuration |
| um-notional-and-leverage-brackets | [`symbol`] | UM Notional and Leverage Brackets |
## Market Data
| Endpoint | Key params | Description |
|---|---|---|
| test-connectivity | [] | Test Connectivity |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| cancel-all-cm-open-conditional-orders | `symbol` [] | Cancel All CM Open Conditional Orders |
| cancel-all-cm-open-orders | `symbol` [] | Cancel All CM Open Orders |
| cancel-all-um-open-conditional-orders | `symbol` [] | Cancel All UM Open Conditional Orders |
| cancel-all-um-open-orders | `symbol` [] | Cancel All UM Open Orders |
| cancel-cm-conditional-order | `symbol` [`strategy-id` `new-client-strategy-id`] | Cancel CM Conditional Order |
| cancel-cm-order | `symbol` [`order-id` `orig-client-order-id`] | Cancel CM Order |
| cancel-margin-account-all-open-orders-on-a-symbol | `symbol` [] | Cancel Margin Account All Open Orders on a Symbol |
| cancel-margin-account-oco-orders | `symbol` [`order-list-id` `list-client-order-id` `new-client-order-id`] | Cancel Margin Account OCO Orders |
| cancel-margin-account-order | `symbol` [`order-id` `orig-client-order-id` `new-client-order-id`] | Cancel Margin Account Order |
| cancel-um-conditional-order | `symbol` [`strategy-id` `new-client-strategy-id`] | Cancel UM Conditional Order |
| cancel-um-order | `symbol` [`order-id` `orig-client-order-id`] | Cancel UM Order |
| cm-account-trade-list | [`symbol` `pair` `start-time` `end-time` `from-id` `limit`] | CM Account Trade List |
| cm-position-adl-quantile-estimation | [`symbol`] | CM Position ADL Quantile Estimation |
| get-um-futures-bnb-burn-status | [] | Get UM Futures BNB Burn Status |
| margin-account-borrow | `asset` `amount` [] | Margin Account Borrow |
| margin-account-new-oco | `symbol` `side` `quantity` `price` `stop-price` [`list-client-order-id` `limit-client-order-id` `limit-iceberg-qty` `stop-client-order-id` `stop-limit-price` `stop-iceberg-qty` `stop-limit-time-in-force` `new-order-resp-type` `side-effect-type`] | Margin Account New OCO |
| margin-account-repay | `asset` `amount` [] | Margin Account Repay |
| margin-account-repay-debt | `asset` [`amount` `specify-repay-assets`] | Margin Account Repay Debt |
| margin-account-trade-list | `symbol` [`order-id` `start-time` `end-time` `from-id` `limit`] | Margin Account Trade List |
| modify-cm-order | `symbol` `side` `quantity` `price` [`order-id` `orig-client-order-id` `price-match`] | Modify CM Order |
| modify-um-order | `symbol` `side` `quantity` `price` [`order-id` `orig-client-order-id` `price-match`] | Modify UM Order |
| new-cm-conditional-order | `symbol` `side` `strategy-type` [`position-side` `time-in-force` `quantity` `reduce-only` `price` `working-type` `price-protect` `new-client-strategy-id` `stop-price` `activation-price` `callback-rate`] | New CM Conditional Order |
| new-cm-order | `symbol` `side` `type` [`position-side` `time-in-force` `quantity` `reduce-only` `price` `price-match` `new-client-order-id` `new-order-resp-type`] | New CM Order |
| new-margin-order | `symbol` `side` `type` [`quantity` `quote-order-qty` `price` `stop-price` `new-client-order-id` `new-order-resp-type` `iceberg-qty` `side-effect-type` `time-in-force` `self-trade-prevention-mode` `auto-repay-at-cancel`] | New Margin Order |
| new-um-conditional-order | `symbol` `side` `strategy-type` [`position-side` `time-in-force` `quantity` `reduce-only` `price` `working-type` `price-protect` `new-client-strategy-id` `stop-price` `activation-price` `callback-rate` `price-match` `self-trade-prevention-mode` `good-till-date`] | New UM Conditional Order |
| new-um-order | `symbol` `side` `type` [`position-side` `time-in-force` `quantity` `reduce-only` `price` `new-client-order-id` `new-order-resp-type` `price-match` `self-trade-prevention-mode` `good-till-date`] | New UM Order |
| query-all-cm-conditional-orders | [`symbol` `strategy-id` `start-time` `end-time` `limit`] | Query All CM Conditional Orders |
| query-all-cm-orders | `symbol` [`pair` `order-id` `start-time` `end-time` `limit`] | Query All CM Orders |
| query-all-current-cm-open-conditional-orders | [`symbol`] | Query All Current CM Open Conditional Orders |
| query-all-current-cm-open-orders | [`symbol` `pair`] | Query All Current CM Open Orders |
| query-all-current-um-open-conditional-orders | [`symbol`] | Query All Current UM Open Conditional Orders |
| query-all-current-um-open-orders | [`symbol`] | Query All Current UM Open Orders |
| query-all-margin-account-orders | `symbol` [`order-id` `start-time` `end-time` `limit`] | Query All Margin Account Orders |
| query-all-um-conditional-orders | [`symbol` `strategy-id` `start-time` `end-time` `limit`] | Query All UM Conditional Orders |
| query-all-um-orders | `symbol` [`order-id` `start-time` `end-time` `limit`] | Query All UM Orders |
| query-cm-conditional-order-history | `symbol` [`strategy-id` `new-client-strategy-id`] | Query CM Conditional Order History |
| query-cm-modify-order-history | `symbol` [`order-id` `orig-client-order-id` `start-time` `end-time` `limit`] | Query CM Modify Order History |
| query-cm-order | `symbol` [`order-id` `orig-client-order-id`] | Query CM Order |
| query-current-cm-open-conditional-order | `symbol` [`strategy-id` `new-client-strategy-id`] | Query Current CM Open Conditional Order |
| query-current-cm-open-order | `symbol` [`order-id` `orig-client-order-id`] | Query Current CM Open Order |
| query-current-margin-open-order | `symbol` [] | Query Current Margin Open Order |
| query-current-um-open-conditional-order | `symbol` [`strategy-id` `new-client-strategy-id`] | Query Current UM Open Conditional Order |
| query-current-um-open-order | `symbol` [`order-id` `orig-client-order-id`] | Query Current UM Open Order |
| query-margin-account-order | `symbol` [`order-id` `orig-client-order-id`] | Query Margin Account Order |
| query-margin-accounts-all-oco | [`from-id` `start-time` `end-time` `limit`] | Query Margin Account\'s all OCO |
| query-margin-accounts-oco | [`order-list-id` `orig-client-order-id`] | Query Margin Account\'s OCO |
| query-margin-accounts-open-oco | [] | Query Margin Account\'s Open OCO |
| query-um-conditional-order-history | `symbol` [`strategy-id` `new-client-strategy-id`] | Query UM Conditional Order History |
| query-um-modify-order-history | `symbol` [`order-id` `orig-client-order-id` `start-time` `end-time` `limit`] | Query UM Modify Order History |
| query-um-order | `symbol` [`order-id` `orig-client-order-id`] | Query UM Order |
| query-users-cm-force-orders | [`symbol` `auto-close-type` `start-time` `end-time` `limit`] | Query User\'s CM Force Orders |
| query-users-margin-force-orders | [`start-time` `end-time` `current` `size`] | Query User\'s Margin Force Orders |
| query-users-um-force-orders | [`symbol` `auto-close-type` `start-time` `end-time` `limit`] | Query User\'s UM Force Orders |
| toggle-bnb-burn-on-um-futures-trade | `fee-burn` [] | Toggle BNB Burn On UM Futures Trade |
| um-account-trade-list | `symbol` [`start-time` `end-time` `from-id` `limit`] | UM Account Trade List |
| um-position-adl-quantile-estimation | [`symbol`] | UM Position ADL Quantile Estimation |
## User Data Streams
| Endpoint | Key params | Description |
|---|---|---|
| close-user-data-stream | [] | Close User Data Stream |
| keepalive-user-data-stream | [] | Keepalive User Data Stream |
| start-user-data-stream | [] | Start User Data Stream |
### Enums
**auto-close-type:** `LIQUIDATION` `ADL`
**new-order-resp-type:** `ACK` `RESULT`
**position-side:** `BOTH` `LONG` `SHORT`
**price-match:** `NONE` `OPPONENT` `OPPONENT_5` `OPPONENT_10` `OPPONENT_20` `QUEUE` `QUEUE_5` `QUEUE_10` `QUEUE_20`
**self-trade-prevention-mode:** `NONE` `EXPIRE_TAKER` `EXPIRE_BOTH` `EXPIRE_MAKER`
**side-effect-type:** `NO_SIDE_EFFECT` `MARGIN_BUY` `AUTO_REPAY`
**side:** `BUY` `SELL`
**stop-limit-time-in-force:** `GTC` `IOC` `FOK`
**strategy-type:** `STOP` `STOP_MARKET` `LIMIT_MAKER` `TAKE_PROFIT` `TAKE_PROFIT_MARKET` `TRAILING_STOP_MARKET`
**time-in-force:** `GTC` `IOC` `FOK` `GTX`
**type:** `LIMIT` `MARKET`
**working-type:** `MARK_PRICE`
FILE:references/copy-trading.md
## Future Copy Trading (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-futures-lead-trader-status | [] | Get Futures Lead Trader Status |
| get-futures-lead-trading-symbol-whitelist | [] | Get Futures Lead Trading Symbol Whitelist |
FILE:references/futures-usds.md
## Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-information-v2 | [] | Account Information V2 |
| account-information-v3 | [] | Account Information V3 |
| futures-account-balance-v2 | [] | Futures Account Balance V2 |
| futures-account-balance-v3 | [] | Futures Account Balance V3 |
| futures-account-configuration | [] | Futures Account Configuration |
| futures-trading-quantitative-rules-indicators | [`symbol`] | Futures Trading Quantitative Rules Indicators |
| get-bnb-burn-status | [] | Get BNB Burn Status |
| get-current-multi-assets-mode | [] | Get Current Multi-Assets Mode |
| get-current-position-mode | [] | Get Current Position Mode |
| get-download-id-for-futures-order-history | `start-time` `end-time` [] | Get Download Id For Futures Order History |
| get-download-id-for-futures-trade-history | `start-time` `end-time` [] | Get Download Id For Futures Trade History |
| get-download-id-for-futures-transaction-history | `start-time` `end-time` [] | Get Download Id For Futures Transaction History |
| get-futures-order-history-download-link-by-id | `download-id` [] | Get Futures Order History Download Link by Id |
| get-futures-trade-download-link-by-id | `download-id` [] | Get Futures Trade Download Link by Id |
| get-futures-transaction-history-download-link-by-id | `download-id` [] | Get Futures Transaction History Download Link by Id |
| get-income-history | [`symbol` `income-type` `start-time` `end-time` `page` `limit`] | Get Income History |
| notional-and-leverage-brackets | [`symbol`] | Notional and Leverage Brackets |
| query-user-rate-limit | [] | Query User Rate Limit |
| symbol-configuration | [`symbol`] | Symbol Configuration |
| toggle-bnb-burn-on-futures-trade | `fee-burn` [] | Toggle BNB Burn On Futures Trade |
| user-commission-rate | `symbol` [] | User Commission Rate |
## Convert (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| accept-the-offered-quote | `quote-id` [] | Accept the offered quote |
| list-all-convert-pairs | [`from-asset` `to-asset`] | List All Convert Pairs |
| order-status | [`order-id` `quote-id`] | Order status |
| send-quote-request | `from-asset` `to-asset` [`from-amount` `to-amount` `valid-time`] | Send Quote Request |
## Market Data
| Endpoint | Key params | Description |
|---|---|---|
| adl-risk | [`symbol`] | ADL Risk |
| basis | `pair` `contract-type` `period` `limit` [`start-time` `end-time`] | Basis |
| check-server-time | [] | Check Server Time |
| composite-index-symbol-information | [`symbol`] | Composite Index Symbol Information |
| compressed-aggregate-trades-list | `symbol` [`from-id` `start-time` `end-time` `limit`] | Compressed/Aggregate Trades List |
| continuous-contract-kline-candlestick-data | `pair` `contract-type` `interval` [`start-time` `end-time` `limit`] | Continuous Contract Kline/Candlestick Data |
| exchange-information | [] | Exchange Information |
| get-funding-rate-history | [`symbol` `start-time` `end-time` `limit`] | Get Funding Rate History |
| get-funding-rate-info | [] | Get Funding Rate Info |
| index-price-kline-candlestick-data | `pair` `interval` [`start-time` `end-time` `limit`] | Index Price Kline/Candlestick Data |
| kline-candlestick-data | `symbol` `interval` [`start-time` `end-time` `limit`] | Kline/Candlestick Data |
| long-short-ratio | `symbol` `period` [`limit` `start-time` `end-time`] | Long/Short Ratio |
| mark-price | [`symbol`] | Mark Price |
| mark-price-kline-candlestick-data | `symbol` `interval` [`start-time` `end-time` `limit`] | Mark Price Kline/Candlestick Data |
| multi-assets-mode-asset-index | [`symbol`] | Multi-Assets Mode Asset Index |
| old-trades-lookup | `symbol` [`limit` `from-id`] | Old Trades Lookup |
| open-interest | `symbol` [] | Open Interest |
| open-interest-statistics | `symbol` `period` [`limit` `start-time` `end-time`] | Open Interest Statistics |
| order-book | `symbol` [`limit`] | Order Book |
| premium-index-kline-data | `symbol` `interval` [`start-time` `end-time` `limit`] | Premium index Kline Data |
| quarterly-contract-settlement-price | `pair` [] | Quarterly Contract Settlement Price |
| query-index-price-constituents | `symbol` [] | Query Index Price Constituents |
| query-insurance-fund-balance-snapshot | [`symbol`] | Query Insurance Fund Balance Snapshot |
| recent-trades-list | `symbol` [`limit`] | Recent Trades List |
| rpi-order-book | `symbol` [`limit`] | RPI Order Book |
| symbol-order-book-ticker | [`symbol`] | Symbol Order Book Ticker |
| symbol-price-ticker | [`symbol`] | Symbol Price Ticker |
| symbol-price-ticker-v2 | [`symbol`] | Symbol Price Ticker V2 |
| taker-buy-sell-volume | `symbol` `period` [`limit` `start-time` `end-time`] | Taker Buy/Sell Volume |
| test-connectivity | [] | Test Connectivity |
| ticker24hr-price-change-statistics | [`symbol`] | 24hr Ticker Price Change Statistics |
| top-trader-long-short-ratio-accounts | `symbol` `period` [`limit` `start-time` `end-time`] | Top Trader Long/Short Ratio (Accounts) |
| top-trader-long-short-ratio-positions | `symbol` `period` [`limit` `start-time` `end-time`] | Top Trader Long/Short Ratio (Positions) |
| trading-schedule | [] | Trading Schedule |
## Portfolio Margin Endpoints (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| classic-portfolio-margin-account-information | `asset` [] | Classic Portfolio Margin Account Information |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-trade-list | `symbol` [`order-id` `start-time` `end-time` `from-id` `limit`] | Account Trade List |
| all-orders | `symbol` [`order-id` `start-time` `end-time` `limit`] | All Orders |
| auto-cancel-all-open-orders | `symbol` `countdown-time` [] | Auto-Cancel All Open Orders |
| cancel-algo-order | [`algo-id` `client-algo-id`] | Cancel Algo Order |
| cancel-all-algo-open-orders | `symbol` [] | Cancel All Algo Open Orders |
| cancel-all-open-orders | `symbol` [] | Cancel All Open Orders |
| cancel-multiple-orders | `symbol` [`order-id-list` `orig-client-order-id-list`] | Cancel Multiple Orders |
| cancel-order | `symbol` [`order-id` `orig-client-order-id`] | Cancel Order |
| change-initial-leverage | `symbol` `leverage` [] | Change Initial Leverage |
| change-margin-type | `symbol` `margin-type` [] | Change Margin Type |
| change-multi-assets-mode | `multi-assets-margin` [] | Change Multi-Assets Mode |
| change-position-mode | `dual-side-position` [] | Change Position Mode |
| current-all-algo-open-orders | [`algo-type` `symbol` `algo-id`] | Current All Algo Open Orders |
| current-all-open-orders | [`symbol`] | Current All Open Orders |
| futures-tradfi-perps-contract | [] | Futures TradFi Perps Contract |
| get-order-modify-history | `symbol` [`order-id` `orig-client-order-id` `start-time` `end-time` `limit`] | Get Order Modify History |
| get-position-margin-change-history | `symbol` [`type` `start-time` `end-time` `limit`] | Get Position Margin Change History |
| modify-isolated-position-margin | `symbol` `amount` `type` [`position-side`] | Modify Isolated Position Margin |
| modify-multiple-orders | `batch-orders` [] | Modify Multiple Orders |
| modify-order | `symbol` `side` `quantity` `price` [`order-id` `orig-client-order-id` `price-match`] | Modify Order |
| new-algo-order | `algo-type` `symbol` `side` `type` [`position-side` `time-in-force` `quantity` `price` `trigger-price` `working-type` `price-match` `close-position` `price-protect` `reduce-only` `activate-price` `callback-rate` `client-algo-id` `new-order-resp-type` `self-trade-prevention-mode` `good-till-date`] | New Algo Order |
| new-order | `symbol` `side` `type` [`position-side` `time-in-force` `quantity` `reduce-only` `price` `new-client-order-id` `new-order-resp-type` `price-match` `self-trade-prevention-mode` `good-till-date`] | New Order |
| place-multiple-orders | `batch-orders` [] | Place Multiple Orders |
| position-adl-quantile-estimation | [`symbol`] | Position ADL Quantile Estimation |
| position-information-v2 | [`symbol`] | Position Information V2 |
| position-information-v3 | [`symbol`] | Position Information V3 |
| query-algo-order | [`algo-id` `client-algo-id`] | Query Algo Order |
| query-all-algo-orders | `symbol` [`algo-id` `start-time` `end-time` `page` `limit`] | Query All Algo Orders |
| query-current-open-order | `symbol` [`order-id` `orig-client-order-id`] | Query Current Open Order |
| query-order | `symbol` [`order-id` `orig-client-order-id`] | Query Order |
| test-order | `symbol` `side` `type` [`position-side` `time-in-force` `quantity` `reduce-only` `price` `new-client-order-id` `stop-price` `close-position` `activation-price` `callback-rate` `working-type` `price-protect` `new-order-resp-type` `price-match` `self-trade-prevention-mode` `good-till-date`] | Test Order |
| users-force-orders | [`symbol` `auto-close-type` `start-time` `end-time` `limit`] | User\'s Force Orders |
## User Data Streams
| Endpoint | Key params | Description |
|---|---|---|
| close-user-data-stream | [] | Close User Data Stream |
| keepalive-user-data-stream | [] | Keepalive User Data Stream |
| start-user-data-stream | [] | Start User Data Stream |
### Enums
**auto-close-type:** `LIQUIDATION` `ADL`
**contract-type:** `PERPETUAL` `CURRENT_MONTH` `NEXT_MONTH` `CURRENT_QUARTER` `NEXT_QUARTER` `PERPETUAL_DELIVERING`
**interval:** `1m` `3m` `5m` `15m` `30m` `1h` `2h` `4h` `6h` `8h` `12h` `1d` `3d` `1w` `1M`
**margin-type:** `ISOLATED` `CROSSED`
**new-order-resp-type:** `ACK` `RESULT`
**period:** `5m` `15m` `30m` `1h` `2h` `4h` `6h` `12h` `1d`
**position-side:** `BOTH` `LONG` `SHORT`
**price-match:** `NONE` `OPPONENT` `OPPONENT_5` `OPPONENT_10` `OPPONENT_20` `QUEUE` `QUEUE_5` `QUEUE_10` `QUEUE_20`
**self-trade-prevention-mode:** `EXPIRE_TAKER` `EXPIRE_BOTH` `EXPIRE_MAKER`
**side:** `BUY` `SELL`
**time-in-force:** `GTC` `IOC` `FOK` `GTX` `GTD` `RPI`
**working-type:** `MARK_PRICE` `CONTRACT_PRICE`
FILE:references/wallet.md
## Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-api-trading-status | [] | Account API Trading Status |
| account-info | [] | Account info |
| account-status | [] | Account Status |
| daily-account-snapshot | `type` [`start-time` `end-time` `limit`] | Daily Account Snapshot |
| disable-fast-withdraw-switch | [] | Disable Fast Withdraw Switch |
| enable-fast-withdraw-switch | [] | Enable Fast Withdraw Switch |
| get-api-key-permission | [] | Get API Key Permission |
## Asset (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| asset-detail | [`asset`] | Asset Detail |
| asset-dividend-record | [`asset` `start-time` `end-time` `limit`] | Asset Dividend Record |
| dust-convert | `asset` [`client-id` `target-asset` `third-party-client-id` `dust-quota-asset-to-target-asset-price`] | Dust Convert |
| dust-convertible-assets | `target-asset` [`dust-quota-asset-to-target-asset-price`] | Dust Convertible Assets |
| dust-transfer | `asset` [`account-type`] | Dust Transfer |
| dustlog | [`account-type` `start-time` `end-time`] | DustLog |
| funding-wallet | [`asset` `need-btc-valuation`] | Funding Wallet |
| get-assets-that-can-be-converted-into-bnb | [`account-type`] | Get Assets That Can Be Converted Into BNB |
| get-cloud-mining-payment-and-refund-history | `start-time` `end-time` [`tran-id` `client-tran-id` `asset` `current` `size`] | Get Cloud-Mining payment and refund history |
| get-open-symbol-list | [] | Get Open Symbol List |
| query-user-delegation-history | `email` `start-time` `end-time` [`type` `asset` `current` `size`] | Query User Delegation History(For Master Account) |
| query-user-universal-transfer-history | `type` [`start-time` `end-time` `current` `size` `from-symbol` `to-symbol`] | Query User Universal Transfer History |
| query-user-wallet-balance | [`quote-asset`] | Query User Wallet Balance |
| toggle-bnb-burn-on-spot-trade-and-margin-interest | [`spot-bnb-burn` `interest-bnb-burn`] | Toggle BNB Burn On Spot Trade And Margin Interest |
| trade-fee | [`symbol`] | Trade Fee |
| user-asset | [`asset` `need-btc-valuation`] | User Asset |
| user-universal-transfer | `type` `asset` `amount` [`from-symbol` `to-symbol`] | User Universal Transfer |
## Capital (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| all-coins-information | [] | All Coins\' Information |
| deposit-address | `coin` [`network` `amount`] | Deposit Address(supporting network) |
| deposit-history | [`include-source` `coin` `status` `start-time` `end-time` `offset` `limit` `tx-id`] | Deposit History (supporting network) |
| fetch-deposit-address-list-with-network | `coin` [`network`] | Fetch deposit address list with network |
| fetch-withdraw-address-list | [] | Fetch withdraw address list |
| fetch-withdraw-quota | [] | Fetch withdraw quota |
| one-click-arrival-deposit-apply | [`deposit-id` `tx-id` `sub-account-id` `sub-user-id`] | One click arrival deposit apply (for expired address deposit) |
| withdraw | `coin` `address` `amount` [`withdraw-order-id` `network` `address-tag` `transaction-fee-flag` `name` `wallet-type`] | Withdraw |
| withdraw-history | [`coin` `withdraw-order-id` `status` `offset` `limit` `id-list` `start-time` `end-time`] | Withdraw History (supporting network) |
## Others
| Endpoint | Key params | Description |
|---|---|---|
| get-symbols-delist-schedule-for-spot | [] | Get symbols delist schedule for spot |
| system-status | [] | System Status (System) |
## Travel Rule (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| broker-withdraw | `address` `coin` `amount` `withdraw-order-id` `questionnaire` `originator-pii` `signature` [`address-tag` `network` `address-name` `transaction-fee-flag` `wallet-type`] | Broker Withdraw (for brokers of local entities that require travel rule) |
| check-questionnaire-requirements | [] | Check Questionnaire Requirements (for local entities that require travel rule) (supporting network) |
| deposit-history-travel-rule | [`tr-id` `tx-id` `tran-id` `network` `coin` `travel-rule-status` `pending-questionnaire` `start-time` `end-time` `offset` `limit`] | Deposit History (for local entities that required travel rule) (supporting network) |
| deposit-history-v2 | [`deposit-id` `tx-id` `network` `coin` `retrieve-questionnaire` `start-time` `end-time` `offset` `limit`] | Deposit History V2 (for local entities that required travel rule) (supporting network) |
| fetch-address-verification-list | [] | Fetch address verification list |
| submit-deposit-questionnaire | `sub-account-id` `deposit-id` `questionnaire` `beneficiary-pii` `signature` [`network` `coin` `amount` `address` `address-tag`] | Submit Deposit Questionnaire (For local entities that require travel rule) (supporting network) |
| submit-deposit-questionnaire-travel-rule | `tran-id` `questionnaire` [] | Submit Deposit Questionnaire (For local entities that require travel rule) (supporting network) |
| submit-deposit-questionnaire-v2 | `deposit-id` `questionnaire` [] | Submit Deposit Questionnaire V2 (For local entities that require travel rule) (supporting network) |
| vasp-list | [] | VASP list (for local entities that require travel rule) (supporting network) |
| withdraw-history-v1 | [`tr-id` `tx-id` `withdraw-order-id` `network` `coin` `travel-rule-status` `offset` `limit` `start-time` `end-time`] | Withdraw History (for local entities that require travel rule) (supporting network) |
| withdraw-history-v2 | [`tr-id` `tx-id` `withdraw-order-id` `network` `coin` `travel-rule-status` `offset` `limit` `start-time` `end-time`] | Withdraw History V2 (for local entities that require travel rule) (supporting network) |
| withdraw-travel-rule | `coin` `address` `amount` `questionnaire` [`withdraw-order-id` `network` `address-tag` `transaction-fee-flag` `name` `wallet-type`] | Withdraw (for local entities that require travel rule) |
FILE:references/fiat.md
## Fiat (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| deposit | `currency` `api-payment-method` `amount` [ `ext`] | Deposit |
| fiat-withdraw | `currency` `api-payment-method` `amount` `account-info` [ `ext`] | Fiat Withdraw |
| get-fiat-deposit-withdraw-history | `transaction-type` [`begin-time` `end-time` `page` `rows`] | Get Fiat Deposit/Withdraw History |
| get-fiat-payments-history | `transaction-type` [`begin-time` `end-time` `page` `rows`] | Get Fiat Payments History |
| get-order-detail | `order-no` [] | Get Order Detail |
FILE:references/dual-investment.md
## Market Data (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-dual-investment-product-list | `option-type` `exercised-coin` `invest-coin` [`page-size` `page-index`] | Get Dual Investment product list |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| change-auto-compound-status | `position-id` [`auto-compound-plan`] | Change Auto-Compound status |
| check-dual-investment-accounts | [] | Check Dual Investment accounts |
| get-dual-investment-positions | [`status` `page-size` `page-index`] | Get Dual Investment positions |
| subscribe-dual-investment-products | `id` `order-id` `deposit-amount` `auto-compound-plan` [] | Subscribe Dual Investment products |
FILE:references/algo.md
## Future Algo (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| cancel-algo-order-future-algo | `algo-id` [] | Cancel Algo Order |
| query-current-algo-open-orders-future-algo | [] | Query Current Algo Open Orders |
| query-historical-algo-orders-future-algo | [`symbol` `side` `start-time` `end-time` `page` `page-size`] | Query Historical Algo Orders |
| query-sub-orders-future-algo | `algo-id` [`page` `page-size`] | Query Sub Orders |
| time-weighted-average-price-future-algo | `symbol` `side` `quantity` `duration` [`position-side` `client-algo-id` `reduce-only` `limit-price`] | Time-Weighted Average Price(Twap) New Order |
| volume-participation-future-algo | `symbol` `side` `quantity` `urgency` [`position-side` `client-algo-id` `reduce-only` `limit-price`] | Volume Participation New Order |
## Spot Algo (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| cancel-algo-order-spot-algo | `algo-id` [] | Cancel Algo Order |
| query-current-algo-open-orders-spot-algo | [] | Query Current Algo Open Orders |
| query-historical-algo-orders-spot-algo | [`symbol` `side` `start-time` `end-time` `page` `page-size`] | Query Historical Algo Orders |
| query-sub-orders-spot-algo | `algo-id` [`page` `page-size`] | Query Sub Orders |
| time-weighted-average-price-spot-algo | `symbol` `side` `quantity` `duration` [`client-algo-id` `limit-price`] | Time-Weighted Average Price(Twap) New Order |
FILE:references/spot.md
## Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-commission | `symbol` [] | Query Commission Rates |
| all-order-list | [`from-id` `start-time` `end-time` `limit`] | Query all Order lists |
| all-orders | `symbol` [`order-id` `start-time` `end-time` `limit`] | All orders |
| get-account | [`omit-zero-balances`] | Account information |
| get-open-orders | [`symbol`] | Current open orders |
| get-order | `symbol` [`order-id` `orig-client-order-id`] | Query order |
| get-order-list | [`order-list-id` `orig-client-order-id`] | Query Order list |
| my-allocations | `symbol` [`start-time` `end-time` `from-allocation-id` `limit` `order-id`] | Query Allocations |
| my-filters | `symbol` [] | Query relevant filters |
| my-prevented-matches | `symbol` [`prevented-match-id` `order-id` `from-prevented-match-id` `limit`] | Query Prevented Matches |
| my-trades | `symbol` [`order-id` `start-time` `end-time` `from-id` `limit`] | Account trade list |
| open-order-list | [] | Query Open Order lists |
| order-amendments | `symbol` `order-id` [`from-execution-id` `limit`] | Query Order Amendments |
| rate-limit-order | [] | Query Unfilled Order Count |
## General
| Endpoint | Key params | Description |
|---|---|---|
| exchange-info | [`symbol` `symbols` `permissions` `show-permission-sets` `symbol-status`] | Exchange information |
| execution-rules | [`symbol` `symbols` `symbol-status`] | Query Execution Rules |
| ping | [] | Test connectivity |
| time | [] | Check server time |
## Market
| Endpoint | Key params | Description |
|---|---|---|
| agg-trades | `symbol` [`from-id` `start-time` `end-time` `limit`] | Compressed/Aggregate trades list |
| avg-price | `symbol` [] | Current average price |
| depth | `symbol` [`limit` `symbol-status`] | Order book |
| get-trades | `symbol` [`limit`] | Recent trades list |
| historical-trades | `symbol` [`limit` `from-id`] | Old trade lookup |
| klines | `symbol` `interval` [`start-time` `end-time` `time-zone` `limit`] | Kline/Candlestick data |
| reference-price | `symbol` [] | Query Reference Price |
| reference-price-calculation | `symbol` [`symbol-status`] | Query Reference Price Calculation |
| ticker | [`symbol` `symbols` `window-size` `type` `symbol-status`] | Rolling window price change statistics |
| ticker24hr | [`symbol` `symbols` `type` `symbol-status`] | 24hr ticker price change statistics |
| ticker-book-ticker | [`symbol` `symbols` `symbol-status`] | Symbol order book ticker |
| ticker-price | [`symbol` `symbols` `symbol-status`] | Symbol price ticker |
| ticker-trading-day | [`symbol` `symbols` `time-zone` `type` `symbol-status`] | Trading Day Ticker |
| ui-klines | `symbol` `interval` [`start-time` `end-time` `time-zone` `limit`] | UIKlines |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| delete-open-orders | `symbol` [] | Cancel All Open Orders on a Symbol |
| delete-order | `symbol` [`order-id` `orig-client-order-id` `new-client-order-id` `cancel-restrictions`] | Cancel order |
| delete-order-list | `symbol` [`order-list-id` `list-client-order-id` `new-client-order-id`] | Cancel Order list |
| new-order | `symbol` `side` `type` [`time-in-force` `quantity` `quote-order-qty` `price` `new-client-order-id` `strategy-id` `strategy-type` `stop-price` `trailing-delta` `iceberg-qty` `new-order-resp-type` `self-trade-prevention-mode` `peg-price-type` `peg-offset-value` `peg-offset-type`] | New order |
| order-amend-keep-priority | `symbol` `new-qty` [`order-id` `orig-client-order-id` `new-client-order-id`] | Order Amend Keep Priority |
| order-cancel-replace | `symbol` `side` `type` `cancel-replace-mode` [`time-in-force` `quantity` `quote-order-qty` `price` `cancel-new-client-order-id` `cancel-orig-client-order-id` `cancel-order-id` `new-client-order-id` `strategy-id` `strategy-type` `stop-price` `trailing-delta` `iceberg-qty` `new-order-resp-type` `self-trade-prevention-mode` `cancel-restrictions` `order-rate-limit-exceeded-mode` `peg-price-type` `peg-offset-value` `peg-offset-type`] | Cancel an Existing Order and Send a New Order |
| order-list-oco | `symbol` `side` `quantity` `above-type` `below-type` [`list-client-order-id` `above-client-order-id` `above-iceberg-qty` `above-price` `above-stop-price` `above-trailing-delta` `above-time-in-force` `above-strategy-id` `above-strategy-type` `above-peg-price-type` `above-peg-offset-type` `above-peg-offset-value` `below-client-order-id` `below-iceberg-qty` `below-price` `below-stop-price` `below-trailing-delta` `below-time-in-force` `below-strategy-id` `below-strategy-type` `below-peg-price-type` `below-peg-offset-type` `below-peg-offset-value` `new-order-resp-type` `self-trade-prevention-mode`] | New Order list - OCO |
| order-list-opo | `symbol` `working-type` `working-side` `working-price` `working-quantity` `pending-type` `pending-side` [`list-client-order-id` `new-order-resp-type` `self-trade-prevention-mode` `working-client-order-id` `working-iceberg-qty` `working-time-in-force` `working-strategy-id` `working-strategy-type` `working-peg-price-type` `working-peg-offset-type` `working-peg-offset-value` `pending-client-order-id` `pending-price` `pending-stop-price` `pending-trailing-delta` `pending-iceberg-qty` `pending-time-in-force` `pending-strategy-id` `pending-strategy-type` `pending-peg-price-type` `pending-peg-offset-type` `pending-peg-offset-value`] | New Order List - OPO |
| order-list-opoco | `symbol` `working-type` `working-side` `working-price` `working-quantity` `pending-side` `pending-above-type` [`list-client-order-id` `new-order-resp-type` `self-trade-prevention-mode` `working-client-order-id` `working-iceberg-qty` `working-time-in-force` `working-strategy-id` `working-strategy-type` `working-peg-price-type` `working-peg-offset-type` `working-peg-offset-value` `pending-above-client-order-id` `pending-above-price` `pending-above-stop-price` `pending-above-trailing-delta` `pending-above-iceberg-qty` `pending-above-time-in-force` `pending-above-strategy-id` `pending-above-strategy-type` `pending-above-peg-price-type` `pending-above-peg-offset-type` `pending-above-peg-offset-value` `pending-below-type` `pending-below-client-order-id` `pending-below-price` `pending-below-stop-price` `pending-below-trailing-delta` `pending-below-iceberg-qty` `pending-below-time-in-force` `pending-below-strategy-id` `pending-below-strategy-type` `pending-below-peg-price-type` `pending-below-peg-offset-type` `pending-below-peg-offset-value`] | New Order List - OPOCO |
| order-list-oto | `symbol` `working-type` `working-side` `working-price` `working-quantity` `pending-type` `pending-side` `pending-quantity` [`list-client-order-id` `new-order-resp-type` `self-trade-prevention-mode` `working-client-order-id` `working-iceberg-qty` `working-time-in-force` `working-strategy-id` `working-strategy-type` `working-peg-price-type` `working-peg-offset-type` `working-peg-offset-value` `pending-client-order-id` `pending-price` `pending-stop-price` `pending-trailing-delta` `pending-iceberg-qty` `pending-time-in-force` `pending-strategy-id` `pending-strategy-type` `pending-peg-price-type` `pending-peg-offset-type` `pending-peg-offset-value`] | New Order list - OTO |
| order-list-otoco | `symbol` `working-type` `working-side` `working-price` `working-quantity` `pending-side` `pending-quantity` `pending-above-type` [`list-client-order-id` `new-order-resp-type` `self-trade-prevention-mode` `working-client-order-id` `working-iceberg-qty` `working-time-in-force` `working-strategy-id` `working-strategy-type` `working-peg-price-type` `working-peg-offset-type` `working-peg-offset-value` `pending-above-client-order-id` `pending-above-price` `pending-above-stop-price` `pending-above-trailing-delta` `pending-above-iceberg-qty` `pending-above-time-in-force` `pending-above-strategy-id` `pending-above-strategy-type` `pending-above-peg-price-type` `pending-above-peg-offset-type` `pending-above-peg-offset-value` `pending-below-type` `pending-below-client-order-id` `pending-below-price` `pending-below-stop-price` `pending-below-trailing-delta` `pending-below-iceberg-qty` `pending-below-time-in-force` `pending-below-strategy-id` `pending-below-strategy-type` `pending-below-peg-price-type` `pending-below-peg-offset-type` `pending-below-peg-offset-value`] | New Order list - OTOCO |
| order-oco | `symbol` `side` `quantity` `price` `stop-price` [`list-client-order-id` `limit-client-order-id` `limit-strategy-id` `limit-strategy-type` `limit-iceberg-qty` `trailing-delta` `stop-client-order-id` `stop-strategy-id` `stop-strategy-type` `stop-limit-price` `stop-iceberg-qty` `stop-limit-time-in-force` `new-order-resp-type` `self-trade-prevention-mode`] | New OCO - Deprecated |
| order-test | `symbol` `side` `type` [`compute-commission-rates` `time-in-force` `quantity` `quote-order-qty` `price` `new-client-order-id` `strategy-id` `strategy-type` `stop-price` `trailing-delta` `iceberg-qty` `new-order-resp-type` `self-trade-prevention-mode` `peg-price-type` `peg-offset-value` `peg-offset-type`] | Test new order |
| sor-order | `symbol` `side` `type` `quantity` [`time-in-force` `price` `new-client-order-id` `strategy-id` `strategy-type` `iceberg-qty` `new-order-resp-type` `self-trade-prevention-mode`] | New order using SOR |
| sor-order-test | `symbol` `side` `type` `quantity` [`compute-commission-rates` `time-in-force` `price` `new-client-order-id` `strategy-id` `strategy-type` `iceberg-qty` `new-order-resp-type` `self-trade-prevention-mode`] | Test new order using SOR |
### Enums
**above-peg-offset-type:** `PRICE_LEVEL`
**above-peg-price-type:** `PRIMARY_PEG` `MARKET_PEG`
**above-time-in-force:** `GTC` `IOC` `FOK`
**above-type:** `STOP_LOSS_LIMIT` `STOP_LOSS` `LIMIT_MAKER` `TAKE_PROFIT` `TAKE_PROFIT_LIMIT`
**below-peg-offset-type:** `PRICE_LEVEL`
**below-peg-price-type:** `PRIMARY_PEG` `MARKET_PEG`
**below-time-in-force:** `GTC` `IOC` `FOK`
**below-type:** `STOP_LOSS` `STOP_LOSS_LIMIT` `TAKE_PROFIT` `TAKE_PROFIT_LIMIT`
**cancel-replace-mode:** `STOP_ON_FAILURE` `ALLOW_FAILURE`
**cancel-restrictions:** `ONLY_NEW` `NEW` `ONLY_PARTIALLY_FILLED` `PARTIALLY_FILLED`
**interval:** `1s` `1m` `3m` `5m` `15m` `30m` `1h` `2h` `4h` `6h` `8h` `12h` `1d` `3d` `1w` `1M`
**new-order-resp-type:** `ACK` `RESULT` `FULL` `MARKET` `LIMIT`
**order-rate-limit-exceeded-mode:** `DO_NOTHING` `CANCEL_ONLY`
**peg-offset-type:** `PRICE_LEVEL` `NON_REPRESENTABLE`
**peg-price-type:** `PRIMARY_PEG` `MARKET_PEG` `NON_REPRESENTABLE`
**pending-above-peg-offset-type:** `PRICE_LEVEL`
**pending-above-peg-price-type:** `PRIMARY_PEG` `MARKET_PEG`
**pending-above-time-in-force:** `GTC` `IOC` `FOK`
**pending-above-type:** `STOP_LOSS_LIMIT` `STOP_LOSS` `LIMIT_MAKER` `TAKE_PROFIT` `TAKE_PROFIT_LIMIT`
**pending-below-peg-offset-type:** `PRICE_LEVEL`
**pending-below-peg-price-type:** `PRIMARY_PEG` `MARKET_PEG`
**pending-below-time-in-force:** `GTC` `IOC` `FOK`
**pending-below-type:** `STOP_LOSS` `STOP_LOSS_LIMIT` `TAKE_PROFIT` `TAKE_PROFIT_LIMIT`
**pending-peg-offset-type:** `PRICE_LEVEL`
**pending-peg-price-type:** `PRIMARY_PEG` `MARKET_PEG`
**pending-side:** `BUY` `SELL`
**pending-time-in-force:** `GTC` `IOC` `FOK`
**pending-type:** `LIMIT` `MARKET` `STOP_LOSS` `STOP_LOSS_LIMIT` `TAKE_PROFIT` `TAKE_PROFIT_LIMIT` `LIMIT_MAKER`
**self-trade-prevention-mode:** `NONE` `EXPIRE_TAKER` `EXPIRE_MAKER` `EXPIRE_BOTH` `DECREMENT` `NON_REPRESENTABLE`
**side:** `BUY` `SELL`
**stop-limit-time-in-force:** `GTC` `IOC` `FOK`
**symbol-status:** `TRADING` `END_OF_DAY` `HALT` `BREAK` `NON_REPRESENTABLE`
**time-in-force:** `GTC` `IOC` `FOK` `NON_REPRESENTABLE`
**type:** `FULL` `MINI`
**type:** `MARKET` `LIMIT` `STOP_LOSS` `STOP_LOSS_LIMIT` `TAKE_PROFIT` `TAKE_PROFIT_LIMIT` `LIMIT_MAKER` `NON_REPRESENTABLE`
**window-size:** `1m` `2m` `3m` `4m` `5m` `6m` `7m` `8m` `9m` `10m` `11m` `12m` `13m` `14m` `15m` `16m` `17m` `18m` `19m` `20m` `21m` `22m` `23m` `24m` `25m` `26m` `27m` `28m` `29m` `30m` `31m` `32m` `33m` `34m` `35m` `36m` `37m` `38m` `39m` `40m` `41m` `42m` `43m` `44m` `45m` `46m` `47m` `48m` `49m` `50m` `51m` `52m` `53m` `54m` `55m` `56m` `57m` `58m` `59m` `1h` `2h` `3h` `4h` `5h` `6h` `7h` `8h` `9h` `10h` `11h` `12h` `13h` `14h` `15h` `16h` `17h` `18h` `19h` `20h` `21h` `22h` `23h` `1d` `2d` `3d` `4d` `5d` `6d`
**working-peg-offset-type:** `PRICE_LEVEL`
**working-peg-price-type:** `PRIMARY_PEG` `MARKET_PEG`
**working-side:** `BUY` `SELL`
**working-time-in-force:** `GTC` `IOC` `FOK`
**working-type:** `LIMIT` `LIMIT_MAKER`
FILE:references/rebate.md
## Rebate (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-spot-rebate-history-records | [`start-time` `end-time` `page`] | Get Spot Rebate History Records |
FILE:references/mining.md
## Mining (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-list | `algo` `user-name` [] | Account List |
| acquiring-algorithm | [] | Acquiring Algorithm |
| acquiring-coinname | [] | Acquiring CoinName |
| cancel-hashrate-resale-configuration | `config-id` `user-name` [] | Cancel hashrate resale configuration |
| earnings-list | `algo` `user-name` [`coin` `start-date` `end-date` `page-index` `page-size`] | Earnings List |
| extra-bonus-list | `algo` `user-name` [`coin` `start-date` `end-date` `page-index` `page-size`] | Extra Bonus List |
| hashrate-resale-detail | `config-id` [`page-index` `page-size`] | Hashrate Resale Detail |
| hashrate-resale-list | [`page-index` `page-size`] | Hashrate Resale List |
| hashrate-resale-request | `user-name` `algo` `end-date` `start-date` `to-pool-user` `hash-rate` [] | Hashrate Resale Request |
| mining-account-earning | `algo` [`start-date` `end-date` `page-index` `page-size`] | Mining Account Earning |
| request-for-detail-miner-list | `algo` `user-name` `worker-name` [] | Request for Detail Miner List |
| request-for-miner-list | `algo` `user-name` [`page-index` `sort` `sort-column` `worker-status`] | Request for Miner List |
| statistic-list | `algo` `user-name` [] | Statistic List |
FILE:references/margin-trading.md
## Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| adjust-cross-margin-max-leverage | `max-leverage` [] | Adjust cross margin max leverage |
| disable-isolated-margin-account | `symbol` [] | Disable Isolated Margin Account |
| enable-isolated-margin-account | `symbol` [] | Enable Isolated Margin Account |
| get-bnb-burn-status | [] | Get BNB Burn Status |
| get-summary-of-margin-account | [] | Get Summary of Margin account |
| query-cross-isolated-margin-capital-flow | [`asset` `symbol` `type` `start-time` `end-time` `from-id` `limit`] | Query Cross Isolated Margin Capital Flow |
| query-cross-margin-account-details | [] | Query Cross Margin Account Details |
| query-cross-margin-fee-data | [`vip-level` `coin`] | Query Cross Margin Fee Data |
| query-enabled-isolated-margin-account-limit | [] | Query Enabled Isolated Margin Account Limit |
| query-isolated-margin-account-info | [`symbols`] | Query Isolated Margin Account Info |
| query-isolated-margin-fee-data | [`vip-level` `symbol`] | Query Isolated Margin Fee Data |
## Borrow Repay (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-future-hourly-interest-rate | `assets` `is-isolated` [] | Get future hourly interest rate |
| get-interest-history | [`asset` `isolated-symbol` `start-time` `end-time` `current` `size`] | Get Interest History |
| margin-account-borrow-repay | `asset` `is-isolated` `symbol` `amount` `type` [] | Margin account borrow/repay |
| query-borrow-repay-records-in-margin-account | `type` [`asset` `isolated-symbol` `tx-id` `start-time` `end-time` `current` `size`] | Query borrow/repay records in Margin account |
| query-margin-interest-rate-history | `asset` [`vip-level` `start-time` `end-time`] | Query Margin Interest Rate History |
| query-max-borrow | `asset` [`isolated-symbol`] | Query Max Borrow |
## Market Data
| Endpoint | Key params | Description |
|---|---|---|
| cross-margin-collateral-ratio | [] | Cross margin collateral ratio |
| get-all-cross-margin-pairs | [`symbol`] | Get All Cross Margin Pairs |
| get-all-isolated-margin-symbol | [`symbol`] | Get All Isolated Margin Symbol |
| get-all-margin-assets | [`asset`] | Get All Margin Assets |
| get-delist-schedule | [] | Get Delist Schedule |
| get-limit-price-pairs | [] | Get Limit Price Pairs |
| get-list-schedule | [] | Get list Schedule |
| get-margin-asset-risk-based-liquidation-ratio | [] | Get Margin Asset Risk-Based Liquidation Ratio |
| get-margin-restricted-assets | [] | Get Margin Restricted Assets |
| query-isolated-margin-tier-data | `symbol` [`tier`] | Query Isolated Margin Tier Data |
| query-liability-coin-leverage-bracket-in-cross-margin-pro-mode | [] | Query Liability Coin Leverage Bracket in Cross Margin Pro Mode |
| query-margin-available-inventory | `type` [] | Query Margin Available Inventory |
| query-margin-priceindex | `symbol` [] | Query Margin PriceIndex |
## Risk Data Stream
| Endpoint | Key params | Description |
|---|---|---|
| close-user-data-stream | [] | Close User Data Stream |
| keepalive-user-data-stream | `listen-key` [] | Keepalive User Data Stream |
| start-user-data-stream | [] | Start User Data Stream |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| create-special-key | `api-name` [`symbol` `ip` `public-key` `permission-mode`] | Create Special Key(Low-Latency Trading) |
| delete-special-key | [`api-name` `symbol`] | Delete Special Key(Low-Latency Trading) |
| edit-ip-for-special-key | `ip` [`symbol`] | Edit ip for Special Key(Low-Latency Trading) |
| get-force-liquidation-record | [`start-time` `end-time` `isolated-symbol` `current` `size`] | Get Force Liquidation Record |
| get-small-liability-exchange-coin-list | [] | Get Small Liability Exchange Coin List |
| get-small-liability-exchange-history | `current` `size` [`start-time` `end-time`] | Get Small Liability Exchange History |
| margin-account-cancel-all-open-orders-on-a-symbol | `symbol` [`is-isolated`] | Margin Account Cancel all Open Orders on a Symbol |
| margin-account-cancel-oco | `symbol` [`is-isolated` `order-list-id` `list-client-order-id` `new-client-order-id`] | Margin Account Cancel OCO |
| margin-account-cancel-order | `symbol` [`is-isolated` `order-id` `orig-client-order-id` `new-client-order-id`] | Margin Account Cancel Order |
| margin-account-new-oco | `symbol` `side` `quantity` `price` `stop-price` [`is-isolated` `list-client-order-id` `limit-client-order-id` `limit-iceberg-qty` `stop-client-order-id` `stop-limit-price` `stop-iceberg-qty` `stop-limit-time-in-force` `new-order-resp-type` `side-effect-type` `self-trade-prevention-mode` `auto-repay-at-cancel`] | Margin Account New OCO |
| margin-account-new-order | `symbol` `side` `type` [`is-isolated` `quantity` `quote-order-qty` `price` `stop-price` `new-client-order-id` `iceberg-qty` `new-order-resp-type` `side-effect-type` `time-in-force` `self-trade-prevention-mode` `auto-repay-at-cancel`] | Margin Account New Order |
| margin-account-new-oto | `symbol` `working-type` `working-side` `working-price` `working-quantity` `working-iceberg-qty` `pending-type` `pending-side` `pending-quantity` [`is-isolated` `list-client-order-id` `new-order-resp-type` `side-effect-type` `self-trade-prevention-mode` `auto-repay-at-cancel` `working-client-order-id` `working-time-in-force` `pending-client-order-id` `pending-price` `pending-stop-price` `pending-trailing-delta` `pending-iceberg-qty` `pending-time-in-force`] | Margin Account New OTO |
| margin-account-new-otoco | `symbol` `working-type` `working-side` `working-price` `working-quantity` `pending-side` `pending-quantity` `pending-above-type` [`is-isolated` `side-effect-type` `auto-repay-at-cancel` `list-client-order-id` `new-order-resp-type` `self-trade-prevention-mode` `working-client-order-id` `working-iceberg-qty` `working-time-in-force` `pending-above-client-order-id` `pending-above-price` `pending-above-stop-price` `pending-above-trailing-delta` `pending-above-iceberg-qty` `pending-above-time-in-force` `pending-below-type` `pending-below-client-order-id` `pending-below-price` `pending-below-stop-price` `pending-below-trailing-delta` `pending-below-iceberg-qty` `pending-below-time-in-force`] | Margin Account New OTOCO |
| margin-manual-liquidation | `type` [`symbol`] | Margin Manual Liquidation |
| query-current-margin-order-count-usage | [`is-isolated` `symbol`] | Query Current Margin Order Count Usage |
| query-margin-accounts-all-oco | [`is-isolated` `symbol` `from-id` `start-time` `end-time` `limit`] | Query Margin Account\'s all OCO |
| query-margin-accounts-all-orders | `symbol` [`is-isolated` `order-id` `start-time` `end-time` `limit`] | Query Margin Account\'s All Orders |
| query-margin-accounts-oco | [`is-isolated` `symbol` `order-list-id` `orig-client-order-id`] | Query Margin Account\'s OCO |
| query-margin-accounts-open-oco | [`is-isolated` `symbol`] | Query Margin Account\'s Open OCO |
| query-margin-accounts-open-orders | [`symbol` `is-isolated`] | Query Margin Account\'s Open Orders |
| query-margin-accounts-order | `symbol` [`is-isolated` `order-id` `orig-client-order-id`] | Query Margin Account\'s Order |
| query-margin-accounts-trade-list | `symbol` [`is-isolated` `order-id` `start-time` `end-time` `from-id` `limit`] | Query Margin Account\'s Trade List |
| query-prevented-matches | `symbol` [`prevented-match-id` `order-id` `from-prevented-match-id` `is-isolated`] | Query Prevented Matches |
| query-special-key | [`symbol`] | Query Special key(Low Latency Trading) |
| query-special-key-list | [`symbol`] | Query Special key List(Low Latency Trading) |
| small-liability-exchange | `asset-names` [] | Small Liability Exchange |
## Transfer (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-cross-margin-transfer-history | [`asset` `type` `start-time` `end-time` `current` `size` `isolated-symbol`] | Get Cross Margin Transfer History |
| query-max-transfer-out-amount | `asset` [`isolated-symbol`] | Query Max Transfer-Out Amount |
### Enums
**new-order-resp-type:** `ACK` `RESULT` `FULL`
**side:** `BUY` `SELL`
**time-in-force:** `GTC` `IOC` `FOK`
FILE:references/auth.md
# Binance Authentication
API Key and Secret
- `BINANCE_API_KEY`: Binance API Key
- `BINANCE_SECRET_KEY`: Binance API Secret or Private Key
API Environment (optional)
- `BINANCE_API_ENV`: Binance API environment of <prod|testnet|demo>. default: prod
## Profiles
```bash
# Create
binance-cli profile create --name <name> --api-key <key> --api-secret <secret> --env <prod|testnet|demo>
# Select profile
binance-cli profile select --name <name>
# List all profiles
binance-cli profile list
# View active
binance-cli profile view
```
When user provides new credentials: ask for account name and environment (prod/testnet/demo), check for duplicates, then create. Use `--profile <name>` on any command to override the active profile.
## Security Rules
- Never run `printenv`, `env`, `export` (without a specific var name), or source any secrets file.
- Never `grep` env files without anchoring: `^VARNAME=`
- Never echo or log raw credentials.
- Never disclose the location of key/secret files.
FILE:references/staking.md
## Eth Staking (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| eth-staking-account | [] | ETH Staking account |
| get-current-eth-staking-quota | [] | Get current ETH staking quota |
| get-eth-redemption-history | [`redeem-id` `start-time` `end-time` `current` `size`] | Get ETH redemption history |
| get-eth-staking-history | [`purchase-id` `start-time` `end-time` `current` `size`] | Get ETH staking history |
| get-wbeth-rate-history | [`start-time` `end-time` `current` `size`] | Get WBETH Rate History |
| get-wbeth-rewards-history | [`start-time` `end-time` `current` `size`] | Get WBETH rewards history |
| get-wbeth-unwrap-history | [`start-time` `end-time` `current` `size`] | Get WBETH unwrap history |
| get-wbeth-wrap-history | [`start-time` `end-time` `current` `size`] | Get WBETH wrap history |
| redeem-eth | `amount` [`asset`] | Redeem ETH |
| subscribe-eth-staking | `amount` [] | Subscribe ETH Staking |
| wrap-beth | `amount` [] | Wrap BETH |
## On Chain Yields (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-on-chain-yields-locked-personal-left-quota | `project-id` [] | Get On-chain Yields Locked Personal Left Quota |
| get-on-chain-yields-locked-product-list | [`asset` `current` `size`] | Get On-chain Yields Locked Product List |
| get-on-chain-yields-locked-product-position | [`asset` `position-id` `project-id` `current` `size`] | Get On-chain Yields Locked Product Position |
| get-on-chain-yields-locked-redemption-record | [`position-id` `redeem-id` `asset` `start-time` `end-time` `current` `size`] | Get On-chain Yields Locked Redemption Record |
| get-on-chain-yields-locked-rewards-history | [`position-id` `asset` `start-time` `end-time` `current` `size`] | Get On-chain Yields Locked Rewards History |
| get-on-chain-yields-locked-subscription-preview | `project-id` `amount` [`auto-subscribe`] | Get On-chain Yields Locked Subscription Preview |
| get-on-chain-yields-locked-subscription-record | [`purchase-id` `client-id` `asset` `start-time` `end-time` `current` `size`] | Get On-chain Yields Locked Subscription Record |
| on-chain-yields-account | [] | On-chain Yields Account |
| redeem-on-chain-yields-locked-product | `position-id` [`channel-id`] | Redeem On-chain Yields Locked Product |
| set-on-chain-yields-locked-auto-subscribe | `position-id` `auto-subscribe` [] | Set On-chain Yields Locked Auto Subscribe |
| set-on-chain-yields-locked-product-redeem-option | `position-id` `redeem-to` [] | Set On-chain Yields Locked Product Redeem Option |
| subscribe-on-chain-yields-locked-product | `project-id` `amount` [`auto-subscribe` `source-account` `redeem-to` `channel-id` `client-id`] | Subscribe On-chain Yields Locked Product |
## Soft Staking (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-soft-staking-product-list | [`asset` `current` `size`] | Get Soft Staking Product List |
| get-soft-staking-rewards-history | [`asset` `start-time` `end-time` `current` `size`] | Get Soft Staking Rewards History |
| set-soft-staking | `soft-staking` [] | Set Soft Staking |
## Sol Staking (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| claim-boost-rewards | [] | Claim Boost Rewards |
| get-bnsol-rate-history | [`start-time` `end-time` `current` `size`] | Get BNSOL Rate History |
| get-bnsol-rewards-history | [`start-time` `end-time` `current` `size`] | Get BNSOL rewards history |
| get-boost-rewards-history | `type` [`start-time` `end-time` `current` `size`] | Get Boost Rewards History |
| get-sol-redemption-history | [`redeem-id` `start-time` `end-time` `current` `size`] | Get SOL redemption history |
| get-sol-staking-history | [`purchase-id` `start-time` `end-time` `current` `size`] | Get SOL staking history |
| get-sol-staking-quota-details | [] | Get SOL staking quota details |
| get-unclaimed-rewards | [] | Get Unclaimed Rewards |
| redeem-sol | `amount` [] | Redeem SOL |
| sol-staking-account | [] | SOL Staking account |
| subscribe-sol-staking | `amount` [] | Subscribe SOL Staking |
FILE:references/c2c.md
## C2C (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-c2-c-trade-history | [`trade-type` `start-timestamp` `end-timestamp` `page` `rows`] | Get C2C Trade History |
FILE:references/sub-account.md
## Account Management (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| create-a-virtual-sub-account | `sub-account-string` [] | Create a Virtual Sub-account (For Master Account) |
| enable-futures-for-sub-account | `email` [] | Enable Futures for Sub-account (For Master Account) |
| enable-options-for-sub-account | `email` [] | Enable Options for Sub-account (For Master Account) |
| get-futures-position-risk-of-sub-account | `email` [] | Get Futures Position-Risk of Sub-account (For Master Account) |
| get-futures-position-risk-of-sub-account-v2 | `email` `futures-type` [] | Get Futures Position-Risk of Sub-account V2 (For Master Account) |
| get-sub-accounts-status-on-margin-or-futures | [`email`] | Get Sub-account\'s Status on Margin Or Futures (For Master Account) |
| query-sub-account-list | [`email` `is-freeze` `page` `limit`] | Query Sub-account List (For Master Account) |
| query-sub-account-transaction-statistics | [`email`] | Query Sub-account Transaction Statistics (For Master Account) |
## Api Management (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| add-ip-restriction-for-sub-account-api-key | `email` `sub-account-api-key` `status` [`ip-address`] | Add IP Restriction for Sub-Account API key (For Master Account) |
| delete-ip-list-for-a-sub-account-api-key | `email` `sub-account-api-key` `ip-address` [] | Delete IP List For a Sub-account API Key (For Master Account) |
| get-ip-restriction-for-a-sub-account-api-key | `email` `sub-account-api-key` [] | Get IP Restriction for a Sub-account API Key (For Master Account) |
## Asset Management (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| futures-transfer-for-sub-account | `email` `asset` `amount` `type` [] | Futures Transfer for Sub-account (For Master Account) |
| get-detail-on-sub-accounts-futures-account | `email` [] | Get Detail on Sub-account\'s Futures Account (For Master Account) |
| get-detail-on-sub-accounts-futures-account-v2 | `email` `futures-type` [] | Get Detail on Sub-account\'s Futures Account V2 (For Master Account) |
| get-detail-on-sub-accounts-margin-account | `email` [] | Get Detail on Sub-account\'s Margin Account (For Master Account) |
| get-move-position-history-for-sub-account | `symbol` `page` `row` [`start-time` `end-time`] | Get Move Position History for Sub-account (For Master Account) |
| get-sub-account-deposit-address | `email` `coin` [`network` `amount`] | Get Sub-account Deposit Address (For Master Account) |
| get-sub-account-deposit-history | `email` [`coin` `status` `start-time` `end-time` `limit` `offset` `tx-id`] | Get Sub-account Deposit History (For Master Account) |
| get-summary-of-sub-accounts-futures-account | `page` `limit` [] | Get Summary of Sub-account\'s Futures Account (For Master Account) |
| get-summary-of-sub-accounts-futures-account-v2 | `futures-type` [`page` `limit`] | Get Summary of Sub-account\'s Futures Account V2 (For Master Account) |
| get-summary-of-sub-accounts-margin-account | [] | Get Summary of Sub-account\'s Margin Account (For Master Account) |
| margin-transfer-for-sub-account | `email` `asset` `amount` `type` [] | Margin Transfer for Sub-account (For Master Account) |
| move-position-for-sub-account | `from-user-email` `to-user-email` `product-type` `order-args` [] | Move Position for Sub-account (For Master Account) |
| query-sub-account-assets | `email` [] | Query Sub-account Assets (For Master Account) |
| query-sub-account-assets-asset-management | `email` [] | Query Sub-account Assets (For Master Account) |
| query-sub-account-futures-asset-transfer-history | `email` `futures-type` [`start-time` `end-time` `page` `limit`] | Query Sub-account Futures Asset Transfer History (For Master Account) |
| query-sub-account-spot-asset-transfer-history | [`from-email` `to-email` `start-time` `end-time` `page` `limit`] | Query Sub-account Spot Asset Transfer History (For Master Account) |
| query-sub-account-spot-assets-summary | [`email` `page` `size`] | Query Sub-account Spot Assets Summary (For Master Account) |
| query-universal-transfer-history | [`from-email` `to-email` `client-tran-id` `start-time` `end-time` `page` `limit`] | Query Universal Transfer History (For Master Account) |
| sub-account-futures-asset-transfer | `from-email` `to-email` `futures-type` `asset` `amount` [] | Sub-account Futures Asset Transfer (For Master Account) |
| sub-account-transfer-history | [`asset` `type` `start-time` `end-time` `limit` `return-fail-history`] | Sub-account Transfer History (For Sub-account) |
| transfer-to-master | `asset` `amount` [] | Transfer to Master (For Sub-account) |
| transfer-to-sub-account-of-same-master | `to-email` `asset` `amount` [] | Transfer to Sub-account of Same Master (For Sub-account) |
| universal-transfer | `from-account-type` `to-account-type` `asset` `amount` [`from-email` `to-email` `client-tran-id` `symbol`] | Universal Transfer (For Master Account) |
## Managed Sub Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| deposit-assets-into-the-managed-sub-account | `to-email` `asset` `amount` [] | Deposit Assets Into The Managed Sub-account (For Investor Master Account) |
| get-managed-sub-account-deposit-address | `email` `coin` [`network` `amount`] | Get Managed Sub-account Deposit Address (For Investor Master Account) |
| query-managed-sub-account-asset-details | `email` [] | Query Managed Sub-account Asset Details (For Investor Master Account) |
| query-managed-sub-account-futures-asset-details | `email` [`account-type`] | Query Managed Sub-account Futures Asset Details (For Investor Master Account) |
| query-managed-sub-account-list | [`email` `page` `limit`] | Query Managed Sub-account List (For Investor) |
| query-managed-sub-account-margin-asset-details | `email` [`account-type`] | Query Managed Sub-account Margin Asset Details (For Investor Master Account) |
| query-managed-sub-account-snapshot | `email` `type` [`start-time` `end-time` `limit`] | Query Managed Sub-account Snapshot (For Investor Master Account) |
| query-managed-sub-account-transfer-log-master-account-investor | `email` `start-time` `end-time` `page` `limit` [`transfers` `transfer-function-account-type`] | Query Managed Sub Account Transfer Log (For Investor Master Account) |
| query-managed-sub-account-transfer-log-master-account-trading | `email` `start-time` `end-time` `page` `limit` [`transfers` `transfer-function-account-type`] | Query Managed Sub Account Transfer Log (For Trading Team Master Account) |
| query-managed-sub-account-transfer-log-sub-account-trading | `start-time` `end-time` `page` `limit` [`transfers` `transfer-function-account-type`] | Query Managed Sub Account Transfer Log (For Trading Team Sub Account) |
| withdrawl-assets-from-the-managed-sub-account | `from-email` `asset` `amount` [`transfer-date`] | Withdrawl Assets From The Managed Sub-account (For Investor Master Account) |
FILE:references/vip-loan.md
## Market Data (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-borrow-interest-rate | `loan-coin` [] | Get Borrow Interest Rate |
| get-collateral-asset-data | [`collateral-coin`] | Get Collateral Asset Data |
| get-loanable-assets-data | [`loan-coin` `vip-level`] | Get Loanable Assets Data |
| get-vip-loan-interest-rate-history | `coin` [`start-time` `end-time` `current` `limit`] | Get VIP Loan Interest Rate History |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| vip-loan-borrow | `loan-account-id` `loan-coin` `loan-amount` `collateral-account-id` `collateral-coin` `is-flexible-rate` [`loan-term`] | VIP Loan Borrow |
| vip-loan-renew | `order-id` `loan-term` [] | VIP Loan Renew |
| vip-loan-repay | `order-id` `amount` [] | VIP Loan Repay |
## User Information (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| check-vip-loan-collateral-account | [`order-id` `collateral-account-id`] | Check VIP Loan Collateral Account |
| get-vip-loan-accrued-interest | [`order-id` `loan-coin` `start-time` `end-time` `current` `limit`] | Get VIP Loan Accrued Interest |
| get-vip-loan-ongoing-orders | [`order-id` `collateral-account-id` `loan-coin` `collateral-coin` `current` `limit`] | Get VIP Loan Ongoing Orders |
| query-application-status | [`current` `limit`] | Query Application Status |
FILE:references/derivatives-portfolio-margin-pro.md
## Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| bnb-transfer | `amount` `transfer-side` [] | BNB transfer |
| change-auto-repay-futures-status | `auto-repay` [] | Change Auto-repay-futures Status |
| fund-auto-collection | [] | Fund Auto-collection |
| fund-collection-by-asset | `asset` [] | Fund Collection by Asset |
| get-auto-repay-futures-status | [] | Get Auto-repay-futures Status |
| get-delta-mode-status | [] | Get Delta Mode Status |
| get-portfolio-margin-pro-account-balance | [`asset`] | Get Portfolio Margin Pro Account Balance |
| get-portfolio-margin-pro-account-info | [] | Get Portfolio Margin Pro Account Info |
| get-portfolio-margin-pro-span-account-info | [] | Get Portfolio Margin Pro SPAN Account Info |
| get-transferable-earn-asset-balance-for-portfolio-margin | `asset` `transfer-type` [] | Get Transferable Earn Asset Balance for Portfolio Margin |
| portfolio-margin-pro-bankruptcy-loan-repay | [`from`] | Portfolio Margin Pro Bankruptcy Loan Repay |
| query-portfolio-margin-pro-bankruptcy-loan-amount | [] | Query Portfolio Margin Pro Bankruptcy Loan Amount |
| query-portfolio-margin-pro-bankruptcy-loan-repay-history | [`start-time` `end-time` `current` `size`] | Query Portfolio Margin Pro Bankruptcy Loan Repay History |
| query-portfolio-margin-pro-negative-balance-interest-history | [`asset` `start-time` `end-time` `size`] | Query Portfolio Margin Pro Negative Balance Interest History |
| repay-futures-negative-balance | [`from`] | Repay futures Negative Balance |
| switch-delta-mode | `delta-enabled` [] | Switch Delta Mode |
| transfer-ldusdt-rwusd-for-portfolio-margin | `asset` `transfer-type` `amount` [] | Transfer LDUSDT/RWUSD for Portfolio Margin |
## Market Data (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-portfolio-margin-asset-leverage | [] | Get Portfolio Margin Asset Leverage |
| portfolio-margin-collateral-rate | [] | Portfolio Margin Collateral Rate |
| portfolio-margin-pro-tiered-collateral-rate | [] | Portfolio Margin Pro Tiered Collateral Rate |
| query-portfolio-margin-asset-index-price | [`asset`] | Query Portfolio Margin Asset Index Price |
FILE:references/derivatives-options.md
## Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-funding-flow | `currency` [`record-id` `start-time` `end-time` `limit`] | Account Funding Flow |
| option-margin-account-information | [] | Option Margin Account Information |
## Market Data
| Endpoint | Key params | Description |
|---|---|---|
| check-server-time | [] | Check Server Time |
| exchange-information | [] | Exchange Information |
| historical-exercise-records | [`underlying` `start-time` `end-time` `limit`] | Historical Exercise Records |
| index-price | `underlying` [] | Index Price |
| kline-candlestick-data | `symbol` `interval` [`start-time` `end-time` `limit`] | Kline/Candlestick Data |
| open-interest | `underlying-asset` `expiration` [] | Open Interest |
| option-mark-price | [`symbol`] | Option Mark Price |
| order-book | `symbol` [`limit`] | Order Book |
| recent-block-trades-list | [`symbol` `limit`] | Recent Block Trades List |
| recent-trades-list | `symbol` [`limit`] | Recent Trades List |
| test-connectivity | [] | Test Connectivity |
| ticker24hr-price-change-statistics | [`symbol`] | 24hr Ticker Price Change Statistics |
## Market Maker Block Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| accept-block-trade-order | `block-order-matching-key` [] | Accept Block Trade Order |
| account-block-trade-list | [`end-time` `start-time` `underlying`] | Account Block Trade List |
| cancel-block-trade-order | `block-order-matching-key` [] | Cancel Block Trade Order |
| extend-block-trade-order | `block-order-matching-key` [] | Extend Block Trade Order |
| new-block-trade-order | `liquidity` `legs` [] | New Block Trade Order |
| query-block-trade-details | `block-order-matching-key` [] | Query Block Trade Details |
| query-block-trade-order | [`block-order-matching-key` `end-time` `start-time` `underlying`] | Query Block Trade Order |
## Market Maker Endpoints (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| auto-cancel-all-open-orders | `underlyings` [] | Auto-Cancel All Open Orders (Kill-Switch) Heartbeat |
| get-auto-cancel-all-open-orders | [`underlying`] | Get Auto-Cancel All Open Orders (Kill-Switch) Config |
| get-market-maker-protection-config | [`underlying`] | Get Market Maker Protection Config |
| reset-market-maker-protection-config | [`underlying`] | Reset Market Maker Protection Config |
| set-auto-cancel-all-open-orders | `underlying` `countdown-time` [] | Set Auto-Cancel All Open Orders (Kill-Switch) Config |
| set-market-maker-protection-config | [`underlying` `window-time-in-milliseconds` `frozen-time-in-milliseconds` `qty-limit` `delta-limit`] | Set Market Maker Protection Config |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-trade-list | [`symbol` `from-id` `start-time` `end-time` `limit`] | Account Trade List |
| cancel-all-option-orders-by-underlying | `underlying` [] | Cancel All Option Orders By Underlying |
| cancel-all-option-orders-on-specific-symbol | `symbol` [] | Cancel all Option orders on specific symbol |
| cancel-multiple-option-orders | `symbol` [`order-ids` `client-order-ids`] | Cancel Multiple Option Orders |
| cancel-option-order | `symbol` [`order-id` `client-order-id`] | Cancel Option Order |
| new-order | `symbol` `side` `type` `quantity` [`price` `time-in-force` `reduce-only` `post-only` `new-order-resp-type` `client-order-id` `is-mmp` `self-trade-prevention-mode`] | New Order |
| option-position-information | [`symbol`] | Option Position Information |
| place-multiple-orders | `orders` [] | Place Multiple Orders |
| query-current-open-option-orders | [`symbol` `order-id` `start-time` `end-time`] | Query Current Open Option Orders |
| query-option-order-history | `symbol` [`order-id` `start-time` `end-time` `limit`] | Query Option Order History |
| query-single-order | `symbol` [`order-id` `client-order-id`] | Query Single Order |
| user-commission | [] | User Commission |
| user-exercise-record | [`symbol` `start-time` `end-time` `limit`] | User Exercise Record |
## User Data Streams
| Endpoint | Key params | Description |
|---|---|---|
| close-user-data-stream | [] | Close User Data Stream |
| keepalive-user-data-stream | [] | Keepalive User Data Stream |
| start-user-data-stream | [] | Start User Data Stream |
### Enums
**new-order-resp-type:** `ACK` `RESULT`
**self-trade-prevention-mode:** `EXPIRE_TAKER` `EXPIRE_BOTH` `EXPIRE_MAKER`
**side:** `BUY` `SELL`
**time-in-force:** `GTC` `IOC` `FOK` `GTX`
**type:** `LIMIT`
FILE:references/crypto-loan.md
## Flexible Rate (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| check-collateral-repay-rate | `loan-coin` `collateral-coin` [] | Check Collateral Repay Rate |
| flexible-loan-adjust-ltv | `loan-coin` `collateral-coin` `adjustment-amount` `direction` [] | Flexible Loan Adjust LTV |
| flexible-loan-borrow | `loan-coin` `collateral-coin` [`loan-amount` `collateral-amount`] | Flexible Loan Borrow |
| flexible-loan-repay | `loan-coin` `collateral-coin` `repay-amount` [`collateral-return` `full-repayment` `repayment-type`] | Flexible Loan Repay |
| get-flexible-loan-assets-data | [`loan-coin`] | Get Flexible Loan Assets Data |
| get-flexible-loan-borrow-history | [`loan-coin` `collateral-coin` `start-time` `end-time` `current` `limit`] | Get Flexible Loan Borrow History |
| get-flexible-loan-collateral-assets-data | [`collateral-coin`] | Get Flexible Loan Collateral Assets Data |
| get-flexible-loan-interest-rate-history | `coin` [`start-time` `end-time` `current` `limit`] | Get Flexible Loan Interest Rate History |
| get-flexible-loan-liquidation-history | [`loan-coin` `collateral-coin` `start-time` `end-time` `current` `limit`] | Get Flexible Loan Liquidation History |
| get-flexible-loan-ltv-adjustment-history | [`loan-coin` `collateral-coin` `start-time` `end-time` `current` `limit`] | Get Flexible Loan LTV Adjustment History |
| get-flexible-loan-ongoing-orders | [`loan-coin` `collateral-coin` `current` `limit`] | Get Flexible Loan Ongoing Orders |
| get-flexible-loan-repayment-history | [`loan-coin` `collateral-coin` `start-time` `end-time` `current` `limit`] | Get Flexible Loan Repayment History |
## Stable Rate (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| check-collateral-repay-rate-stable-rate | `loan-coin` `collateral-coin` `repay-amount` [] | Check Collateral Repay Rate |
| get-crypto-loans-income-history | [`asset` `type` `start-time` `end-time` `limit`] | Get Crypto Loans Income History |
| get-loan-borrow-history | [`order-id` `loan-coin` `collateral-coin` `start-time` `end-time` `current` `limit`] | Get Loan Borrow History |
| get-loan-ltv-adjustment-history | [`order-id` `loan-coin` `collateral-coin` `start-time` `end-time` `current` `limit`] | Get Loan LTV Adjustment History |
| get-loan-repayment-history | [`order-id` `loan-coin` `collateral-coin` `start-time` `end-time` `current` `limit`] | Get Loan Repayment History |
FILE:references/simple-earn.md
## Bfusd (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-bfusd-account | [] | Get BFUSD Account |
| get-bfusd-quota-details | [] | Get BFUSD Quota Details |
| get-bfusd-rate-history | [`start-time` `end-time` `current` `size`] | Get BFUSD Rate History |
| get-bfusd-redemption-history | [`start-time` `end-time` `current` `size`] | Get BFUSD Redemption History |
| get-bfusd-rewards-history | [`start-time` `end-time` `current` `size`] | Get BFUSD Rewards History |
| get-bfusd-subscription-history | [`asset` `start-time` `end-time` `current` `size`] | Get BFUSD subscription history |
| redeem-bfusd | `amount` `type` [] | Redeem BFUSD |
| subscribe-bfusd | `asset` `amount` [] | Subscribe BFUSD |
## Flexible Locked (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-collateral-record | [`product-id` `start-time` `end-time` `current` `size`] | Get Collateral Record |
| get-flexible-personal-left-quota | `product-id` [] | Get Flexible Personal Left Quota |
| get-flexible-product-position | [`asset` `product-id` `current` `size`] | Get Flexible Product Position |
| get-flexible-redemption-record | [`product-id` `redeem-id` `asset` `start-time` `end-time` `current` `size`] | Get Flexible Redemption Record |
| get-flexible-rewards-history | `type` [`product-id` `asset` `start-time` `end-time` `current` `size`] | Get Flexible Rewards History |
| get-flexible-subscription-preview | `product-id` `amount` [] | Get Flexible Subscription Preview |
| get-flexible-subscription-record | [`product-id` `purchase-id` `asset` `start-time` `end-time` `current` `size`] | Get Flexible Subscription Record |
| get-locked-personal-left-quota | `project-id` [] | Get Locked Personal Left Quota |
| get-locked-product-position | [`asset` `position-id` `project-id` `current` `size`] | Get Locked Product Position |
| get-locked-redemption-record | [`position-id` `redeem-id` `asset` `start-time` `end-time` `current` `size`] | Get Locked Redemption Record |
| get-locked-rewards-history | [`position-id` `asset` `start-time` `end-time` `current` `size`] | Get Locked Rewards History |
| get-locked-subscription-preview | `project-id` `amount` [`auto-subscribe`] | Get Locked Subscription Preview |
| get-locked-subscription-record | [`purchase-id` `asset` `start-time` `end-time` `current` `size`] | Get Locked Subscription Record |
| get-rate-history | `product-id` [`apr-period` `start-time` `end-time` `current` `size`] | Get Rate History |
| get-simple-earn-flexible-product-list | [`asset` `current` `size`] | Get Simple Earn Flexible Product List |
| get-simple-earn-locked-product-list | [`asset` `current` `size`] | Get Simple Earn Locked Product List |
| redeem-flexible-product | `product-id` [`redeem-all` `amount` `dest-account`] | Redeem Flexible Product |
| redeem-locked-product | `position-id` [] | Redeem Locked Product |
| set-flexible-auto-subscribe | `product-id` `auto-subscribe` [] | Set Flexible Auto Subscribe |
| set-locked-auto-subscribe | `position-id` `auto-subscribe` [] | Set Locked Auto Subscribe |
| set-locked-product-redeem-option | `position-id` `redeem-to` [] | Set Locked Product Redeem Option |
| simple-account | [] | Simple Account |
| subscribe-flexible-product | `product-id` `amount` [`auto-subscribe` `source-account`] | Subscribe Flexible Product |
| subscribe-locked-product | `project-id` `amount` [`auto-subscribe` `source-account` `redeem-to`] | Subscribe Locked Product |
## Rwusd (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| get-rwusd-account | [] | Get RWUSD Account |
| get-rwusd-quota-details | [] | Get RWUSD Quota Details |
| get-rwusd-rate-history | [`start-time` `end-time` `current` `size`] | Get RWUSD Rate History |
| get-rwusd-redemption-history | [`start-time` `end-time` `current` `size`] | Get RWUSD Redemption History |
| get-rwusd-rewards-history | [`start-time` `end-time` `current` `size`] | Get RWUSD Rewards History |
| get-rwusd-subscription-history | [`asset` `start-time` `end-time` `current` `size`] | Get RWUSD subscription history |
| redeem-rwusd | `amount` `type` [] | Redeem RWUSD |
| subscribe-rwusd | `asset` `amount` [] | Subscribe RWUSD |
FILE:references/futures-coin.md
## Account (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-information | [] | Account Information |
| futures-account-balance | [] | Futures Account Balance |
| get-current-position-mode | [] | Get Current Position Mode |
| get-download-id-for-futures-order-history | `start-time` `end-time` [] | Get Download Id For Futures Order History |
| get-download-id-for-futures-trade-history | `start-time` `end-time` [] | Get Download Id For Futures Trade History |
| get-download-id-for-futures-transaction-history | `start-time` `end-time` [] | Get Download Id For Futures Transaction History |
| get-futures-order-history-download-link-by-id | `download-id` [] | Get Futures Order History Download Link by Id |
| get-futures-trade-download-link-by-id | `download-id` [] | Get Futures Trade Download Link by Id |
| get-futures-transaction-history-download-link-by-id | `download-id` [] | Get Futures Transaction History Download Link by Id |
| get-income-history | [`symbol` `income-type` `start-time` `end-time` `page` `limit`] | Get Income History |
| notional-bracket-for-pair | [`pair`] | Notional Bracket for Pair |
| notional-bracket-for-symbol | [`symbol`] | Notional Bracket for Symbol |
| user-commission-rate | `symbol` [] | User Commission Rate |
## Market Data
| Endpoint | Key params | Description |
|---|---|---|
| basis | `pair` `contract-type` `period` [`limit` `start-time` `end-time`] | Basis |
| check-server-time | [] | Check Server time |
| compressed-aggregate-trades-list | `symbol` [`from-id` `start-time` `end-time` `limit`] | Compressed/Aggregate Trades List |
| continuous-contract-kline-candlestick-data | `pair` `contract-type` `interval` [`start-time` `end-time` `limit`] | Continuous Contract Kline/Candlestick Data |
| exchange-information | [] | Exchange Information |
| get-funding-rate-history-of-perpetual-futures | `symbol` [`start-time` `end-time` `limit`] | Get Funding Rate History of Perpetual Futures |
| get-funding-rate-info | [] | Get Funding Rate Info |
| index-price-and-mark-price | [`symbol` `pair`] | Index Price and Mark Price |
| index-price-kline-candlestick-data | `pair` `interval` [`start-time` `end-time` `limit`] | Index Price Kline/Candlestick Data |
| kline-candlestick-data | `symbol` `interval` [`start-time` `end-time` `limit`] | Kline/Candlestick Data |
| long-short-ratio | `pair` `period` [`limit` `start-time` `end-time`] | Long/Short Ratio |
| mark-price-kline-candlestick-data | `symbol` `interval` [`start-time` `end-time` `limit`] | Mark Price Kline/Candlestick Data |
| old-trades-lookup | `symbol` [`limit` `from-id`] | Old Trades Lookup |
| open-interest | `symbol` [] | Open Interest |
| open-interest-statistics | `pair` `contract-type` `period` [`limit` `start-time` `end-time`] | Open Interest Statistics |
| order-book | `symbol` [`limit`] | Order Book |
| premium-index-kline-data | `symbol` `interval` [`start-time` `end-time` `limit`] | Premium index Kline Data |
| query-index-price-constituents | `symbol` [] | Query Index Price Constituents |
| recent-trades-list | `symbol` [`limit`] | Recent Trades List |
| symbol-order-book-ticker | [`symbol` `pair`] | Symbol Order Book Ticker |
| symbol-price-ticker | [`symbol` `pair`] | Symbol Price Ticker |
| taker-buy-sell-volume | `pair` `contract-type` `period` [`limit` `start-time` `end-time`] | Taker Buy/Sell Volume |
| test-connectivity | [] | Test Connectivity |
| ticker24hr-price-change-statistics | [`symbol` `pair`] | 24hr Ticker Price Change Statistics |
| top-trader-long-short-ratio-accounts | `symbol` `period` [`limit` `start-time` `end-time`] | Top Trader Long/Short Ratio (Accounts) |
| top-trader-long-short-ratio-positions | `pair` `period` [`limit` `start-time` `end-time`] | Top Trader Long/Short Ratio (Positions) |
## Portfolio Margin Endpoints (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| classic-portfolio-margin-account-information | `asset` [] | Classic Portfolio Margin Account Information |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| account-trade-list | [`symbol` `pair` `order-id` `start-time` `end-time` `from-id` `limit`] | Account Trade List |
| all-orders | [`symbol` `pair` `order-id` `start-time` `end-time` `limit`] | All Orders |
| auto-cancel-all-open-orders | `symbol` `countdown-time` [] | Auto-Cancel All Open Orders |
| cancel-all-open-orders | `symbol` [] | Cancel All Open Orders |
| cancel-multiple-orders | `symbol` [`order-id-list` `orig-client-order-id-list`] | Cancel Multiple Orders |
| cancel-order | `symbol` [`order-id` `orig-client-order-id`] | Cancel Order |
| change-initial-leverage | `symbol` `leverage` [] | Change Initial Leverage |
| change-margin-type | `symbol` `margin-type` [] | Change Margin Type |
| change-position-mode | `dual-side-position` [] | Change Position Mode |
| current-all-open-orders | [`symbol` `pair`] | Current All Open Orders |
| get-order-modify-history | `symbol` [`order-id` `orig-client-order-id` `start-time` `end-time` `limit`] | Get Order Modify History |
| get-position-margin-change-history | `symbol` [`type` `start-time` `end-time` `limit`] | Get Position Margin Change History |
| modify-isolated-position-margin | `symbol` `amount` `type` [`position-side`] | Modify Isolated Position Margin |
| modify-multiple-orders | `batch-orders` [] | Modify Multiple Orders |
| modify-order | `symbol` `side` [`order-id` `orig-client-order-id` `quantity` `price` `price-match`] | Modify Order |
| new-order | `symbol` `side` `type` [`position-side` `time-in-force` `quantity` `reduce-only` `price` `new-client-order-id` `stop-price` `close-position` `activation-price` `callback-rate` `working-type` `price-protect` `new-order-resp-type` `price-match` `self-trade-prevention-mode`] | New Order |
| place-multiple-orders | `batch-orders` [] | Place Multiple Orders |
| position-adl-quantile-estimation | [`symbol`] | Position ADL Quantile Estimation |
| position-information | [`margin-asset` `pair`] | Position Information |
| query-current-open-order | `symbol` [`order-id` `orig-client-order-id`] | Query Current Open Order |
| query-order | `symbol` [`order-id` `orig-client-order-id`] | Query Order |
| users-force-orders | [`symbol` `auto-close-type` `start-time` `end-time` `limit`] | User\'s Force Orders |
## User Data Streams
| Endpoint | Key params | Description |
|---|---|---|
| close-user-data-stream | [] | Close User Data Stream |
| keepalive-user-data-stream | [] | Keepalive User Data Stream |
| start-user-data-stream | [] | Start User Data Stream |
### Enums
**auto-close-type:** `LIQUIDATION` `ADL`
**contract-type:** `PERPETUAL` `CURRENT_QUARTER` `NEXT_QUARTER` `CURRENT_QUARTER_DELIVERING` `NEXT_QUARTER_DELIVERING` `PERPETUAL_DELIVERING`
**interval:** `1m` `3m` `5m` `15m` `30m` `1h` `2h` `4h` `6h` `8h` `12h` `1d` `3d` `1w` `1M`
**margin-type:** `ISOLATED` `CROSSED`
**new-order-resp-type:** `ACK` `RESULT`
**period:** `5m` `15m` `30m` `1h` `2h` `4h` `6h` `12h` `1d`
**position-side:** `BOTH` `LONG` `SHORT`
**price-match:** `NONE` `OPPONENT` `OPPONENT_5` `OPPONENT_10` `OPPONENT_20` `QUEUE` `QUEUE_5` `QUEUE_10` `QUEUE_20`
**self-trade-prevention-mode:** `NONE` `EXPIRE_TAKER` `EXPIRE_BOTH` `EXPIRE_MAKER`
**side:** `BUY` `SELL`
**time-in-force:** `GTC` `IOC` `FOK` `GTX`
**type:** `LIMIT` `MARKET` `STOP` `STOP_MARKET` `TAKE_PROFIT` `TAKE_PROFIT_MARKET` `TRAILING_STOP_MARKET`
**working-type:** `MARK_PRICE` `CONTRACT_PRICE`
FILE:references/convert.md
## Market Data
| Endpoint | Key params | Description |
|---|---|---|
| list-all-convert-pairs | [`from-asset` `to-asset`] | List All Convert Pairs |
| query-order-quantity-precision-per-asset | [] | Query order quantity precision per asset |
## Trade (auth required)
| Endpoint | Key params | Description |
|---|---|---|
| accept-quote | `quote-id` [] | Accept Quote |
| cancel-limit-order | `order-id` [] | Cancel limit order |
| get-convert-trade-history | `start-time` `end-time` [`limit`] | Get Convert Trade History |
| order-status | [`order-id` `quote-id`] | Order status |
| place-limit-order | `base-asset` `quote-asset` `limit-price` `side` `expired-type` [`base-amount` `quote-amount` `wallet-type`] | Place limit order |
| query-limit-open-orders | [] | Query limit open orders |
| send-quote-request | `from-asset` `to-asset` [`from-amount` `to-amount` `wallet-type` `valid-time`] | Send Quote Request |Query token details by keyword, contract address, or chain. Search tokens, get metadata and social links, retrieve real-time market data (price, price trend,...
---
name: query-token-info
description: |
Query token details by keyword, contract address, or chain. Search tokens, get metadata and social links,
retrieve real-time market data (price, price trend, volume, holders, liquidity), and fetch K-Line candlestick charts.
Use this skill when users search tokens, check token prices, view market data, or request kline/candlestick charts.
metadata:
author: binance-web3-team
version: "1.0"
---
# Query Token Info Skill
## Overview
| API | Function | Use Case |
|-----|----------|----------|
| Token Search | Search tokens | Find tokens by name, symbol, or contract address |
| Token Metadata | Static info | Get token details,name,symbol,logo, social links, creator address |
| Token Dynamic Data | Real-time market data | Price, volume, holders, liquidity, market cap |
| Token K-Line | Candlestick charts | OHLCV data for technical analysis |
## Use Cases
1. **Search Tokens**: Find tokens by name, symbol, or contract address across chains
2. **Project Research**: Get token metadata, social links, and creator info
3. **Market Analysis**: Real-time price, volume, holder distribution, and liquidity data
4. **Chart Analysis**: K-Line candlestick data for technical analysis
## Supported Chains
| Chain Name | chainId |
|------------|---------|
| BSC | 56 |
| Base | 8453 |
| Solana | CT_501 |
---
## API 1: Token Search
### Method: GET
**URL**:
```
https://web3.binance.com/bapi/defi/v5/public/wallet-direct/buw/wallet/market/token/search
```
**Request Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| keyword | string | Yes | Search keyword (name/symbol/contract address) |
| chainIds | string | No | Chain ID list, comma-separated, e.g., `56,8453,CT_501` |
| orderBy | string | No | Sort field, e.g., `volume24h` |
**Request Headers**:
```
Accept-Encoding: identity
User-Agent: binance-web3/1.0 (Skill)
```
**Example Request**:
```bash
curl --location 'https://web3.binance.com/bapi/defi/v5/public/wallet-direct/buw/wallet/market/token/search?keyword=xxx&chainIds=56,8453,CT_501&orderBy=volume24h' \
--header 'Accept-Encoding: identity' \
--header 'User-Agent: binance-web3/1.0 (Skill)'
```
**Response Example**:
```json
{
"code": "000000",
"data": [
{
"chainId": "56",
"contractAddress": "0x1234...",
"tokenId": "CC1F457...",
"name": "Token",
"symbol": "symbol of token",
"icon": "/images/web3-data/public/token/logos/xxx.png",
"price": "47.98771375939603199404",
"percentChange24h": "-0.01",
"volume24h": "53687246.955803546359104902201",
"marketCap": "162198400",
"liquidity": "13388877.147327333572157",
"tokenAddresses": [...],
"tagsInfo": {
"AI Analysis": [{"tagName": "AI Widget", "languageKey": "wmp-label-title-ai-widget"}],
"Community Recognition Level": [{"tagName": "Alpha", "languageKey": "wmp-label-title-alpha"}]
},
"links": [
{"label": "website", "link": "https://www.web.site/"},
{"label": "x", "link": "https://twitter.com/..."}
],
"createTime": 1600611727000,
"holdersTop10Percent": "93.267178480644823",
"riskLevel": null
}
],
"success": true
}
```
**Response Fields**:
| Field | Type | Description |
|-------|------|-------------|
| chainId | string | Chain ID |
| contractAddress | string | Contract address |
| tokenId | string | Token unique ID |
| name | string | Token name |
| symbol | string | Token symbol |
| icon | string | Icon URL path |
| price | string | Current price (USD) |
| percentChange24h | string | 24-hour price change (%) |
| volume24h | string | 24-hour trading volume (USD) |
| marketCap | string | Market cap (USD) |
| liquidity | string | Liquidity (USD) |
| tagsInfo | object | Tag information |
| links | array | Social links list |
| createTime | number | Creation timestamp (ms) |
| holdersTop10Percent | string | Top 10 holders percentage (%) |
---
## API 2: Token Metadata
### Method: GET
**URL**:
```
https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/dex/market/token/meta/info
```
**Request Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| chainId | string | Yes | Chain ID |
| contractAddress | string | Yes | Token contract address |
**Request Headers**:
```
Accept-Encoding: identity
User-Agent: binance-web3/1.0 (Skill)
```
**Example Request**:
```bash
curl --location 'https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/dex/market/token/meta/info?chainId=56&contractAddress=0x55d398326f99059ff775485246999027b3197955' \
--header 'Accept-Encoding: identity' \
--header 'User-Agent: binance-web3/1.0 (Skill)'
```
**Response Example**:
```json
{
"code": "000000",
"data": {
"tokenId": "CC1F457B",
"name": "name of Token",
"symbol": "symbol of token",
"chainId": "56",
"chainIconUrl": "https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250228/d0216ce4-a3e9-4bda-8937-4a6aa943ccf2.png",
"chainName": "BSC",
"contractAddress": "0x55d398326f99059ff775485246999027b3197955",
"decimals": 18,
"icon": "/images/web3-data/public/token/logos/xxx.png",
"nativeAddressFlag": false,
"aiNarrativeFlag": 1,
"links": [
{"label": "website", "link": "https://www.web.site/"},
{"label": "whitepaper", "link": "https://drive.google.com/file/d/..."},
{"label": "x", "link": "https://twitter.com/..."}
],
"previewLink": {
"website": ["https://www.web.site/"],
"x": ["https://twitter.com/..."],
"tg": []
},
"createTime": 1600611727000,
"creatorAddress": "0x1234...",
"auditInfo": {
"isBlacklist": false,
"isWhitelist": true
},
"description": "this is a good token..."
},
"success": true
}
```
**Response Fields**:
| Field | Type | Description |
|-------|------|-------------|
| tokenId | string | Token unique ID |
| name | string | Token name |
| symbol | string | Token symbol |
| chainId | string | Chain ID |
| chainName | string | Chain name |
| contractAddress | string | Contract address |
| decimals | number | Token decimals |
| icon | string | Icon URL path |
| links | array | Social links list |
| createTime | number | Creation timestamp (ms) |
| creatorAddress | string | Creator address |
| description | string | Token description |
---
## API 3: Token Dynamic Data
### Method: GET
**URL**:
```
https://web3.binance.com/bapi/defi/v4/public/wallet-direct/buw/wallet/market/token/dynamic/info
```
**Request Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| chainId | string | Yes | Chain ID |
| contractAddress | string | Yes | Token contract address |
**Request Headers**:
```
Accept-Encoding: identity
User-Agent: binance-web3/1.0 (Skill)
```
**Example Request**:
```bash
curl --location 'https://web3.binance.com/bapi/defi/v4/public/wallet-direct/buw/wallet/market/token/dynamic/info?chainId=56&contractAddress=0x55d398326f99059ff775485246999027b3197955' \
--header 'Accept-Encoding: identity' \
--header 'User-Agent: binance-web3/1.0 (Skill)'
```
**Response Example**:
```json
{
"code": "000000",
"data": {
"price": "48.00617218672732466029",
"nativeTokenPrice": "589.09115969567768209591",
"volume24h": "53803143.235015073706599196363",
"volume24hBuy": "26880240.472839229350983682189",
"volume24hSell": "26922902.762175844355615514174",
"volume4h": "7179919.170580971950485838372",
"volume1h": "3181854.878039371691111933489",
"volume5m": "84557.068962077549412188792",
"count24h": "39869",
"count24hBuy": "19850",
"count24hSell": "20019",
"percentChange5m": "0.03",
"percentChange1h": "0.02",
"percentChange4h": "0.03",
"percentChange24h": "0.01",
"marketCap": "162260777.94315716831842935701774977509483735135",
"totalSupply": "3379998.56",
"circulatingSupply": "3379998.249225519124584315",
"priceHigh24h": "48.59526604943723770716",
"priceLow24h": "47.4815509902145490401",
"holders": "78255",
"fdv": "162260792.8622504084644326891824",
"liquidity": "13393863.149264026822944",
"launchTime": 1600950241000,
"top10HoldersPercentage": "93.2621248736909194",
"kycHolderCount": "23579",
"kolHolders": "17",
"kolHoldingPercent": "0.000059",
"proHolders": "138",
"proHoldingPercent": "0.003357",
"smartMoneyHolders": "1",
"smartMoneyHoldingPercent": "0"
},
"success": true
}
```
**Response Fields**:
### Price Related
| Field | Type | Description |
|-------|------|-------------|
| price | string | Current price (USD) |
| nativeTokenPrice | string | Native token price |
| priceHigh24h | string | 24-hour high price |
| priceLow24h | string | 24-hour low price |
### Price Change
| Field | Type | Description |
|-------|------|-------------|
| percentChange5m | string | 5-minute price change (%) |
| percentChange1h | string | 1-hour price change (%) |
| percentChange4h | string | 4-hour price change (%) |
| percentChange24h | string | 24-hour price change (%) |
### Volume
| Field | Type | Description |
|-------|------|-------------|
| volume24h | string | 24-hour total volume (USD) |
| volume24hBuy | string | 24-hour buy volume |
| volume24hSell | string | 24-hour sell volume |
| volume4h | string | 4-hour volume |
| volume1h | string | 1-hour volume |
| volume5m | string | 5-minute volume |
### Transaction Count
| Field | Type | Description |
|-------|------|-------------|
| count24h | string | 24-hour transaction count |
| count24hBuy | string | 24-hour buy count |
| count24hSell | string | 24-hour sell count |
### Market Data
| Field | Type | Description |
|-------|------|-------------|
| marketCap | string | Market cap (USD) |
| fdv | string | Fully diluted valuation |
| totalSupply | string | Total supply |
| circulatingSupply | string | Circulating supply |
| liquidity | string | Liquidity (USD) |
### Holder Data
| Field | Type | Description |
|-------|------|-------------|
| holders | string | Total holder count |
| top10HoldersPercentage | string | Top 10 holders percentage (%) |
| kycHolderCount | string | KYC holder count |
| kolHolders | string | KOL holder count |
| kolHoldingPercent | string | KOL holding percentage |
| devHoldingPercent| string | Dev holding percentage |
| proHoldingPercent | string | Professional investor holding percentage |
| smartMoneyHoldingPercent | string | Smart money holding percentage |
---
## API 4: Token K-Line (Candlestick)
### Method: GET
**URL**:
```
https://dquery.sintral.io/u-kline/v1/k-line/candles
```
**Request Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| address | string | Yes | Token contract address |
| platform | string | Yes | Chain platform: `ethereum`, `bsc`, `solana`, `base` |
| interval | string | Yes | Kline interval (see Interval Reference below) |
| limit | number | No | Number of candles to return (has higher priority than `from`) |
| from | number | No | Start timestamp in milliseconds |
| to | number | No | End timestamp in milliseconds |
| pm | string | No | Kline type: `p` for price, `m` for market cap (default: `p`) |
**Interval Reference**:
| Interval | Description |
|----------|-------------|
| 1s | 1 second |
| 1min | 1 minute |
| 3min | 3 minutes |
| 5min | 5 minutes |
| 15min | 15 minutes |
| 30min | 30 minutes |
| 1h | 1 hour |
| 2h | 2 hours |
| 4h | 4 hours |
| 6h | 6 hours |
| 8h | 8 hours |
| 12h | 12 hours |
| 1d | 1 day |
| 3d | 3 days |
| 1w | 1 week |
| 1m | 1 month |
**Platform Mapping**:
| Chain | platform value |
|-------|---------------|
| Ethereum | ethereum |
| BSC | bsc |
| Solana | solana |
| Base | base |
**Request Headers**:
```
Accept-Encoding: identity
User-Agent: binance-web3/1.0 (Skill)
```
**Example Request**:
```bash
curl --location 'https://dquery.sintral.io/u-kline/v1/k-line/candles?address=0x55d398326f99059ff775485246999027b3197955&interval=1min&limit=500&platform=bsc&to=1772126280000' \
--header 'Accept-Encoding: identity' \
--header 'User-Agent: binance-web3/1.0 (Skill)'
```
**Response Example**:
```json
{
"data": [
[0.10779318, 0.10779318, 0.10778039, 0.10778039, 2554.06, 1772125800000, 3],
[0.10778039, 0.10781213, 0.10770104, 0.10770104, 2994.53, 1772125920000, 3],
[0.10770104, 0.10770104, 0.10769200, 0.10769200, 2825.65, 1772126040000, 3],
[0.10769200, 0.10777858, 0.10766827, 0.10777858, 2457.99, 1772126160000, 3],
[0.10777858, 0.10778521, 0.10764351, 0.10764351, 3106.87, 1772126280000, 4]
],
"status": {
"timestamp": "2026-02-28T05:52:25.717Z",
"error_code": "0",
"error_message": "SUCCESS",
"elapsed": "0",
"credit_count": 0
}
}
```
**Response Fields**:
Each candle is an array with 7 elements in order:
| Index | Field | Type | Description |
|-------|-------|------|-------------|
| 0 | open | number | Open price |
| 1 | high | number | High price |
| 2 | low | number | Low price |
| 3 | close | number | Close price |
| 4 | volume | number | Trading volume |
| 5 | timestamp | number | Candle timestamp (ms) |
| 6 | count | number | Transaction count |
---
## User Agent Header
Include `User-Agent` header with the following string: `binance-web3/1.0 (Skill)`
## Notes
1. Icon URL requires full domain prefix: `https://bin.bnbstatic.com` + icon path
2. All numeric fields are string format, convert when using
3. Dynamic data updates in real-time, suitable for market display
4. K-Line API uses `platform` (eth/bsc/solana/base) instead of `chainId`, and `limit` takes priority over `from` when both are provided
5. K-Line response is a 2D array (not JSON objects) — parse by index: [open, high, low, close, volume, timestamp, count]
Query any on-chain wallet address token balances and positions. Retrieves all token holdings for a specified wallet address on a given chain, including token...
---
name: query-address-info
description: |
Query any on-chain wallet address token balances and positions. Retrieves all token holdings for a specified wallet address on a given chain,
including token name, symbol, price, 24h price change, and holding quantity.
Use this skill when users ask about wallet balance, token holds, portfolio, or asset positions for any blockchain address.
metadata:
author: binance-web3-team
version: "1.0"
---
# Query Address Info Skill
## Overview
This skill queries any on-chain wallet address for token holdings, supporting:
- List of all tokens held by a wallet address
- Current price of each token
- 24-hour price change percentage
- Holding quantity
## API Endpoint
### Query Wallet Token Balance
**Method**: GET
**URL**:
```
https://web3.binance.com/bapi/defi/v3/public/wallet-direct/buw/wallet/address/pnl/active-position-list
```
**Request Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| address | string | Yes | Wallet address, e.g., `0x0000000000000000000000000000000000000001` |
| chainId | string | Yes | Chain ID, e.g., `56` (BSC), `8453` (Base) |
| offset | number | Yes | Pagination offset, default 0 |
**Request Headers**:
```
clienttype: web
clientversion: 1.2.0
Accept-Encoding: identity
User-Agent: binance-web3/1.0 (Skill)
```
**Example Request**:
```bash
curl --location 'https://web3.binance.com/bapi/defi/v3/public/wallet-direct/buw/wallet/address/pnl/active-position-list?address=0x0000000000000000000000000000000000000001&chainId=56&offset=0' \
--header 'clienttype: web' \
--header 'clientversion: 1.2.0' \
--header 'Accept-Encoding: identity' \
--header 'User-Agent: binance-web3/1.0 (Skill)'
```
**Response Example**:
```json
{
"code": "000000",
"message": null,
"messageDetail": null,
"data": {
"offset": 0,
"addressStatus": null,
"list": [
{
"chainId": "56",
"address": "0x0000000000000000000000000000000000000001",
"contractAddress": "token contract address",
"name": "name of token",
"symbol": "symbol of token",
"icon": "/images/web3-data/public/token/logos/xxxx.png",
"decimals": 18,
"price": "0.0000045375251839978",
"percentChange24h": "6.84",
"remainQty": "20"
}
]
},
"success": true
}
```
**Response Fields**:
| Field | Type | Description |
|-------|------|-------------|
| chainId | string | Chain ID |
| address | string | Wallet address |
| contractAddress | string | Token contract address |
| name | string | Token name |
| symbol | string | Token symbol |
| icon | string | Token icon URL path |
| decimals | number | Token decimals |
| price | string | Current price (USD) |
| percentChange24h | string | 24-hour price change (%) |
| remainQty | string | Holding quantity |
## Supported Chains
| Chain Name | chainId |
|------------|---------|
| BSC | 56 |
| Base | 8453 |
| Solana | CT_501 |
## Use Cases
1. **Query Wallet Assets**: When users want to view tokens held by a wallet address
2. **Track Holdings**: Monitor wallet token positions
3. **Portfolio Analysis**: Understand wallet asset allocation
## User Agent Header
Include `User-Agent` header with the following string: `binance-web3/1.0 (Skill)`
## Notes
1. Icon URL requires full domain prefix: `bin.bnbstatic.com` + icon path
2. Price and quantity are string format, convert to numbers when using
3. Use offset parameter for pagination
Meme token fast-trading assistant with two core capabilities: 1. Meme Rush - Real-time meme token lists from launchpads (Pump.fun, Four.meme, etc.) across ne...
---
name: meme-rush
description: |
Meme token fast-trading assistant with two core capabilities:
1. Meme Rush - Real-time meme token lists from launchpads (Pump.fun, Four.meme, etc.) across new, finalizing, and migrated stages
2. Topic Rush - AI-powered market hot topics with associated tokens ranked by net inflow
Use this skill when users ask about new meme tokens, meme launches, bonding curve, migration status,
pump.fun tokens, four.meme tokens, fast meme trading, market hot topics, or trending narratives.
metadata:
author: binance-web3-team
version: "1.0"
---
# Meme Rush Skill
## Overview
### Meme Rush — Launchpad token lifecycle tracking
| rankType | Stage | Description |
|----------|-------|-------------|
| 10 | New | Freshly created meme tokens still on bonding curve |
| 20 | Finalizing | Tokens about to migrate (bonding curve nearly complete) |
| 30 | Migrated | Tokens that just migrated to DEX |
### Topic Rush — AI-powered market hot topic discovery
| rankType | Stage | Description |
|----------|-------|-------------|
| 10 | Latest | Newest hot topics |
| 20 | Rising | Rising topics with all-time high inflow between $1k–$20k |
| 30 | Viral | Viral topics with all-time high inflow above $20k |
## Use Cases
1. **Snipe New Launches**: Find freshly created meme tokens on Pump.fun, Four.meme, etc.
2. **Migration Watch**: Monitor tokens about to migrate — catch early DEX liquidity
3. **Post-Migration Trading**: Find just-migrated tokens for early DEX entry
4. **Filter by Dev Behavior**: Exclude dev wash trading, check dev sell %, burned tokens
5. **Holder Analysis**: Filter by top10 %, dev %, sniper %, insider %, bundler % holdings
6. **Smart Filtering**: Combine bonding curve progress, liquidity, volume, market cap filters
7. **Topic Discovery**: Find AI-generated market hot topics and their associated tokens
8. **Narrative Trading**: Trade tokens grouped by trending narratives, sorted by net inflow
## Supported Chains
| Chain | chainId |
|-------|---------|
| BSC | 56 |
| Solana | CT_501 |
## Protocol Reference
| Protocol Code | Platform | Chain |
|---------------|----------|-------|
| 1001 | Pump.fun | Solana |
| 1002 | Moonit | Solana |
| 1003 | Pump AMM | Solana |
| 1004 | Launch Lab | Solana |
| 1005 | Raydium V4 | Solana |
| 1006 | Raydium CPMM | Solana |
| 1007 | Raydium CLMM | Solana |
| 1008 | BONK | Solana |
| 1009 | Dynamic BC | Solana |
| 1010 | Moonshot | Solana |
| 1011 | Jup Studio | Solana |
| 1012 | Bags | Solana |
| 1013 | Believer | Solana |
| 1014 | Meteora DAMM V2 | Solana |
| 1015 | Meteora Pools | Solana |
| 1016 | Orca | Solana |
| 2001 | Four.meme | BSC |
| 2002 | Flap | BSC |
---
## API 1: Meme Rush Rank List
### Method: POST
**URL**:
```
https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/pulse/rank/list
```
**Headers**: `Content-Type: application/json`, `Accept-Encoding: identity`
### Request Body
**Required Parameters**:
| Field | Type | Description |
|-------|------|-------------|
| chainId | string | Chain ID: `56` for bsc, `CT_501` for solana |
| rankType | integer | `10`=New, `20`=Finalizing, `30`=Migrated |
**Pagination & Keyword**:
| Field | Type | Description |
|-------|------|-------------|
| limit | integer | Max results per request (default 40, max 200) |
| keywords | string[] | Include symbols matching keywords (max 5) |
| excludes | string[] | Exclude symbols (max 5) |
**Token Filters (Min/Max pairs)**:
| Filter | Type | Description |
|--------|------|-------------|
| progressMin/Max | string | Bonding curve progress (0-100%) |
| tokenAgeMin/Max | long | Token age |
| holdersMin/Max | long | Holder count |
| liquidityMin/Max | string | Liquidity (USD) |
| volumeMin/Max | string | 24h volume (USD) |
| marketCapMin/Max | string | Market cap (USD) |
| countMin/Max | long | Total trade count |
| countBuyMin/Max | long | Buy trade count |
| countSellMin/Max | long | Sell trade count |
**Holder Distribution Filters (Min/Max pairs)**:
| Filter | Type | Description |
|--------|------|-------------|
| holdersTop10PercentMin/Max | string | Top10 holder % |
| holdersDevPercentMin/Max | string | Dev holder % |
| holdersSniperPercentMin/Max | string | Sniper holder % |
| holdersInsiderPercentMin/Max | string | Insider holder % |
| bundlerHoldingPercentMin/Max | string | Bundler holder % |
| newWalletHoldingPercentMin/Max | string | New wallet holder % |
| bnHoldingPercentMin/Max | string | Binance wallet holder % |
| bnHoldersMin/Max | long | Binance wallet holder count |
| kolHoldersMin/Max | long | KOL holder count |
| proHoldersMin/Max | long | Pro holder count |
**Dev & Launch Filters**:
| Field | Type | Description |
|-------|------|-------------|
| devMigrateCountMin/Max | long | Dev historical migration count |
| devPosition | integer | Dev position: `2`=dev sold all (pass when checked) |
| devBurnedToken | integer | Dev burned tokens: `1`=yes |
| excludeDevWashTrading | integer | Exclude dev wash trading: `1`=yes |
| excludeInsiderWashTrading | integer | Exclude insider wash trading: `1`=yes |
**Other Filters**:
| Field | Type | Description |
|-------|------|-------------|
| protocol | integer[] | Launchpad protocol codes (see Protocol Reference) |
| exclusive | integer | Binance exclusive token: `0`=no, `1`=yes |
| paidOnDexScreener | integer | Paid on DexScreener |
| pumpfunLiving | integer | Pump.fun live stream: `1`=yes |
| cmcBoost | integer | CMC paid boost: `1`=yes |
| globalFeeMin/Max | string | Trading fee (Solana only) |
| pairAnchorAddress | string[] | Quote token addresses |
| tokenSocials.atLeastOne | integer | Has at least one social: `1`=yes |
| tokenSocials.socials | string[] | Specific socials: `website`, `twitter`, `telegram` |
### Example Request
```bash
curl -X POST 'https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/pulse/rank/list' \
-H 'Content-Type: application/json' \
-H 'Accept-Encoding: identity' \
-H 'User-Agent: binance-web3/1.0 (Skill)' \
-d '{"chainId":"CT_501","rankType":10,"limit":20}'
```
### Response (`data[]`)
**Core Fields**:
| Field | Type | Description |
|-------|------|-------------|
| chainId | string | Chain ID |
| contractAddress | string | Contract address |
| symbol | string | Token symbol |
| name | string | Token name |
| decimals | integer | Token decimals |
| icon | string | Logo URL (prefix `https://bin.bnbstatic.com`) |
| price | string | Current price (USD) |
| priceChange | string | 24h price change (%) |
| marketCap | string | Market cap (USD) |
| liquidity | string | Liquidity (USD) |
| volume | string | 24h volume (USD) |
| holders | long | Holder count |
| progress | string | Bonding curve progress (%, append `%` directly) |
| protocol | integer | Launchpad protocol code |
| exclusive | integer | Binance exclusive: 0/1 |
**Trade Counts**:
| Field | Type | Description |
|-------|------|-------------|
| count | long | 24h total trades |
| countBuy | long | 24h buy trades |
| countSell | long | 24h sell trades |
**Holder Distribution** (all string, already in %, append `%` directly):
| Field | Description |
|-------|-------------|
| holdersTop10Percent | Top10 holders % |
| holdersDevPercent | Dev holders % |
| holdersSniperPercent | Sniper holders % |
| holdersInsiderPercent | Insider holders % |
| bnHoldingPercent | Binance wallet holders % |
| kolHoldingPercent | KOL holders % |
| proHoldingPercent | Pro holders % |
| newWalletHoldingPercent | New wallet holders % |
| bundlerHoldingPercent | Bundler holders % |
**Dev & Migration Info**:
| Field | Type | Description |
|-------|------|-------------|
| devAddress | string | Dev wallet address |
| devSellPercent | string | Dev sell % |
| devMigrateCount | long | Dev historical migration count |
| devPosition | integer | `2`=dev sold all position |
| migrateStatus | integer | `0`=not migrated, `1`=migrated |
| migrateTime | long | Migration timestamp (ms) |
| createTime | long | Token creation timestamp (ms) |
**Tags & Flags**:
| Field | Type | Description |
|-------|------|-------------|
| tagDevWashTrading | integer | Dev wash trading: 1=yes |
| tagInsiderWashTrading | integer | Insider wash trading: 1=yes |
| tagDevBurnedToken | integer | Dev burned tokens: 1=yes |
| tagPumpfunLiving | integer | Pump.fun live: 1=yes |
| tagCmcBoost | integer | CMC paid: 1=yes |
| paidOnDexScreener | integer | DexScreener paid: 1=yes |
| launchTaxEnable | integer | Has launch tax: 1=yes |
| taxRate | string | Trading tax rate (%) |
| globalFee | string | Trading fee (Solana only) |
**Social Links**:
| Field | Type | Description |
|-------|------|-------------|
| socials.website | string | Website URL |
| socials.twitter | string | Twitter URL |
| socials.telegram | string | Telegram URL |
**AI Narrative**:
| Field | Type | Description |
|-------|------|-------------|
| narrativeText.en | string | AI narrative (English) |
| narrativeText.cn | string | AI narrative (Chinese) |
---
## API 2: Topic Rush Rank List
### Method: GET
**URL**:
```
https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/social-rush/rank/list
```
**Headers**: `Accept-Encoding: identity`
### Request Parameters
**Required Parameters**:
| Field | Type | Description |
|-------|------|-------------|
| chainId | string | Chain ID: `56`, `CT_501` |
| rankType | integer | `10`=Latest, `20`=Rising, `30`=Viral |
| sort | integer | Sort by: `10`=create time, `20`=net inflow, `30`=viral time |
> **Sort convention**: When the user does not specify a sort preference, use `sort=10` (create time) for Latest/Rising, and `sort=30` (viral time) for Viral.
**Optional Parameters**:
| Field | Type | Description |
|-------|------|-------------|
| asc | boolean | `true`=ascending, `false`=descending |
| keywords | string | Keyword filter (case-insensitive, contains match) |
| topicType | string | Topic type filter, comma-separated for multiple |
| tokenSizeMin/Max | integer | Associated token count range |
| netInflowMin/Max | string | Topic net inflow range (USD) |
### Example Request
```bash
curl 'https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/social-rush/rank/list?chainId=CT_501&rankType=30&sort=30&asc=false' \
-H 'Accept-Encoding: identity' \
-H 'User-Agent: binance-web3/1.0 (Skill)'
```
### Response (`data[]`)
**Topic Fields**:
| Field | Type | Description |
|-------|------|-------------|
| topicId | string | Topic unique ID |
| chainId | string | Chain ID |
| name | object | Multi-language topic name (`topicNameEn`, `topicNameCn`, etc.) |
| type | string | Topic type/category |
| close | integer | Topic closed: `0`=no, `1`=yes |
| topicLink | string | Related tweet/post URL |
| createTime | long | Topic creation timestamp (ms) |
| progress | string | Topic progress (pre-formatted %, append `%` directly) |
| aiSummary | object | AI-generated topic narrative |
| topicNetInflow | string | Total net inflow (USD) |
| topicNetInflow1h | string | 1h net inflow (USD) |
| topicNetInflowAth | string | All-time high net inflow (USD) |
| tokenSize | integer | Number of associated tokens |
| deepAnalysisFlag | integer | Deep analysis available: `1`=yes |
**Token List** (`tokenList[]` within each topic):
| Field | Type | Description |
|-------|------|-------------|
| chainId | string | Chain ID |
| contractAddress | string | Contract address |
| symbol | string | Token symbol |
| icon | string | Logo URL (prefix `https://bin.bnbstatic.com`) |
| decimals | integer | Token decimals |
| createTime | long | Token creation timestamp (ms) |
| marketCap | string | Market cap (USD) |
| liquidity | string | Liquidity (USD) |
| priceChange24h | string | 24h price change (pre-formatted %, append `%`) |
| netInflow | string | Token net inflow since topic creation (USD) |
| netInflow1h | string | Token 1h net inflow (USD) |
| volumeBuy / volumeSell | string | Buy / Sell volume since topic creation (USD) |
| volume1hBuy / volume1hSell | string | 1h buy / sell volume (USD) |
| uniqueTrader{5m,1h,4h,24h} | long | Unique traders by period |
| count{5m,1h,4h,24h} | long | Trade count by period |
| holders | long | Holder count |
| kolHolders | long | KOL holder count |
| smartMoneyHolders | long | Smart money holder count |
| protocol | integer | Launchpad protocol code (`0`/null = DEX token) |
| internal | integer | On bonding curve: `0`=no, `1`=yes |
| migrateStatus | integer | Migrated: `0`=no, `1`=yes |
---
## User Agent Header
Include `User-Agent` header with the following string: `binance-web3/1.0 (Skill)`
## Notes
1. Only `chainId` and `rankType` are required; all other parameters are optional filters
2. Percentage fields (progress, holder %, dev sell %, tax rate) are pre-formatted — append `%` directly
3. `taxRate` for protocol=2001 (Four.meme) only shows on Migrated list; for protocol=2002 (Flap) shows on all lists
4. Icon URLs require prefix: `https://bin.bnbstatic.com` + path
Crypto market rankings and leaderboards. Query trending tokens, top searched tokens, Binance Alpha tokens, tokenized stocks, social hype sentiment ranks, sma...
---
name: crypto-market-rank
description: |
Crypto market rankings and leaderboards. Query trending tokens, top searched tokens, Binance Alpha tokens,
tokenized stocks, social hype sentiment ranks, smart money inflow token rankings,
top meme token rankings from Pulse launchpad, and top trader PnL leaderboards.
Use this skill when users ask about token rankings, market trends, social buzz, meme rankings, breakout meme tokens, or top traders.
metadata:
author: binance-web3-team
version: "2.0"
---
# Crypto Market Rank Skill
## Overview
| API | Function | Use Case |
|-----|----------|----------|
| Social Hype Leaderboard | Social buzz ranking | Sentiment analysis, social summaries |
| Unified Token Rank | Multi-type token rankings | Trending, Top Search, Alpha, Stock with filters |
| Smart Money Inflow Rank | Token rank by smart money buys | Discover tokens smart money is buying most |
| Meme Rank | Top meme tokens from Pulse launchpad | Find meme tokens most likely to break out |
| Address Pnl Rank | Top trader PnL leaderboard | Top PnL traders / KOL performance ranking |
## Use Cases
1. **Social Hype Analysis**: Discover tokens with highest social buzz and sentiment
2. **Trending Tokens**: View currently trending tokens (rankType=10)
3. **Top Searched**: See most searched tokens (rankType=11)
4. **Alpha Discovery**: Browse Binance Alpha picks (rankType=20)
5. **Stock Tokens**: View tokenized stocks (rankType=40)
6. **Smart Money Inflow**: Discover which tokens smart money is buying most
7. **Meme Rank**: Find top meme tokens from Pulse launchpad most likely to break out
8. **PnL Leaderboard**: View top-performing trader addresses, PnL, win rates
9. **Filtered Research**: Combine filters for targeted token or address screening
## Supported Chains
| Chain | chainId |
|-------|---------|
| BSC | 56 |
| Base | 8453 |
| Solana | CT_501 |
---
## API 1: Social Hype Leaderboard
### Method: GET
**URL**:
```
https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/pulse/social/hype/rank/leaderboard
```
**Request Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| chainId | string | Yes | Chain ID |
| sentiment | string | No | Filter: `All`, `Positive`, `Negative`, `Neutral` |
| targetLanguage | string | Yes | Translation target, e.g., `en`, `zh` |
| timeRange | number | Yes | Time range, `1` = 24 hours |
| socialLanguage | string | No | Content language, `ALL` for all |
**Headers**: `Accept-Encoding: identity`
**Example**:
```bash
curl 'https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/pulse/social/hype/rank/leaderboard?chainId=56&sentiment=All&socialLanguage=ALL&targetLanguage=en&timeRange=1' \
-H 'Accept-Encoding: identity' \
-H 'User-Agent: binance-web3/2.0 (Skill)'
```
**Response** (`data.leaderBoardList[]`):
| Field Path | Type | Description |
|------------|------|-------------|
| metaInfo.logo | string | Icon URL path (prefix `https://bin.bnbstatic.com`) |
| metaInfo.symbol | string | Token symbol |
| metaInfo.chainId | string | Chain ID |
| metaInfo.contractAddress | string | Contract address |
| metaInfo.tokenAge | number | Creation timestamp (ms) |
| marketInfo.marketCap | number | Market cap (USD) |
| marketInfo.priceChange | number | Price change (%) |
| socialHypeInfo.socialHype | number | Total social hype index |
| socialHypeInfo.sentiment | string | Positive / Negative / Neutral |
| socialHypeInfo.socialSummaryBrief | string | Brief social summary |
| socialHypeInfo.socialSummaryDetail | string | Detailed social summary |
| socialHypeInfo.socialSummaryBriefTranslated | string | Translated brief summary |
| socialHypeInfo.socialSummaryDetailTranslated | string | Translated detailed summary |
---
## API 2: Unified Token Rank
### Method: POST (recommended) / GET
**URL**:
```
https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/pulse/unified/rank/list
```
**Headers**: `Content-Type: application/json`, `Accept-Encoding: identity`
### Rank Types
| rankType | Name | Description |
|----------|------|-------------|
| 10 | Trending | Hot trending tokens |
| 11 | Top Search | Most searched tokens |
| 20 | Alpha | Alpha tokens (Binance Alpha picks) |
| 40 | Stock | Tokenized stock tokens |
### Request Body (all fields optional)
**Core Parameters**:
| Field | Type | Default | Description |
|-------|------|---------|-------------|
| rankType | integer | 10 | Rank type: `10`=Trending, `11`=TopSearch, `20`=Alpha, `40`=Stock |
| chainId | string | - | Chain ID: `1`, `56`, `8453`, `CT_501`|
| period | integer | 50 | Time period: `10`=1m, `20`=5m, `30`=1h, `40`=4h, `50`=24h |
| sortBy | integer | 0 | Sort field (see Sort Options) |
| orderAsc | boolean | false | Ascending order if true |
| page | integer | 1 | Page number (min 1) |
| size | integer | 200 | Page size (max 200) |
**Filter Parameters (Min/Max pairs)**:
| Filter | Type | Description |
|--------|------|-------------|
| percentChangeMin/Max | decimal | Price change range (%) |
| marketCapMin/Max | decimal | Market cap range (USD) |
| volumeMin/Max | decimal | Volume range (USD) |
| liquidityMin/Max | decimal | Liquidity range (USD) |
| holdersMin/Max | long | Holder count range |
| holdersTop10PercentMin/Max | decimal | Top10 holder % range |
| kycHoldersMin/Max | long | KYC holder count (Alpha only) |
| countMin/Max | long | Transaction count range |
| uniqueTraderMin/Max | long | Unique trader count range |
| launchTimeMin/Max | long | Token launch time range (timestamp ms) |
**Advanced Filters**:
| Field | Type | Description |
|-------|------|-------------|
| keywords | string[] | Include symbols matching these keywords |
| excludes | string[] | Exclude these symbols |
| socials | integer[] | Social filter: `0`=at_least_one, `1`=X, `2`=Telegram, `3`=Website |
| alphaTagFilter | string[] | Alpha narrative tags |
| auditFilter | integer[] | Audit: `0`=not_renounced, `1`=freezable, `2`=mintable |
| tagFilter | integer[] | Tag filter: `0`=hide_alpha, `23`=dex_paid, `29`=alpha_points, etc. |
### Sort Options
| sortBy | Field |
|--------|-------|
| 0 | Default |
| 1 | Web default |
| 2 | Search count |
| 10 | Launch time |
| 20 | Liquidity |
| 30 | Holders |
| 40 | Market cap |
| 50 | Price change |
| 60 | Transaction count |
| 70 | Volume |
| 80 | KYC holders |
| 90 | Price |
| 100 | Unique traders |
### Example Request
```bash
curl -X POST 'https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/pulse/unified/rank/list' \
-H 'Content-Type: application/json' \
-H 'Accept-Encoding: identity' \
-H 'User-Agent: binance-web3/2.0 (Skill)' \
-d '{"rankType":10,"chainId":"1","period":50,"sortBy":70,"orderAsc":false,"page":1,"size":20}'
```
### Response
```json
{
"code": "000000",
"data": {
"tokens": [{ "..." }],
"total": 100,
"page": 1,
"size": 20
},
"success": true
}
```
**Token Fields** (`data.tokens[]`):
| Field | Type | Description |
|-------|------|-------------|
| chainId | string | Chain ID |
| contractAddress | string | Contract address |
| symbol | string | Token symbol |
| icon | string | Logo URL path (prefix `https://bin.bnbstatic.com`) |
| price | string | Current price (USD) |
| marketCap | string | Market cap |
| liquidity | string | Liquidity |
| holders | string | Holder count |
| launchTime | string | Launch timestamp (ms) |
| decimals | integer | Token decimals |
| links | string | Social links JSON |
| percentChange{1m,5m,1h,4h,24h} | string | Price change by period (%) |
| volume{1m,5m,1h,4h,24h} | string | Volume by period (USD) |
| volume{1m,5m,1h,4h,24h}Buy/Sell | string | Buy/Sell volume by period |
| count{1m,5m,1h,4h,24h} | string | Transaction count by period |
| count{1m,5m,1h,4h,24h}Buy/Sell | string | Buy/Sell tx count by period |
| uniqueTrader{1m,5m,1h,4h,24h} | string | Unique traders by period |
| alphaInfo | object | Alpha info (tagList, description) |
| auditInfo | object | Audit info (riskLevel, riskNum, cautionNum) |
| tokenTag | object | Token tag info |
| kycHolders | string | KYC holder count |
| holdersTop10Percent | string | Top10 holder percentage |
---
## API 3: Smart Money Inflow Rank
### Method: POST
**URL**:
```
https://web3.binance.com/bapi/defi/v1/public/wallet-direct/tracker/wallet/token/inflow/rank/query
```
**Headers**: `Content-Type: application/json`, `Accept-Encoding: identity`
**Request Body**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| chainId | string | Yes | Chain ID: `56` (BSC), `CT_501` (Solana) |
| period | string | No | Stats window: `5m`, `1h`, `4h`, `24h` |
| tagType | integer | Yes | Address tag type (always `2`) |
### Example Request
```bash
curl -X POST 'https://web3.binance.com/bapi/defi/v1/public/wallet-direct/tracker/wallet/token/inflow/rank/query' \
-H 'Content-Type: application/json' \
-H 'Accept-Encoding: identity' \
-H 'User-Agent: binance-web3/2.0 (Skill)' \
-d '{"chainId":"56","period":"24h","tagType":2}'
```
### Response (`data[]`)
| Field | Type | Description |
|-------|------|-------------|
| tokenName | string | Token name |
| tokenIconUrl | string | Icon URL path (prefix `https://bin.bnbstatic.com`) |
| ca | string | Contract address |
| price | string | Current price (USD) |
| marketCap | string | Market cap (USD) |
| volume | string | Trading volume in period (USD) |
| priceChangeRate | string | Price change in period (%) |
| liquidity | string | Liquidity (USD) |
| holders | string | Total holder count |
| kycHolders | string | KYC holder count |
| holdersTop10Percent | string | Top10 holder percentage |
| count | string | Transaction count in period |
| countBuy / countSell | string | Buy / Sell tx count |
| inflow | number | Smart money net inflow amount (USD) |
| traders | integer | Number of smart money addresses trading this token |
| launchTime | number | Token launch timestamp (ms) |
| tokenDecimals | integer | Token decimals |
| tokenRiskLevel | integer | Risk level (-1=unknown, 1=low, 2=medium, 3=high) |
| link | array | Social links: `[{label, link}]` |
| tokenTag | object | Token tags by category |
---
## API 4: Meme Rank
### Method: GET
**URL**:
```
https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/pulse/exclusive/rank/list
```
**Headers**: `Accept-Encoding: identity`
**Request Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| chainId | string | Yes | Chain ID: `56` (BSC) |
Returns top 100 meme tokens launched via Pulse platform, scored and ranked by an algorithm evaluating breakout potential.
### Example Request
```bash
curl 'https://web3.binance.com/bapi/defi/v1/public/wallet-direct/buw/wallet/market/token/pulse/exclusive/rank/list?chainId=56' \
-H 'Accept-Encoding: identity' \
-H 'User-Agent: binance-web3/2.0 (Skill)'
```
### Response (`data.tokens[]`)
| Field | Type | Description |
|-------|------|-------------|
| chainId | string | Chain ID |
| contractAddress | string | Contract address |
| symbol | string | Token symbol |
| rank | integer | Rank position |
| score | string | Algorithm score (higher = more likely to break out) |
| alphaStatus | integer | Alpha listing status |
| price | string | Current price (USD) |
| percentChange | string | Price change (%) |
| percentChange7d | string | 7-day price change (%) |
| marketCap | string | Market cap (USD) |
| liquidity | string | Liquidity (USD) |
| volume | string | Total volume (USD) |
| volumeBnTotal | string | Binance user total volume |
| volumeBn7d | string | Binance user 7-day volume |
| holders | string | Total holder count |
| kycHolders | string | KYC holder count |
| bnUniqueHolders | string | Binance unique holder count |
| holdersTop10Percent | string | Top10 holder percentage |
| count | integer | Total transaction count |
| countBnTotal | integer | Binance user total tx count |
| countBn7d | integer | Binance user 7-day tx count |
| uniqueTraderBn | integer | Binance unique traders |
| uniqueTraderBn7d | integer | Binance 7-day unique traders |
| impression | integer | Impression/view count |
| createTime | number | Token creation timestamp (ms) |
| migrateTime | number | Migration timestamp (ms) |
| metaInfo.icon | string | Icon URL path (prefix `https://bin.bnbstatic.com`) |
| metaInfo.name | string | Token full name |
| metaInfo.decimals | integer | Token decimals |
| metaInfo.aiNarrativeFlag | integer | AI narrative flag (1=yes) |
| previewLink | object | Social links: `{website[], x[], telegram[]}` |
| tokenTag | object | Token tags by category |
---
## API 5: Address Pnl Rank
### Method: GET
**URL**:
```
https://web3.binance.com/bapi/defi/v1/public/wallet-direct/market/leaderboard/query
```
**Headers**: `Accept-Encoding: identity`
**Request Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| chainId | string | Yes | Chain ID: `56` (BSC), `CT_501` (Solana) |
| period | string | Yes | Time period: `7d`, `30d`, `90d` |
| tag | string | Yes | Address tag filter: `ALL`, `KOL` |
| sortBy | integer | No | Sort field |
| orderBy | integer | No | Order direction |
| pageNo | integer | No | Page number (min 1) |
| pageSize | integer | No | Page size (max 25) |
**Filter Parameters (Min/Max pairs)**:
| Filter | Type | Description |
|--------|------|-------------|
| PNLMin/Max | decimal | Realized PnL range (USD) |
| winRateMin/Max | decimal | Win rate range (percentage, e.g. `1` = 1%) |
| txMin/Max | long | Transaction count range |
| volumeMin/Max | decimal | Volume range (USD) |
### Example Request
```bash
curl 'https://web3.binance.com/bapi/defi/v1/public/wallet-direct/market/leaderboard/query?tag=ALL&pageNo=1&chainId=CT_501&pageSize=25&sortBy=0&orderBy=0&period=30d' \
-H 'Accept-Encoding: identity' \
-H 'User-Agent: binance-web3/2.0 (Skill)'
```
### Response
```json
{
"code": "000000",
"data": {
"data": [{ "..." }],
"current": 1,
"size": 25,
"pages": 35
},
"success": true
}
```
**Address Fields** (`data.data[]`):
| Field | Type | Description |
|-------|------|-------------|
| address | string | Wallet address |
| addressLogo | string | Address avatar URL |
| addressLabel | string | Address display name |
| balance | string | On-chain balance (native token, e.g. SOL/BNB) |
| tags | array | Address tags (e.g. KOL) |
| realizedPnl | string | Realized PnL for the period (USD) |
| realizedPnlPercent | string | Realized PnL percentage |
| dailyPNL | array | Daily PnL list: `[{realizedPnl, dt}]` |
| winRate | string | Win rate for the period |
| totalVolume | string | Total trading volume (USD) |
| buyVolume / sellVolume | string | Buy / Sell volume |
| avgBuyVolume | string | Average buy amount |
| totalTxCnt | integer | Total transaction count |
| buyTxCnt / sellTxCnt | integer | Buy / Sell transaction count |
| totalTradedTokens | integer | Number of tokens traded |
| topEarningTokens | array | Top profit tokens: `[{tokenAddress, tokenSymbol, tokenUrl, realizedPnl, profitRate}]` |
| tokenDistribution | object | PnL distribution: `{gt500Cnt, between0And500Cnt, between0AndNegative50Cnt, ltNegative50Cnt}` |
| lastActivity | number | Last active timestamp (ms) |
| genericAddressTagList | array | Detailed tag info (tagName, logoUrl, extraInfo) |
---
## User Agent Header
Include `User-Agent` header with the following string: `binance-web3/2.0 (Skill)`
## Notes
1. Icon/logo URLs require prefix: `https://bin.bnbstatic.com` + path
2. Unified Token Rank supports both GET and POST; POST is recommended
3. All numeric fields in responses are strings — parse when needed
4. Period fields use shorthand: `{1m,5m,1h,4h,24h}` means separate fields like `percentChange1m`, `percentChange5m`, etc.