{ "openapi": "3.0.2", "info": { "title": "Binance Web3 API", "description": "Cross-chain wallet, market, trading, and transaction APIs for the Binance Web3 API platform.", "x-description-cn": "Binance Web3 API 平台跨链钱包、行情、交易和链上交易 API。", "version": "1.0.0", "termsOfService": "https://www.binance.com/en/terms", "contact": { "name": "Binance API Support", "url": "https://www.binance.com/en/support" } }, "x-product-type": "rest-api", "x-skip-connectors-examples": true, "x-auth": "web3wallet", "x-rate-limits-guide": "authentication#rate-limits", "x-rate-limits-guide-cn": "authentication#频率限制", "x-security-guide": "authentication", "x-security-guide-cn": "authentication", "x-api-key-guide": "https://www.binance.com/en/support/faq/detail/360002502072", "x-api-key-guide-cn": "https://www.binance.com/cn/support/faq/detail/360002502072", "externalDocs": { "description": "Web3 Wallet docs", "url": "https://web3.binance.com/en/dev-docs/introduction" }, "tags": [ { "name": "General Data", "x-displayName": "通用行情数据", "x-displayName-cn": "通用行情数据" }, { "name": "Address Portfolio", "x-displayName": "地址分析数据", "x-displayName-cn": "地址分析数据" }, { "name": "RWA Data", "x-displayName": "RWA 行情数据", "x-displayName-cn": "RWA 行情数据" }, { "name": "Trading API", "x-displayName": "交易 API", "x-displayName-cn": "交易 API" }, { "name": "Transaction API", "x-displayName": "链上交易 API", "x-displayName-cn": "链上交易 API" }, { "name": "Wallet API", "x-displayName": "钱包 API", "x-displayName-cn": "钱包 API" } ], "servers": [ { "url": "https://web3.binance.com/build" } ], "paths": { "/api/v1/dex/market/supported/chain": { "get": { "summary": "获取支持的链", "description": "返回行情服务支持的区块链列表。", "tags": ["General Data"], "operationId": "getSupportedChains", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-supported-chains" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getSupportedChains.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_supported_chains.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetSupportedChainsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "responses": { "200": { "description": "成功返回支持的链列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "支持的区块链网络列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "name": { "type": "string", "example": "Ethereum", "description": "链全称。" }, "shortName": { "type": "string", "example": "ETH", "description": "链简称。" }, "logoUrl": { "type": "string", "example": "https://onchainos.bnbstatic.com/image/admin_mgs_image_upload/20250228/b549e557-76ca-4873-88ef-3a107cf2c9fe.png", "description": "链 Logo 链接。" }, "caseSensitive": { "type": "boolean", "example": false, "description": "该链的地址是否区分大小写。" }, "nativeTokenSymbol": { "type": "string", "example": "ETH", "description": "原生代币符号。" }, "nativeTokenDecimals": { "type": "integer", "format": "int32", "example": 18, "description": "原生代币精度。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/price": { "post": { "summary": "获取代币价格", "description": "获取代币的最新价格，支持批量查询，单次最多查询 100 个代币。", "tags": ["General Data"], "operationId": "getTokenPrice", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-token-price" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getTokenPrice.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_token_price.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetTokenPriceExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "requestBody": { "required": true, "description": "待查询的代币列表，单次最多 100 条。", "content": { "application/json": { "schema": { "type": "array", "maxItems": 100, "items": { "type": "object", "required": ["binanceChainId", "tokenContractAddress"], "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "tokenContractAddress": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7", "description": "代币合约地址。" } } } }, "examples": { "evm": { "summary": "EVM 代币", "value": [ { "binanceChainId": "1", "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7" }, { "binanceChainId": "56", "tokenContractAddress": "0x55d398326f99059ff775485246999027b3197955" } ] }, "solana": { "summary": "Solana 代币", "value": [ { "binanceChainId": "CT_501", "tokenContractAddress": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB" } ] } } } } }, "responses": { "200": { "description": "成功返回代币价格。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "每个请求代币对应一条价格信息。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7", "description": "代币合约地址。" }, "price": { "type": "string", "example": "1.0002", "description": "代币最新美元价格。" }, "time": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "代币价格的对应获取时间，Unix 毫秒时间戳。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "201": { "description": "已创建。" }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/price-info": { "post": { "summary": "获取代币交易信息", "description": "获取代币的价格及交易数据（成交量、交易笔数、市值、持仓数等），最多支持批量查询 100 个代币。", "tags": ["General Data"], "operationId": "getTokenTradingInfo", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-token-trading-info" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getTokenTradingInfo.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_token_trading_info.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetTokenTradingInfoExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "requestBody": { "required": true, "description": "待查询的代币列表，单次最多 100 条。", "content": { "application/json": { "schema": { "type": "array", "maxItems": 100, "items": { "type": "object", "required": ["binanceChainId", "tokenContractAddress"], "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7", "description": "代币合约地址。" } } } } } } }, "responses": { "200": { "description": "成功返回价格信息。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "每个请求代币对应一条价格信息。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7", "description": "代币合约地址。" }, "price": { "type": "string", "example": "1.0002", "description": "代币最新美元价格。" }, "time": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "代币价格的对应获取时间，Unix 毫秒时间戳。" }, "marketCap": { "type": "string", "example": "83500000.00", "description": "代币市值，美元计价。" }, "priceChange5M": { "type": "string", "example": "0.12", "description": "5 分钟内价格变动百分比，如 \"0.12\" 表示上涨 0.12%。" }, "priceChange1H": { "type": "string", "example": "1.05", "description": "1 小时内价格变动百分比，如 \"1.05\" 表示上涨 1.05%。" }, "priceChange4H": { "type": "string", "example": "2.30", "description": "4 小时内价格变动百分比，如 \"2.30\" 表示上涨 2.30%。" }, "priceChange24H": { "type": "string", "example": "-0.85", "description": "24 小时内价格变动百分比，如 \"-0.85\" 表示下跌 0.85%。" }, "volume5M": { "type": "string", "example": "12500.50", "description": "近5分钟交易量，美元计价。" }, "volume1H": { "type": "string", "example": "120000.30", "description": "近1小时交易量，美元计价。" }, "volume4H": { "type": "string", "example": "550000.20", "description": "近4小时交易量，美元计价。" }, "volume24H": { "type": "string", "example": "1250000.50", "description": "近24小时交易量，美元计价。" }, "buyVolume5M": { "type": "string", "example": "6800.00", "description": "近5分钟买入量，美元计价。" }, "buyVolume1H": { "type": "string", "example": "65000.00", "description": "近1小时买入量，美元计价。" }, "buyVolume4H": { "type": "string", "example": "300000.00", "description": "近4小时买入量，美元计价。" }, "buyVolume24H": { "type": "string", "example": "680000.30", "description": "近24小时买入量，美元计价。" }, "sellVolume5M": { "type": "string", "example": "5700.00", "description": "近5分钟卖出量，美元计价。" }, "sellVolume1H": { "type": "string", "example": "55000.00", "description": "近1小时卖出量，美元计价。" }, "sellVolume4H": { "type": "string", "example": "250000.00", "description": "近4小时卖出量，美元计价。" }, "sellVolume24H": { "type": "string", "example": "570000.20", "description": "近24小时卖出量，美元计价。" }, "txs5M": { "type": "integer", "format": "int64", "example": 60, "description": "近5分钟交易笔数。" }, "txs1H": { "type": "integer", "format": "int64", "example": 720, "description": "近1小时交易笔数。" }, "txs4H": { "type": "integer", "format": "int64", "example": 2880, "description": "近4小时交易笔数。" }, "txs24H": { "type": "integer", "format": "int64", "example": 1523, "description": "近24小时交易笔数。" }, "buyTxs5M": { "type": "integer", "format": "int64", "example": 33, "description": "近5分钟买入笔数。" }, "buyTxs1H": { "type": "integer", "format": "int64", "example": 380, "description": "近1小时买入笔数。" }, "buyTxs4H": { "type": "integer", "format": "int64", "example": 1500, "description": "近4小时买入笔数。" }, "buyTxs24H": { "type": "integer", "format": "int64", "example": 812, "description": "近24小时买入笔数。" }, "sellTxs5M": { "type": "integer", "format": "int64", "example": 27, "description": "近5分钟卖出笔数。" }, "sellTxs1H": { "type": "integer", "format": "int64", "example": 340, "description": "近1小时卖出笔数。" }, "sellTxs4H": { "type": "integer", "format": "int64", "example": 1380, "description": "近4小时卖出笔数。" }, "sellTxs24H": { "type": "integer", "format": "int64", "example": 711, "description": "近24小时卖出笔数。" }, "maxPrice": { "type": "string", "example": "1.0023", "description": "24小时最高价，美元计价。" }, "minPrice": { "type": "string", "example": "0.9987", "description": "24小时最低价，美元计价。" }, "circSupply": { "type": "string", "example": "83000000000", "description": "代币当前流通量。" }, "liquidity": { "type": "string", "example": "1250000.50", "description": "代币流动性，美元计价。" }, "holders": { "type": "integer", "format": "int64", "example": 45832, "description": "持币地址数量。" }, "bnVolume5M": { "type": "string", "example": "0", "description": "近5分钟 Binance MPC 钱包通过 Binance Web3 DEX 发生的交易量，美元计价。" }, "bnVolume1H": { "type": "string", "example": "0", "description": "近1小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的交易量，美元计价。" }, "bnVolume4H": { "type": "string", "example": "0", "description": "近4小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的交易量，美元计价。" }, "bnVolume24H": { "type": "string", "example": "35000.80", "description": "近24小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的交易量，美元计价。" }, "bnBuyVolume5M": { "type": "string", "example": "0", "description": "近5分钟 Binance MPC 钱包通过 Binance Web3 DEX 发生的买入交易量，美元计价。" }, "bnBuyVolume1H": { "type": "string", "example": "0", "description": "近1小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的买入交易量，美元计价。" }, "bnBuyVolume4H": { "type": "string", "example": "0", "description": "近4小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的买入交易量，美元计价。" }, "bnBuyVolume24H": { "type": "string", "example": "20000.50", "description": "近24小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的买入交易量，美元计价。" }, "bnSellVolume5M": { "type": "string", "example": "0", "description": "近5分钟 Binance MPC 钱包通过 Binance Web3 DEX 发生的卖出交易量，美元计价。" }, "bnSellVolume1H": { "type": "string", "example": "0", "description": "近1小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的卖出交易量，美元计价。" }, "bnSellVolume4H": { "type": "string", "example": "0", "description": "近4小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的卖出交易量，美元计价。" }, "bnSellVolume24H": { "type": "string", "example": "15000.30", "description": "近24小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的卖出交易量，美元计价。" }, "bnTxs5M": { "type": "integer", "format": "int64", "example": 0, "description": "近5分钟 Binance MPC 钱包通过 Binance Web3 DEX 发生的交易笔数。" }, "bnTxs1H": { "type": "integer", "format": "int64", "example": 0, "description": "近1小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的交易笔数。" }, "bnTxs4H": { "type": "integer", "format": "int64", "example": 0, "description": "近4小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的交易笔数。" }, "bnTxs24H": { "type": "integer", "format": "int64", "example": 156, "description": "近24小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的交易笔数。" }, "bnBuyTxs5M": { "type": "integer", "format": "int64", "example": 0, "description": "近5分钟 Binance MPC 钱包通过 Binance Web3 DEX 发生的买入交易笔数。" }, "bnBuyTxs1H": { "type": "integer", "format": "int64", "example": 0, "description": "近1小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的买入交易笔数。" }, "bnBuyTxs4H": { "type": "integer", "format": "int64", "example": 0, "description": "近4小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的买入交易笔数。" }, "bnBuyTxs24H": { "type": "integer", "format": "int64", "example": 89, "description": "近24小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的买入交易笔数。" }, "bnSellTxs5M": { "type": "integer", "format": "int64", "example": 0, "description": "近5分钟 Binance MPC 钱包通过 Binance Web3 DEX 发生的卖出交易笔数。" }, "bnSellTxs1H": { "type": "integer", "format": "int64", "example": 0, "description": "近1小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的卖出交易笔数。" }, "bnSellTxs4H": { "type": "integer", "format": "int64", "example": 0, "description": "近4小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的卖出交易笔数。" }, "bnSellTxs24H": { "type": "integer", "format": "int64", "example": 67, "description": "近24小时 Binance MPC 钱包通过 Binance Web3 DEX 发生的卖出交易笔数。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "201": { "description": "已创建。" }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/candles": { "get": { "summary": "获取代币 K 线数据", "description": "返回代币的 K 线数据。", "tags": ["General Data"], "operationId": "getCandles", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-candles" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getCandles.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_candles.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetCandlesExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" }, "description": "代币合约地址。" }, { "name": "bar", "in": "query", "required": false, "schema": { "type": "string", "example": "1m", "default": "1m", "enum": [ "1s", "5s", "30s", "1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "6h", "8h", "12h", "1d", "3d", "1w", "1M" ] }, "description": "K 线时间粒度，默认 \"1m\"，即时间粒度为1分钟。可选值：1s（1秒）、5s（5秒）、30s（30秒）、 1m（1分钟）、3m（3分钟）、5m（5分钟）、15m（15分钟）、30m（30分钟）、1h（1小时）、 2h（2小时）、4h（4小时）、6h（6小时）、8h（8小时）、12h（12小时）、1d（1天）、 3d（3天）、1w（1周）、1M（1月）。" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1748600000000 }, "description": "查询结束时间，Unix 毫秒时间戳。返回早于该时间的 K 线（不含该时间点）。" }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1748000000000 }, "description": "查询起始时间，Unix 毫秒时间戳。返回晚于该时间的 K 线（不含该时间点）。" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "default": 100 }, "description": "返回的 K 线条数，默认 100。" } ], "responses": { "200": { "description": "成功返回 K 线数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "K 线数据列表，每条记录包含 7 个值，依次为：开盘价、最高价、 最低价、收盘价、成交量、时间戳（毫秒）、交易笔数。", "example": [ [ 1.0001, 1.0023, 0.9987, 1.001, 125000.5, 1748600000000, 42 ], [ 1.001, 1.0035, 1.0001, 1.0028, 187500.3, 1748600060000, 38 ] ], "items": { "type": "array", "description": "单条 K 线：[开盘价, 最高价, 最低价, 收盘价, 成交量, 时间戳(毫秒), 交易笔数]，价格及成交量均为美元计价。", "example": [ 1.0001, 1.0023, 0.9987, 1.001, 125000.5, 1748600000000, 42 ], "items": { "type": "number", "example": 1.0001 } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/token/search": { "get": { "summary": "代币搜索", "description": "通过代币符号或代币合约地址搜索代币。", "tags": ["General Data"], "operationId": "searchToken", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#search-token" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/searchToken.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/search_token.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/SearchTokenExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "chains", "in": "query", "required": true, "schema": { "type": "string", "example": "1,56,CT_501" }, "description": "待搜索的链 ID 列表，英文逗号分隔。" }, { "name": "search", "in": "query", "required": true, "schema": { "type": "string", "example": "USDT" }, "description": "搜索关键词，可传入代币地址或代币符号。" } ], "responses": { "200": { "description": "成功返回搜索结果。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "匹配的代币列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenName": { "type": "string", "example": "Tether USD", "description": "代币全称。" }, "tokenSymbol": { "type": "string", "example": "USDT", "description": "代币符号。" }, "tokenLogoUrl": { "type": "string", "nullable": true, "example": "https://static.onchainos.com/tokens/usdt.png", "description": "代币 Logo 链接，无 Logo 时返回 null。" }, "tokenContractAddress": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7", "description": "代币合约地址。" }, "decimals": { "type": "integer", "format": "int32", "example": 6, "description": "代币精度。" }, "explorerUrl": { "type": "string", "example": "https://etherscan.io/token/0xdac17f958d2ee523a2206206994597c13d831ec7", "description": "代币对应的区块链浏览器链接。" }, "change": { "type": "string", "nullable": true, "example": "-5.23", "description": "24 小时价格涨跌幅，如 \"-5.23\" 表示下跌 5.23%，无数据时返回 null。" }, "holders": { "type": "string", "example": "45832", "description": "持币地址数量。" }, "liquidity": { "type": "string", "example": "1250000.50", "description": "代币流动性，美元计价。" }, "marketCap": { "type": "string", "example": "83500000.00", "description": "代币市值，美元计价。" }, "price": { "type": "string", "example": "1.0001", "description": "代币最新美元价格。" }, "tagList": { "type": "object", "title": "Tag info.", "x-title-cn": "标签信息。", "properties": { "isRecognized": { "type": "boolean", "nullable": true, "example": true, "description": "True 表示代币已在头部中心化交易所上线或被社区广泛认可。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/token/basic-info": { "post": { "summary": "获取代币基础信息", "description": "返回代币基础信息：名称、符号、Logo、精度、创建者地址、创建时间及标签。", "tags": ["General Data"], "operationId": "getTokenBasicInfo", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-token-basic-info" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getTokenBasicInfo.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_token_basic_info.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetTokenBasicInfoExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" }, "description": "代币合约地址。" } ], "responses": { "200": { "description": "成功返回代币基础信息。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "title": "Token basic info.", "x-title-cn": "代币基础信息。", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7", "description": "代币合约地址。" }, "tokenName": { "type": "string", "example": "Tether USD", "description": "代币全称。" }, "tokenSymbol": { "type": "string", "example": "USDT", "description": "代币符号。" }, "tokenLogoUrl": { "type": "string", "nullable": true, "example": "https://static.onchainos.com/tokens/usdt.png", "description": "代币 Logo 链接，无 Logo 时返回 null。" }, "decimals": { "type": "integer", "format": "int32", "example": 6, "description": "代币精度。" }, "creatorAddress": { "type": "string", "example": "0x21a31ee1afc51d94c2efccaa2092ad1028285549", "description": "代币创建者钱包地址。" }, "createTime": { "type": "integer", "format": "int64", "example": 1716892020000, "description": "代币创建时间，Unix 毫秒时间戳。" }, "tagList": { "type": "object", "title": "Token tag information.", "x-title-cn": "代币标签信息。", "properties": { "isRecognized": { "type": "boolean", "nullable": true, "example": true, "description": "True 表示代币已在头部中心化交易所上线或被社区广泛认可。" } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "201": { "description": "已创建。" }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/token/advanced-info": { "get": { "summary": "获取代币高级信息", "description": "返回代币综合指标，包含创建者与发射信息、各类地址持仓占比（聪明钱、KOL、狙击手、捆绑地址、新地址等）及代币标签。", "tags": ["General Data"], "operationId": "getTokenAdvancedInfo", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-token-advanced-info" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getTokenAdvancedInfo.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_token_advanced_info.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetTokenAdvancedInfoExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933" }, "description": "代币合约地址。" } ], "responses": { "200": { "description": "成功返回代币高级信息。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "代币合约地址。" }, "isInternal": { "type": "integer", "format": "int32", "example": 0, "description": "是否平台内部代币。0=否，1=是。" }, "protocolId": { "type": "integer", "format": "int32", "nullable": true, "example": 1, "description": "代币所属协议 ID，无所属协议时返回 null。" }, "progress": { "type": "string", "nullable": true, "example": "75", "description": "内盘代币发射进度，范围 0–100。" }, "createTime": { "type": "integer", "format": "int64", "example": 1714000000000, "description": "代币创建时间，Unix 毫秒时间戳。" }, "creatorAddress": { "type": "string", "example": "0x21a31ee1afc51d94c2efccaa2092ad1028285549", "description": "代币创建者钱包地址。" }, "devCreatedTokenCount": { "type": "integer", "format": "int64", "example": 15, "description": "开发者历史创建代币总数。" }, "devMigratedTokenCount": { "type": "integer", "format": "int64", "example": 8, "description": "开发者历史发射成功代币数。" }, "devMigratedTokenPercent": { "type": "string", "example": "53.5", "description": "开发者发射成功率，如 \"53.5\" 表示 53.5%。" }, "top10HoldingPercent": { "type": "string", "example": "40.08", "description": "Top 10 地址合计持仓占比，如 \"40.08\" 表示 40.08%。" }, "devHoldingPercent": { "type": "string", "example": "5.23", "description": "开发者持仓占比，如 \"5.23\" 表示 5.23%。" }, "smartMoneyHoldingPercent": { "type": "string", "example": "2.15", "description": "聪明钱持仓占比，如 \"2.15\" 表示 2.15%。" }, "kolHoldingPercent": { "type": "string", "example": "1.5", "description": "KOL 持仓占比，如 \"1.5\" 表示 1.5%。" }, "bundlerHoldingPercent": { "type": "string", "example": "12.3", "description": "捆绑地址持仓占比，如 \"12.3\" 表示 12.3%。" }, "proHoldingPercent": { "type": "string", "example": "4.2", "description": "专业持有者持仓占比，如 \"4.2\" 表示 4.2%。" }, "freshWalletHoldingPercent": { "type": "string", "example": "3.8", "description": "新地址持仓占比，如 \"3.8\" 表示 3.8%。" }, "sniperHoldingPercent": { "type": "string", "example": "3.1", "description": "狙击手持仓占比，如 \"3.1\" 表示 3.1%。" }, "insiderHoldingPercent": { "type": "string", "example": "2.5", "description": "内部地址持仓占比，如 \"2.5\" 表示 2.5%。" }, "holders": { "type": "integer", "format": "int64", "example": 45832, "description": "持币地址数量。" }, "bnHolderCount": { "type": "integer", "format": "int64", "example": 1203, "description": "持有当前代币的 Binance MPC 钱包数。" }, "bnTraderCount7D": { "type": "integer", "format": "int64", "example": 250, "description": "近 7 日通过 Binance Web3 DEX 交易的 Binance MPC 钱包数。" }, "tokenTags": { "type": "array", "description": "代币标签数组。若代币命中对应标签，则进行返回。可选值：\n\n- `alpha` — Binance Alpha\n- `tge` — Binance TGE\n- `communityRecognized` — 社区认可程度高\n- `devSellAll` — 开发者清仓\n- `devSell` — 开发者减仓\n- `devBuy` — 开发者加仓\n- `smartMoneyBuy` — 聪明钱加仓\n- `smartMoneySell` — 聪明钱减仓\n- `devRemoveLiquidity` — 开发者减流动性\n- `devAddLiquidity` — 开发者加流动性\n- `devBurnToken` — 开发者烧币\n- `dexScreenerPaid` — Dexscreener付费\n- `volumeSurge` — 交易量骤增\n- `volumePlunge` — 交易量骤减\n- `lowLiquidity` — 流动性低\n- `washTrading` — 存在刷量交易\n- `devWashTrading` — 存在开发者刷量交易\n- `insiderWashTrading` — 存在内幕交易者刷量交易\n", "items": { "type": "string", "example": "Alpha", "enum": [ "alpha", "tge", "communityRecognized", "devSellAll", "devSell", "devBuy", "smartMoneyBuy", "smartMoneySell", "devRemoveLiquidity", "devAddLiquidity", "devBurnToken", "dexScreenerPaid", "volumeSurge", "volumePlunge", "lowLiquidity", "washTrading", "devWashTrading", "insiderWashTrading" ], "x-enum-descriptions": [ "Binance Alpha", "Binance TGE", "社区认可", "开发者清仓", "开发者减仓", "开发者加仓", "聪明钱加仓", "聪明钱减仓", "开发者减流动性", "开发者加流动性", "开发者烧币", "Dexscreener付费", "交易量骤增", "交易量骤减", "流动性低", "刷量交易", "DEV刷量交易", "内幕交易者刷量交易" ] } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/token/hot-token": { "get": { "summary": "获取热门代币榜单", "description": "获取热门代币排行榜，支持按交易额、涨跌幅、市值等维度排序，并可通过持仓分布、开发者行为、流动性等条件筛选。", "tags": ["General Data"], "operationId": "getHotTokenList", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-hot-token-list" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getHotTokenList.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_hot_token_list.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetHotTokenListExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识，仅支持单值。" }, { "name": "rankBy", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 4, "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }, "description": "排序字段。1=价格，2=涨跌幅，3=交易笔数，4=交易额，5=市值，6=流动性，7=创建时间，8=持币地址数，9=Binance MPC 钱包持有数，10=净流入。" }, { "name": "rankingTimeFrame", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 3, "default": 3, "enum": [1, 2, 3, 4, 5] }, "description": "数据的统计时间范围。1=1 分钟，2=5 分钟，3=1 小时，4=4 小时，5=24 小时。默认 1 小时。" }, { "name": "priceChangePercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "5" }, "description": "涨跌幅筛选最小值，如 \"5\" 表示 5%。" }, { "name": "priceChangePercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "涨跌幅筛选最大值，如 \"100\" 表示 100%。" }, { "name": "volumeMin", "in": "query", "required": false, "schema": { "type": "string", "example": "10000" }, "description": "成交额筛选最小值，美元计价。" }, { "name": "volumeMax", "in": "query", "required": false, "schema": { "type": "string", "example": "1000000" }, "description": "成交额筛选最大值，美元计价。" }, { "name": "txsMin", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "交易笔数筛选最小值。" }, { "name": "txsMax", "in": "query", "required": false, "schema": { "type": "string", "example": "10000" }, "description": "交易笔数筛选最大值。" }, { "name": "marketCapMin", "in": "query", "required": false, "schema": { "type": "string", "example": "100000" }, "description": "市值筛选最小值，美元计价。" }, { "name": "marketCapMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100000000" }, "description": "市值筛选最大值，美元计价。" }, { "name": "liquidityMin", "in": "query", "required": false, "schema": { "type": "string", "example": "10000" }, "description": "流动性筛选最小值，美元计价。" }, { "name": "liquidityMax", "in": "query", "required": false, "schema": { "type": "string", "example": "10000000" }, "description": "流动性筛选最大值，美元计价。" }, { "name": "devHoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "开发者持仓占比筛选最小值，如 \"5\" 表示 5%。" }, { "name": "devHoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "10" }, "description": "开发者持仓占比筛选最大值，如 \"5\" 表示 5%。" }, { "name": "inflowUsdMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "净流入筛选最小值，美元计价。" }, { "name": "inflowUsdMax", "in": "query", "required": false, "schema": { "type": "string", "example": "1000000" }, "description": "净流入筛选最大值，美元计价。" }, { "name": "holdersMin", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "持币地址数最小值。" }, { "name": "holdersMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100000" }, "description": "持币地址数最大值。" }, { "name": "bnHolderCountMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "Binance MPC 钱包持有数最小值。" }, { "name": "bnHolderCountMax", "in": "query", "required": false, "schema": { "type": "string", "example": "10000" }, "description": "Binance MPC 钱包持有数最大值。" }, { "name": "top10HoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "前 10 地址持仓占比最小值，如 \"5\" 表示 5%。" }, { "name": "top10HoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "前 10 地址持仓占比最大值，如 \"5\" 表示 5%。" }, { "name": "sniperHoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "狙击者持仓占比最小值，如 \"5\" 表示 5%。" }, { "name": "sniperHoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "狙击者持仓占比最大值，如 \"5\" 表示 5%。" }, { "name": "smartMoneyHoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "聪明钱持仓占比最小值，如 \"5\" 表示 5%。" }, { "name": "smartMoneyHoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "聪明钱持仓占比最大值，如 \"5\" 表示 5%。" }, { "name": "kolHoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "KOL 持仓占比最小值，如 \"5\" 表示 5%。" }, { "name": "kolHoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "KOL 持仓占比最大值，如 \"5\" 表示 5%。" }, { "name": "proHoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "专业持有者持仓占比最小值，如 \"5\" 表示 5%。" }, { "name": "proHoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "专业持有者持仓占比最大值，如 \"5\" 表示 5%。" }, { "name": "freshWalletHoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "新地址持仓占比最小值，如 \"5\" 表示 5%。" }, { "name": "freshWalletHoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "新地址持仓占比最大值，如 \"5\" 表示 5%。" }, { "name": "insiderHoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "内部地址持仓占比最小值，如 \"5\" 表示 5%。" }, { "name": "insiderHoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "内部地址持仓占比最大值，如 \"5\" 表示 5%。" }, { "name": "bundlerHoldingPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "捆绑地址持仓占比最小值，如 \"5\" 表示 5%。" }, { "name": "bundlerHoldingPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "捆绑地址持仓占比最大值，如 \"5\" 表示 5%。" }, { "name": "devCreatedTokenCountMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "开发者创建代币数量最小值。" }, { "name": "devCreatedTokenCountMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "开发者创建代币数量最大值。" }, { "name": "devMigratedTokenCountMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "开发者迁移代币数量最小值。" }, { "name": "devMigratedTokenCountMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "开发者迁移代币数量最大值。" }, { "name": "devMigratedTokenPercentMin", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "开发者迁移代币占比最小值，如 \"5\" 表示 5%。" }, { "name": "devMigratedTokenPercentMax", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "开发者迁移代币占比最大值，如 \"5\" 表示 5%。" }, { "name": "isDevSoldAll", "in": "query", "required": false, "schema": { "type": "boolean", "example": false }, "description": "设为 true 时，仅返回开发者已全部清仓的代币，不传或设为 false 时不筛选。" }, { "name": "isDevBurned", "in": "query", "required": false, "schema": { "type": "boolean", "example": false }, "description": "设为 true 时，仅返回开发者曾销毁代币的项目，不传或设为 false 时不筛选。" }, { "name": "isMint", "in": "query", "required": false, "schema": { "type": "boolean", "example": false, "default": false }, "description": "设为 true 时，从结果中排除存在可增发功能的代币。默认 false。" }, { "name": "isFreeze", "in": "query", "required": false, "schema": { "type": "boolean", "example": false, "default": false }, "description": "设为 true 时，从结果中排除存在可冻结功能的代币。默认 false。" }, { "name": "isHideWashTradingTokens", "in": "query", "required": false, "schema": { "type": "boolean", "example": true, "default": true }, "description": "设为 true 时，从结果中排除存在刷量行为的代币。默认 true。" }, { "name": "isHideDevWashTradingTokens", "in": "query", "required": false, "schema": { "type": "boolean", "example": true, "default": true }, "description": "设为 true 时，从结果中排除开发者存在刷量行为的代币。默认 true。" }, { "name": "isHideInternalWashTradingTokens", "in": "query", "required": false, "schema": { "type": "boolean", "example": true, "default": true }, "description": "设为 true 时，从结果中排除内幕交易者存在刷量行为的代币。默认 true。" }, { "name": "pageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 1, "default": 1 }, "description": "分页标识。首次请求时不传，获取下一页时传入上次响应返回的 page 值。" }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "default": 100, "maximum": 100 }, "description": "每页返回数量，最大 100，默认 100。" } ], "responses": { "200": { "description": "成功返回热门代币榜单。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32", "nullable": true, "example": 1, "description": "当前页码，无更多数据时返回 null。" }, "items": { "type": "array", "description": "代币列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenSymbol": { "type": "string", "example": "PEPE", "description": "代币符号。" }, "tokenLogoUrl": { "type": "string", "nullable": true, "example": "https://static.onchainos.com/tokens/pepe.png", "description": "代币 Logo 链接。" }, "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "代币合约地址。" }, "marketCap": { "type": "string", "example": "5830000.50", "description": "市值，美元计价。" }, "volume": { "type": "string", "example": "1250000.30", "description": "指定时间内的交易额，美元计价。" }, "change": { "type": "string", "example": "12.5", "description": "指定时间内的价格变动百分比，如 \"-5.23\" 表示下跌 5.23%。" }, "uniqueTraders": { "type": "string", "example": "2341", "description": "独立交易地址数量。" }, "buyTxs": { "type": "string", "example": "1523", "description": "买入交易笔数。" }, "sellTxs": { "type": "string", "example": "987", "description": "卖出交易笔数。" }, "txs": { "type": "string", "example": "2510", "description": "总交易笔数。" }, "liquidity": { "type": "string", "example": "680000.00", "description": "流动性，美元计价。" }, "price": { "type": "string", "example": "0.00000702", "description": "代币价格，美元计价。" }, "holders": { "type": "string", "example": "45832", "description": "持币地址数量。" }, "inflowUsd": { "type": "string", "example": "125000.50", "description": "净流入，美元计价。正值为净流入，负值为净流出。" }, "devHoldingPercent": { "type": "string", "example": "5.5", "description": "开发者持仓占比，如 \"5.23\" 表示 5.23%。" }, "bnHolderCount": { "type": "string", "example": "1203", "description": "持有当前代币的 Binance MPC 钱包数。" }, "top10HoldingPercent": { "type": "string", "example": "35.2", "description": "前 10 地址持仓占比，如 \"35.2\" 表示 35.2%。" }, "sniperHoldingPercent": { "type": "string", "example": "8.3", "description": "狙击者持仓占比，如 \"8.3\" 表示 8.3%。" }, "proHoldingPercent": { "type": "string", "example": "12.1", "description": "专业持有者持仓占比，如 \"12.1\" 表示 12.1%。" }, "freshWalletHoldingPercent": { "type": "string", "example": "3.5", "description": "新地址持仓占比，如 \"3.5\" 表示 3.5%。" }, "smartMoneyHoldingPercent": { "type": "string", "example": "1.52", "description": "聪明钱持仓占比，如 \"1.52\" 表示 1.52%。" }, "kolHoldingPercent": { "type": "string", "example": "6.5", "description": "KOL 持仓占比，如 \"6.5\" 表示 6.5%。" }, "insiderHoldingPercent": { "type": "string", "example": "2.8", "description": "内部地址持仓占比，如 \"2.8\" 表示 2.8%。" }, "bundlerHoldingPercent": { "type": "string", "example": "6.2", "description": "捆绑地址持仓占比，如 \"6.2\" 表示 6.2%。" }, "devCreatedTokenCount": { "type": "string", "example": "3", "description": "开发者创建代币数量。" }, "devMigratedTokenCount": { "type": "string", "example": "1", "description": "开发者迁移代币数量。" }, "devMigratedTokenPercent": { "type": "string", "example": "33.3", "description": "开发者迁移代币占比，如 \"33.3\" 表示 33.3%。" }, "tokenTags": { "type": "array", "description": "代币标签数组。", "items": { "type": "string", "example": "Alpha", "enum": [ "alpha", "tge", "communityRecognized", "devSellAll", "devSell", "devBuy", "smartMoneyBuy", "smartMoneySell", "devRemoveLiquidity", "devAddLiquidity", "devBurnToken", "dexScreenerPaid", "volumeSurge", "volumePlunge", "lowLiquidity", "washTrading", "devWashTrading", "insiderWashTrading" ], "x-enum-descriptions": [ "Alpha", "TGE", "社区认可", "DEV清仓", "DEV减仓", "DEV加仓", "聪明钱加仓", "聪明钱减仓", "DEV减流动性", "DEV加流动性", "DEV烧币", "Dexscreener付费", "交易量骤增", "交易量骤减", "流动性低", "刷量交易", "DEV刷量交易", "内幕交易者刷量交易" ] } } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/token/holder": { "get": { "summary": "获取代币持有人排行", "description": "返回代币的持币地址排行，包含持币数量、持币占比、主链币余额、买卖均价、已实现盈亏及资金来源信息。最多返回100条记录，不支持分页。", "tags": ["General Data"], "operationId": "getHoldersRanking", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-holders-ranking" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getHoldersRanking.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_holders_ranking.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetHoldersRankingExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933" }, "description": "代币合约地址。" }, { "name": "tagFilter", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 1, "enum": [1, 2, 3, 4, 5, 6] }, "description": "地址标签筛选，仅支持单选。不传时返回全部持仓地址（按持仓量降序）；传入特定标签时，返回对应标签的持仓地址，映射关系为：1=KOL，2=开发者，3=聪明钱，4=内部交易者，5=狙击手，6=捆绑者。" } ], "responses": { "200": { "description": "成功返回持有人排行。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "持仓地址列表。", "items": { "type": "object", "properties": { "holderWalletAddress": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60", "description": "持币地址。" }, "holdAmount": { "type": "string", "example": "18580000", "description": "持币数量。" }, "holdingPercent": { "type": "string", "example": "5.23", "description": "持仓占比，如 \"5.23\" 表示 5.23%。" }, "nativeTokenSymbol": { "type": "string", "example": "ETH", "description": "主链币符号。" }, "nativeTokenBalance": { "type": "string", "example": "12.5", "description": "该地址的主链币余额。" }, "boughtAmount": { "type": "string", "example": "18580000", "description": "累计买入数量。" }, "avgBuyPrice": { "type": "string", "example": "0.000105", "description": "平均买入价格，美元计价。" }, "soldAmount": { "type": "string", "example": "15000000", "description": "累计卖出数量。" }, "avgSellPrice": { "type": "string", "example": "0.000195", "description": "平均卖出价格，美元计价。" }, "maxHoldAmount": { "type": "string", "example": "30000000", "description": "历史最大持有量。" }, "lastTradeTime": { "type": "integer", "format": "int64", "example": 1716892020000, "description": "对应地址最后交易该代币的时间，Unix 毫秒时间戳。" }, "realizedPnlUsd": { "type": "string", "example": "1277.84", "description": "已实现盈亏，美元计价。正值为盈利，负值为亏损。" }, "fundingSource": { "type": "string", "nullable": true, "example": "0x28c6c06298d514db089934071355e5743bf21d60", "description": "资金来源地址，即首笔主链币转入的来源地址，无转入记录时返回 null。" }, "fundingSourceLabel": { "type": "object", "nullable": true, "description": "资金来源标签（如交易所标签），未知时返回 null。", "properties": { "tagName": { "type": "string", "example": "cex", "description": "标签类别名称。" }, "tagValue": { "type": "string", "example": "Binance", "description": "标签值。" } } }, "fundingSourceHash": { "type": "string", "nullable": true, "example": "0x3a2b1c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b", "description": "首笔主链币转入的交易哈希。" }, "fundingSourceTime": { "type": "integer", "format": "int64", "nullable": true, "example": 1714000000000, "description": "首笔主链币转入时间，Unix 毫秒时间戳。" }, "fundingSourceAmount": { "type": "string", "nullable": true, "example": "0.5", "description": "首笔主链币转入数量，如 0.5 表示 0.5 ETH。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/token/top-trader": { "get": { "summary": "获取代币盈利地址排行", "description": "返回代币的头部盈利地址，按已实现收益从高到低排序。包含持仓、买卖均价、已实现盈亏及资金来源。最多返回100条记录，不支持分页。", "tags": ["General Data"], "operationId": "getTopTraders", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-top-traders" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getTopTraders.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_top_traders.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetTopTradersExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933" }, "description": "代币合约地址。" }, { "name": "tagFilter", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7] }, "description": "地址标签筛选，仅支持单选。不传时返回全部盈利地址（按已实现收益降序）；传入特定标签时，返回对应标签的头部盈利地址，映射关系为：1=KOL，2=开发者，3=聪明钱，4=内部交易者，5=狙击手，6=捆绑者，7=持币大户。" } ], "responses": { "200": { "description": "成功返回盈利地址排行。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "头部盈利地址列表。", "items": { "type": "object", "properties": { "holderWalletAddress": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60", "description": "钱包地址。" }, "holdAmount": { "type": "string", "example": "18580000", "description": "持币数量。" }, "holdingPercent": { "type": "string", "example": "3.5", "description": "持仓占比，如 \"3.5\" 表示 3.5%。" }, "boughtAmount": { "type": "string", "example": "25000000", "description": "总买入数量。" }, "avgBuyPrice": { "type": "string", "example": "0.000105", "description": "平均买入价格，美元计价。" }, "soldAmount": { "type": "string", "example": "20000000", "description": "总卖出数量。" }, "avgSellPrice": { "type": "string", "example": "0.000195", "description": "平均卖出价格，美元计价。" }, "maxHoldAmount": { "type": "string", "example": "30000000", "description": "历史最大持有量。" }, "lastTradeTime": { "type": "integer", "format": "int64", "example": 1716892020000, "description": "对应地址最后交易该代币的时间，Unix 毫秒时间戳。" }, "realizedPnlUsd": { "type": "string", "example": "1800.30", "description": "已实现盈亏，美元计价。正值为盈利，负值为亏损。" }, "fundingSource": { "type": "string", "nullable": true, "example": "0x21a31ee1afc51d94c2efccaa2092ad1028285549", "description": "资金来源地址，即首笔主链币转入的来源地址，无转入记录时返回 null。" }, "fundingSourceLabel": { "type": "object", "nullable": true, "description": "资金来源标签（如交易所标签），未知时返回 null。", "properties": { "tagName": { "type": "string", "example": "cex", "description": "标签类别名称。" }, "tagValue": { "type": "string", "example": "Binance", "description": "标签值。" } } }, "fundingSourceHash": { "type": "string", "nullable": true, "example": "0x3a2b1c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b", "description": "首笔主链币转入的交易哈希。" }, "fundingSourceTime": { "type": "integer", "format": "int64", "nullable": true, "example": 1714000000000, "description": "首笔主链币转入时间，Unix 毫秒时间戳。" }, "fundingSourceAmount": { "type": "string", "nullable": true, "example": "0.5", "description": "首笔主链币转入数量，如 0.5 表示 0.5 ETH。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/token/top-liquidity": { "get": { "summary": "获取代币流动性池信息", "description": "返回代币的主要流动性池信息，包含流动性池地址、名称、深度及代币组成。", "tags": ["General Data"], "operationId": "getTopLiquidityPools", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-top-liquidity-pools" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getTopLiquidityPools.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_top_liquidity_pools.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetTopLiquidityPoolsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933" }, "description": "代币合约地址。" } ], "responses": { "200": { "description": "成功返回流动性池列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "流动性池列表。", "items": { "type": "object", "properties": { "pool": { "type": "string", "example": "PEPE/WETH", "description": "资金池名称，如 \"PEPE/WETH\"。" }, "protocolName": { "type": "string", "nullable": true, "example": "Uniswap V3", "description": "协议名称，未知时返回 null。" }, "protocolLogoUrl": { "type": "string", "nullable": true, "example": "https://static.onchainos.com/protocols/uniswap.png", "description": "协议 Logo 链接，无 Logo 时返回 null。" }, "liquidityUsd": { "type": "string", "example": "680000.00", "description": "池子流动性，美元计价。" }, "poolAddress": { "type": "string", "example": "0x11950d141ecb863f01007add7d1a342041227b58", "description": "池子合约地址。" }, "liquidityAmount": { "type": "array", "description": "流动性池中各代币的详细信息。", "items": { "type": "object", "properties": { "tokenAmount": { "type": "string", "example": "1500000000", "description": "对应代币的数量。" }, "tokenSymbol": { "type": "string", "example": "PEPE", "description": "代币符号。" }, "tokenName": { "type": "string", "example": "Pepe", "description": "代币名称。" }, "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "代币合约地址。" }, "tokenLogoUrl": { "type": "string", "nullable": true, "example": "https://static.onchainos.com/tokens/pepe.png", "description": "代币 Logo 链接，无 Logo 时返回 null。" } } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/trades": { "get": { "summary": "获取代币交易历史", "description": "获取代币在链上的交易历史，支持标签与特定地址筛选。", "tags": ["General Data"], "operationId": "getTokenTrades", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-token-trades" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getTokenTrades.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_token_trades.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetTokenTradesExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933" }, "description": "代币合约地址。" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "example": "eyJ0aW1lIjoxNzQ4NjAwMDAwMDAwLCJpZCI6MTIzfQ==" }, "description": "分页游标。首次查询时不传，获取下一页时传入上次响应返回的 cursor 值。" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "default": 100, "minimum": 1, "maximum": 500 }, "description": "每页返回条数，最大 500，默认 100。" }, { "name": "tagFilter", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 1, "enum": [1, 2, 3, 4, 5, 6, 7] }, "description": "地址标签筛选，仅支持单选。不传时返回全部地址的交易记录（支持分页）；传入特定标签时，仅返回该标签地址的最近 100 条交易记录（cursor 和 limit 不生效），映射关系为：1=KOL，2=开发者，3=聪明钱，4=内部交易者，5=狙击手，6=捆绑者，7=持币大户。" }, { "name": "walletAddressFilter", "in": "query", "required": false, "schema": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60" }, "description": "查询特定地址的交易历史，输入多个地址时，以逗号分隔，最多可输入两个地址。" } ], "responses": { "200": { "description": "成功返回交易历史。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "cursor": { "type": "string", "example": "eyJ0aW1lIjoxNzQ4NTk5MDAwMDAwLCJpZCI6Nzh9", "description": "下一页游标，无更多数据时为空字符串。" }, "trades": { "type": "array", "description": "交易列表，按交易时间倒序排列。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "代币合约地址。" }, "txHash": { "type": "string", "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890", "description": "链上交易哈希。" }, "userAddress": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60", "description": "交易发起方钱包地址。" }, "dexName": { "type": "string", "example": "Uniswap V3", "description": "交易所在的 DEX 协议名称。" }, "type": { "type": "string", "example": "buy", "enum": ["buy", "sell"], "description": "交易方向，相对查询代币而言。\"buy\"=买入，\"sell\"=卖出。" }, "price": { "type": "string", "example": "0.00000702", "description": "成交价格，美元计价。" }, "volume": { "type": "string", "example": "1500.50", "description": "成交金额，美元计价。" }, "time": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "交易时间，Unix 毫秒时间戳。" }, "changedTokenInfo": { "type": "array", "description": "交易涉及的代币信息。[0]=查询代币，[1]=配对代币。", "items": { "type": "object", "properties": { "amount": { "type": "string", "example": "1500000", "description": "成交代币数量。" }, "tokenSymbol": { "type": "string", "example": "PEPE", "description": "代币符号。" }, "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "代币合约地址。" } } } } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/memepump/tokenDevInfo": { "get": { "summary": "获取代币开发者信息", "description": "返回代币开发者画像信息，包含历史发币统计、当前持仓占比及首笔资金来源等。", "tags": ["General Data"], "operationId": "getTokenDevInfo", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/general-data#get-token-dev-info" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/MarketApi/getTokenDevInfo.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Market/get_token_dev_info.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/market/GetTokenDevInfoExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "CT_501" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" }, "description": "代币合约地址。EVM 链传全小写 42 位十六进制地址；Solana 传 base58 地址（大小写敏感）。" } ], "responses": { "200": { "description": "成功返回代币开发者信息。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "代币开发者信息。", "properties": { "devLaunchedInfo": { "type": "object", "description": "该开发者历史发币汇总信息。", "properties": { "totalToken": { "type": "string", "example": "5", "description": "该开发者历史上通过发射平台发行的代币总数。" }, "migratedCount": { "type": "string", "example": "1", "description": "该开发者历史上成功迁移至外盘的代币数量。" } } }, "devHoldingInfo": { "type": "object", "description": "开发者当前持仓信息。", "properties": { "devHoldingPercent": { "type": "string", "example": "2.5", "description": "开发者在该代币中的当前持仓占比，不带 %。空字符串表示已清仓。" }, "devAddress": { "type": "string", "example": "0x382bb369d343125bfb2117af9c149795c6c65c50", "description": "开发者（创建者）钱包地址。" }, "fundingSource": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60", "description": "资金来源地址，即首笔主链币转入的 from 地址。无转入记录时返回空字符串。" }, "fundingSourceLabel": { "type": "string", "example": "Binance", "description": "资金来源名称（如交易所名称），未知时返回空字符串。" }, "fundingSourceHash": { "type": "string", "example": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "description": "首笔主链币转入的交易哈希。" }, "fundingSourceTime": { "type": "string", "example": "1777117516000", "description": "首笔主链币转入的时间，Unix 毫秒时间戳。" }, "fundingSourceAmount": { "type": "string", "example": "1.5", "description": "首笔主链币转入的主链币数量。" }, "devBalance": { "type": "string", "example": "10.5", "description": "开发者钱包中的链原生代币余额（如 SOL）。无法获取时返回空字符串。" } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/portfolio/supported/chain": { "get": { "summary": "获取支持的链", "description": "返回地址分析功能支持的区块链列表。", "tags": ["Address Portfolio"], "operationId": "getPortfolioSupportedChains", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/address-portfolio#get-portfolio-supported-chains" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/AddressPortfolioApi/getPortfolioSupportedChains.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/AddressPortfolio/get_portfolio_supported_chains.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/addressportfolio/GetPortfolioSupportedChainsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "responses": { "200": { "description": "成功返回支持的链列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "支持的区块链网络列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "name": { "type": "string", "example": "Ethereum", "description": "链全称。" }, "shortName": { "type": "string", "example": "ETH", "description": "链简称（全大写）。" }, "logoUrl": { "type": "string", "example": "https://onchainos.bnbstatic.com/image/admin_mgs_image_upload/20250228/b549e557-76ca-4873-88ef-3a107cf2c9fe.png", "description": "链 Logo 链接。" }, "caseSensitive": { "type": "boolean", "example": false, "description": "该链的地址是否区分大小写。true=区分（如 Solana），false=不区分（如 EVM 链）。" }, "nativeTokenSymbol": { "type": "string", "example": "ETH", "description": "原生代币符号（全大写）。" }, "nativeTokenDecimals": { "type": "integer", "format": "int32", "example": 18, "description": "原生代币精度。显示值 = 原始值 / 10^nativeTokenDecimals。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/portfolio/overview": { "get": { "summary": "获取地址画像概览", "description": "返回指定地址在选定时间范围内的交易表现概览，包含已实现盈亏、每日盈亏明细、胜率及 Top 3 盈利代币。", "tags": ["Address Portfolio"], "operationId": "getAddressPortfolioOverview", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/address-portfolio#get-address-portfolio-overview" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/AddressPortfolioApi/getAddressPortfolioOverview.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/AddressPortfolio/get_address_portfolio_overview.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/addressportfolio/GetAddressPortfolioOverviewExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "walletAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60" }, "description": "查询的钱包地址。EVM 链传全小写 42 位十六进制地址；Solana 传 base58 地址（大小写敏感）。" }, { "name": "timeFrame", "in": "query", "required": true, "schema": { "type": "string", "example": "2", "enum": ["1", "2", "3", "4"] }, "description": "统计时间范围。1=1D，2=7D，3=1M，4=3M。注意：本接口取值与 leaderboard/list 接口（1=7D，2=1M，3=3M）不同，请勿跨接口复用枚举值。" } ], "responses": { "200": { "description": "成功返回地址画像概览。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "地址画像概览数据。", "properties": { "realizedPnlUsd": { "type": "string", "example": "4670.50", "description": "该地址在 timeFrame 内的已实现盈亏总额，单位 USD。正值为盈利，负值为亏损。" }, "realizedPnlPercent": { "type": "string", "example": "16.44", "description": "该地址在 timeFrame 内的已实现盈亏百分比，不带 %。如 \"16.44\" 表示 +16.44%。" }, "dailyPnl": { "type": "array", "description": "每日已实现盈亏明细，按日期倒序排列（最新日期在前），条数与 timeFrame 对应。", "items": { "type": "object", "properties": { "date": { "type": "string", "example": "2026-04-25", "description": "日期，格式 YYYY-MM-DD。" }, "pnlUsd": { "type": "string", "example": "120.50", "description": "当日已实现盈亏，单位 USD。正值为盈利，负值为亏损。" } } } }, "winRate": { "type": "string", "example": "61.11", "description": "该地址在 timeFrame 内的胜率，不带 %。如 \"61.11\" 表示 61.11%。" }, "tokenCountByPnlPercent": { "type": "object", "description": "按已实现盈亏百分比分类的代币数量统计。", "properties": { "over500Percent": { "type": "string", "example": "3", "description": "已实现盈亏 ≥500% 的代币数量。" }, "from200To500Percent": { "type": "string", "example": "5", "description": "已实现盈亏在 [200%, 500%) 的代币数量。" }, "from50To200Percent": { "type": "string", "example": "8", "description": "已实现盈亏在 [50%, 200%) 的代币数量。" }, "zeroTo50Percent": { "type": "string", "example": "12", "description": "已实现盈亏在 [0%, 50%) 的代币数量。" }, "zeroToMinus50Percent": { "type": "string", "example": "7", "description": "已实现盈亏在 [-50%, 0%) 的代币数量。" }, "overMinus50Percent": { "type": "string", "example": "4", "description": "已实现盈亏 < -50% 的代币数量。" } } }, "buyTxCount": { "type": "string", "example": "145", "description": "该地址在 timeFrame 内的买入交易笔数。" }, "sellTxCount": { "type": "string", "example": "132", "description": "该地址在 timeFrame 内的卖出交易笔数。" }, "totalTokenCount": { "type": "string", "example": "73", "description": "该地址在 timeFrame 内交易过的代币总数（去重）。" }, "buyTxVolume": { "type": "string", "example": "15000.50", "description": "该地址在 timeFrame 内的买入交易总额，单位 USD。" }, "sellTxVolume": { "type": "string", "example": "12000.30", "description": "该地址在 timeFrame 内的卖出交易总额，单位 USD。" }, "avgBuyValueUsd": { "type": "string", "example": "86.71", "description": "该地址在 timeFrame 内的平均单笔买入价值，单位 USD。" }, "top3PnlTokenSumUsd": { "type": "string", "example": "3200.00", "description": "Top 3 代币的已实现盈亏总额，单位 USD。" }, "top3PnlTokenPercent": { "type": "string", "example": "68.52", "description": "Top 3 代币已实现盈亏占该地址总已实现盈亏的百分比，不带 %。" }, "topPnlTokenList": { "type": "array", "description": "PnL 排名前 3 的代币列表。若交易代币不足 3 个则按实际数量返回。", "items": { "type": "object", "properties": { "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "代币合约地址。EVM 全小写，Solana 原样保留。" }, "tokenSymbol": { "type": "string", "example": "PEPE", "description": "代币符号。" }, "tokenPnLUsd": { "type": "string", "example": "1200.50", "description": "该代币的已实现盈亏，单位 USD。正值为盈利，负值为亏损。" }, "tokenPnLPercent": { "type": "string", "example": "250.5", "description": "该代币的已实现盈亏百分比，不带 %。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/portfolio/recent-pnl": { "get": { "summary": "获取地址近期收益列表", "description": "返回地址的近期已实现收益列表。", "tags": ["Address Portfolio"], "operationId": "getAddressRecentPnL", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/address-portfolio#get-address-recent-pn-l" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/AddressPortfolioApi/getAddressRecentPnL.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/AddressPortfolio/get_address_recent_pn_l.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/addressportfolio/GetAddressRecentPnLExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "walletAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60" }, "description": "查询的钱包地址。EVM 链传全小写 42 位十六进制地址；Solana 传 base58 地址（大小写敏感）。" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "example": "" }, "description": "分页游标。首次请求不传或传空字符串；后续传上一次响应返回的 cursor 值。" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "20" }, "description": "每页返回数量，默认 20，最大 100。" } ], "responses": { "200": { "description": "成功返回近期收益列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "分页收益列表。", "properties": { "cursor": { "type": "string", "example": "", "description": "下一页分页游标，无更多数据时返回空字符串。" }, "pnlList": { "type": "array", "description": "收益列表，按 lastActiveTimestamp 降序排列。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "代币合约地址。EVM 全小写，Solana 原样保留。" }, "tokenSymbol": { "type": "string", "example": "PEPE", "description": "代币符号。" }, "lastActiveTimestamp": { "type": "string", "example": "1769398550000", "description": "该代币最后一笔交易的时间，Unix 毫秒时间戳。" }, "realizedPnlUsd": { "type": "string", "example": "1277.837", "description": "该地址在该代币上的已实现盈亏，单位 USD。正值为盈利，负值为亏损。" }, "realizedPnlPercent": { "type": "string", "example": "77.64", "description": "该地址在该代币上的已实现盈亏百分比，不带 %。" }, "tokenBalanceUsd": { "type": "string", "example": "333.598", "description": "该地址当前持有该代币的市值，单位 USD。" }, "tokenBalanceAmount": { "type": "string", "example": "18580000", "description": "该地址当前持有该代币的数量（代币单位）。" }, "tokenPositionDuration": { "type": "object", "description": "代币持仓时长信息。", "properties": { "holdingTimestamp": { "type": "string", "example": "1756873866000", "description": "该地址首次买入该代币的时间戳，Unix 毫秒时间戳。" } } }, "buyTxCount": { "type": "string", "example": "5", "description": "买入交易次数。" }, "buyTxVolume": { "type": "string", "example": "1958.067", "description": "该地址买入该代币的总花费，单位 USD。" }, "buyAvgPrice": { "type": "string", "example": "0.000105", "description": "该地址买入该代币的平均成交价格，单位 USD。" }, "sellTxCount": { "type": "string", "example": "3", "description": "卖出交易次数。" }, "sellTxVolume": { "type": "string", "example": "2923.574", "description": "该地址卖出该代币的总收入，单位 USD。" }, "sellAvgPrice": { "type": "string", "example": "0.000195", "description": "该地址卖出该代币的平均成交价格，单位 USD。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/portfolio/token/latest-pnl": { "get": { "summary": "获取地址单一代币最新收益", "description": "返回指定地址对特定代币的最新已实现收益明细，包含买卖统计、当前持仓及持仓时长。", "tags": ["Address Portfolio"], "operationId": "getAddressPnLForSpecificToken", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/address-portfolio#get-address-pn-lfor-specific-token" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/AddressPortfolioApi/getAddressPnLForSpecificToken.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/AddressPortfolio/get_address_pn_l_for_specific_token.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/addressportfolio/GetAddressPnLForSpecificTokenExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "walletAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60" }, "description": "查询的钱包地址。EVM 链传全小写 42 位十六进制地址；Solana 传 base58 地址（大小写敏感）。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933" }, "description": "代币合约地址。EVM 链传全小写 42 位十六进制地址；Solana 传 base58 地址（大小写敏感）。" } ], "responses": { "200": { "description": "成功返回单代币最新收益。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "单代币最新收益明细。", "properties": { "realizedPnlUsd": { "type": "string", "example": "1277.837", "description": "该地址在该代币上的累计已实现盈亏，单位 USD。正值为盈利，负值为亏损。" }, "realizedPnlPercent": { "type": "string", "example": "77.64", "description": "已实现盈亏百分比，不带 %。" }, "buyTxVolume": { "type": "string", "example": "1958.067", "description": "该地址买入该代币的累计花费，单位 USD。" }, "buyAmount": { "type": "string", "example": "18580000", "description": "该地址累计买入的代币数量（代币单位）。" }, "buyTxCount": { "type": "string", "example": "5", "description": "买入交易笔数。" }, "sellTxVolume": { "type": "string", "example": "2923.574", "description": "该地址卖出该代币的累计收入，单位 USD。" }, "sellAmount": { "type": "string", "example": "15000000", "description": "该地址累计卖出的代币数量（代币单位）。" }, "sellTxCount": { "type": "string", "example": "3", "description": "卖出交易笔数。" }, "buyAvgPrice": { "type": "string", "example": "0.000105", "description": "买入平均成交单价，单位 USD。" }, "sellAvgPrice": { "type": "string", "example": "0.000195", "description": "卖出平均成交单价，单位 USD。" }, "tokenBalanceUsd": { "type": "string", "example": "333.598", "description": "该地址当前持有该代币的市值，单位 USD。已清仓时返回 \"0\"。" }, "tokenBalanceAmount": { "type": "string", "example": "3580000", "description": "该地址当前持有该代币的数量（代币单位）。已清仓时返回 \"0\"。" }, "maxBalanceAmount": { "type": "string", "example": "18580000", "description": "该地址历史上持有该代币的最大数量（代币单位）。" }, "holdingDuration": { "type": "string", "example": "864000000", "description": "累计持仓时长，单位毫秒。仅累加实际持有区间，中间空仓期不计入。若仍持有则计算至当前时间。" }, "isPnlSupported": { "type": "boolean", "example": true, "description": "该代币是否支持 PnL 计算。true=支持；false=不支持。 稳定币（USDT/USDC/DAI 等）、原生代币（ETH/BNB/SOL 等）及 Wrapped 代币（WETH/WBNB/WSOL 等）返回 false；普通交易代币返回 true。" } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/portfolio/dex-history": { "get": { "summary": "获取地址历史兑换交易", "description": "返回特定地址的兑换交易列表，支持按时间范围、代币及交易类型筛选。", "tags": ["Address Portfolio"], "operationId": "getDexTradeHistory", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/address-portfolio#get-dex-trade-history" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/AddressPortfolioApi/getDexTradeHistory.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/AddressPortfolio/get_dex_trade_history.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/addressportfolio/GetDexTradeHistoryExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "walletAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60" }, "description": "查询的钱包地址。EVM 链传全小写 42 位十六进制地址；Solana 传 base58 地址（大小写敏感）。" }, { "name": "begin", "in": "query", "required": false, "schema": { "type": "string", "example": "1714000000000" }, "description": "开始时间戳（Unix 毫秒，含两端）。begin 和 end 都不传时不做时间限制。" }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string", "example": "1748601600000" }, "description": "结束时间戳（Unix 毫秒，含两端）。begin 和 end 都不传时不做时间限制。" }, { "name": "tokenContractAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933" }, "description": "按代币合约地址筛选，不传则返回所有代币的交易。" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "example": "1", "enum": ["1", "2"] }, "description": "交易类型筛选。1=买入，2=卖出。不传则返回全部类型。" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "example": "" }, "description": "分页游标。首次请求不传或传空字符串。" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "20" }, "description": "每页返回数量，默认 20，最大 100。" } ], "responses": { "200": { "description": "成功返回历史 DEX 交易列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "分页 DEX 交易列表。", "properties": { "cursor": { "type": "string", "example": "", "description": "下一页分页游标，无更多数据时返回空字符串。" }, "transactionList": { "type": "array", "description": "DEX 交易记录列表，按时间倒序排列。", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "1", "description": "交易类型。1=买入，2=卖出。" }, "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "代币合约地址。EVM 全小写，Solana 原样保留。" }, "tokenSymbol": { "type": "string", "example": "PEPE", "description": "代币符号。" }, "valueUsd": { "type": "string", "example": "312.329", "description": "该笔交易的成交金额，单位 USD。" }, "amount": { "type": "string", "example": "18580000", "description": "该笔交易涉及的代币数量（代币单位）。" }, "price": { "type": "string", "example": "0.000016807", "description": "该笔交易的成交单价，单位 USD。" }, "marketCap": { "type": "string", "example": "168070.50", "description": "该笔交易发生时代币的市值，单位 USD。" }, "txHash": { "type": "string", "example": "0x3a2b1c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b", "description": "该笔历史交易的链上哈希。" }, "chainLogoUrl": { "type": "string", "example": "https://onchainos.bnbstatic.com/image/admin_mgs_image_upload/20250228/b549e557-76ca-4873-88ef-3a107cf2c9fe.png", "description": "链 icon 的 URL。" }, "time": { "type": "string", "example": "1714000000000", "description": "对应交易哈希上链时间，Unix 毫秒时间戳。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/leaderboard/list": { "get": { "summary": "获取牛人榜列表", "description": "返回分页的牛人榜钱包地址列表，支持按盈亏、胜率、交易笔数及交易额等多维度筛选和排序。", "tags": ["Address Portfolio"], "operationId": "getLeaderboard", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/address-portfolio#get-leaderboard" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/AddressPortfolioApi/getLeaderboard.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/AddressPortfolio/get_leaderboard.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/addressportfolio/GetLeaderboardExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。仅支持单链查询。" }, { "name": "timeFrame", "in": "query", "required": true, "schema": { "type": "string", "example": "2", "enum": ["1", "2", "3"] }, "description": "牛人榜统计时间范围。1=7D，2=1M，3=3M。注意：本接口取值与 portfolio/overview 接口（1=1D，2=7D，3=1M，4=3M）不同，请勿跨接口复用枚举值。" }, { "name": "sortBy", "in": "query", "required": true, "schema": { "type": "string", "example": "1", "enum": ["1", "2", "3", "4", "5"] }, "description": "排序依据。1=已实现盈亏（USD），2=胜率，3=交易笔数，4=交易额（USD），5=已实现盈亏百分比。" }, { "name": "walletType", "in": "query", "required": false, "schema": { "type": "string", "example": "2", "enum": ["1", "2", "3"] }, "description": "按钱包类型筛选，仅单选。1=聪明钱，2=KOL，3=热门榜。不传则返回全部类型。" }, { "name": "minRealizedPnlUsd", "in": "query", "required": false, "schema": { "type": "string", "example": "1000" }, "description": "筛选已实现盈亏下限，单位 USD。" }, { "name": "maxRealizedPnlUsd", "in": "query", "required": false, "schema": { "type": "string", "example": "50000" }, "description": "筛选已实现盈亏上限，单位 USD。" }, { "name": "minWinRatePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "50" }, "description": "筛选胜率下限，不带 %。如 \"50\" 表示胜率 ≥50%。" }, { "name": "maxWinRatePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "90" }, "description": "筛选胜率上限，不带 %。如 \"90\" 表示胜率 ≤90%。" }, { "name": "minTxs", "in": "query", "required": false, "schema": { "type": "string", "example": "10" }, "description": "筛选交易笔数下限。" }, { "name": "maxTxs", "in": "query", "required": false, "schema": { "type": "string", "example": "1000" }, "description": "筛选交易笔数上限。" }, { "name": "minTxVolume", "in": "query", "required": false, "schema": { "type": "string", "example": "5000" }, "description": "筛选交易总额下限，单位 USD。" }, { "name": "maxTxVolume", "in": "query", "required": false, "schema": { "type": "string", "example": "1000000" }, "description": "筛选交易总额上限，单位 USD。" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "example": "" }, "description": "分页游标。首次请求不传或传空字符串。" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "50" }, "description": "每页返回数量，默认 50，最大 50。" } ], "responses": { "200": { "description": "成功返回牛人榜列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "分页牛人榜数据。", "properties": { "cursor": { "type": "string", "example": "", "description": "下一页分页游标，无更多数据时返回空字符串。" }, "items": { "type": "array", "description": "牛人榜钱包列表。", "items": { "type": "object", "properties": { "walletAddress": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60", "description": "钱包地址。" }, "walletName": { "type": "string", "example": "Smart Money #1", "description": "钱包名称，无法获取时返回空字符串。" }, "walletLogoUrl": { "type": "string", "example": "", "description": "钱包头像 URL，无则返回空字符串。" }, "walletTwitterUrl": { "type": "string", "example": "https://x.com/example_trader", "description": "钱包关联的 Twitter 链接，无则返回空字符串。" }, "walletType": { "type": "string", "example": "1,2", "description": "钱包类型标签，命中多个时逗号分隔。1=聪明钱，2=KOL，3=热门榜。未命中任何标签时返回空字符串。" }, "nativeTokenBalance": { "type": "string", "example": "12.5", "description": "该地址在所查询链上的原生代币余额数量。" }, "nativeTokenBalanceUsd": { "type": "string", "example": "31250.00", "description": "该地址在所查询链上的原生代币余额，折算为 USD。" }, "realizedPnlUsd": { "type": "string", "example": "1204530.647494", "description": "该地址在统计时间范围内的累计已实现盈亏，单位 USD。正值为盈利，负值为亏损。" }, "realizedPnlPercent": { "type": "string", "example": "1699.97", "description": "该地址在统计时间范围内的盈亏百分比，不带 %。" }, "dailyPnl": { "type": "array", "description": "所选时间区间内每日已实现盈亏明细，按日期倒序排列。", "items": { "type": "object", "properties": { "date": { "type": "string", "example": "2026-04-25", "description": "日期，格式 YYYY-MM-DD。" }, "pnlUsd": { "type": "string", "example": "12000.50", "description": "当日已实现盈亏，单位 USD。" } } } }, "winRatePercent": { "type": "string", "example": "100.0", "description": "该地址在统计时间范围内的交易胜率，不带 %。" }, "txVolume": { "type": "string", "example": "1346559.275964", "description": "该地址在统计时间范围内的总交易额，单位 USD。等于 buyTxVolume + sellTxVolume。" }, "buyTxVolume": { "type": "string", "example": "673279.637982", "description": "该地址在统计时间范围内所有 DEX 买入交易的总金额，单位 USD。" }, "sellTxVolume": { "type": "string", "example": "673279.637982", "description": "该地址在统计时间范围内所有 DEX 卖出交易的总金额，单位 USD。" }, "avgBuyValueUsd": { "type": "string", "example": "23724.225", "description": "该地址在统计时间范围内的平均单笔买入金额，单位 USD。无买入交易时返回 \"0\"。" }, "txs": { "type": "string", "example": "40", "description": "该地址在统计时间范围内的总交易笔数。等于 buyTxCount + sellTxCount。" }, "buyTxCount": { "type": "string", "example": "20", "description": "该地址在统计时间范围内的 DEX 买入交易笔数。" }, "sellTxCount": { "type": "string", "example": "20", "description": "该地址在统计时间范围内的 DEX 卖出交易笔数。" }, "topPnlTokenList": { "type": "array", "description": "PnL 排名前 3 的代币列表。若交易代币不足 3 个则按实际数量返回。", "items": { "type": "object", "properties": { "tokenContractAddress": { "type": "string", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7", "description": "代币合约地址。EVM 全小写，Solana 原样保留。" }, "tokenSymbol": { "type": "string", "example": "USDT", "description": "代币符号。" }, "tokenLogoUrl": { "type": "string", "example": "https://static.onchainos.com/tokens/usdt.png", "description": "代币 logo 的 URL。" }, "tokenPnLUsd": { "type": "string", "example": "5000.50", "description": "该地址在该代币上的盈亏金额，单位 USD。正值为盈利，负值为亏损。" }, "tokenPnLPercent": { "type": "string", "example": "250.5", "description": "该地址在该代币上的盈亏百分比，不带 %。" } } } }, "tokenCountByPnlPercent": { "type": "object", "description": "所选时间区间内该钱包交易过的所有代币，按已实现盈亏百分比划分的数量统计。", "properties": { "above500Percent": { "type": "string", "example": "3", "description": "已实现盈亏 >500% 的代币数量。" }, "between0And500Percent": { "type": "string", "example": "8", "description": "已实现盈亏在 0%~500%（含）之间的代币数量。" }, "betweenNeg50And0Percent": { "type": "string", "example": "5", "description": "已实现盈亏在 -50%~0%（含）之间的代币数量。" }, "belowNeg50Percent": { "type": "string", "example": "2", "description": "已实现盈亏 < -50% 的代币数量。" } } }, "lastActiveTimestamp": { "type": "string", "example": "1776995058000", "description": "该地址最后一次交易的时间戳，Unix 毫秒时间戳。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/address-tracker/trades": { "get": { "summary": "获取多地址的最新兑换交易", "description": "返回追踪地址（聪明钱、KOL 或自定义地址列表）的最新兑换交易。", "tags": ["Address Portfolio"], "operationId": "getTrackedTrades", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/address-portfolio#get-tracked-trades" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/AddressPortfolioApi/getTrackedTrades.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/AddressPortfolio/get_tracked_trades.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/addressportfolio/GetTrackedTradesExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "trackerType", "in": "query", "required": true, "schema": { "type": "string", "example": "1", "enum": ["1", "2", "3"] }, "description": "追踪动态类型。1=聪明钱，2=KOL，3=自定义多地址（需传 walletAddress）。" }, { "name": "walletAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60,0xd8da6bf26964af9d7eed9e03e53415d37aa96045" }, "description": "当 trackerType=3 时必填。单个或多个钱包地址，逗号分隔，最多 20 个。EVM 链传全小写 42 位十六进制地址；Solana 传 base58 地址（大小写敏感）。" }, { "name": "tradeType", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "交易类型筛选。0=全部（默认），1=买入，2=卖出，3=加仓，4=减仓，5=建仓，6=清仓，7=转入，8=转出。支持多选，逗号分隔。" }, { "name": "binanceChainId", "in": "query", "required": false, "schema": { "type": "string", "example": "1" }, "description": "按链筛选，不传则返回全部链。" }, { "name": "minVolume", "in": "query", "required": false, "schema": { "type": "string", "example": "100" }, "description": "最小成交额筛选，单位 USD。" }, { "name": "maxVolume", "in": "query", "required": false, "schema": { "type": "string", "example": "100000" }, "description": "最大成交额筛选，单位 USD。" }, { "name": "minMarketCap", "in": "query", "required": false, "schema": { "type": "string", "example": "10000" }, "description": "最小市值筛选，单位 USD。" }, { "name": "maxMarketCap", "in": "query", "required": false, "schema": { "type": "string", "example": "10000000" }, "description": "最大市值筛选，单位 USD。" }, { "name": "isHideRiskToken", "in": "query", "required": false, "schema": { "type": "boolean", "example": true, "default": true }, "description": "是否隐藏风险代币。true=隐藏风险代币（默认），false=展示全部代币（含风险代币）。" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 50 }, "description": "最多返回的交易条数。仅 trackerType=3（自定义地址列表）生效；trackerType=1/2 忽略该参数， 使用下游 public 查询的固定上限。不传时使用下游默认值。" } ], "responses": { "200": { "description": "成功返回追踪地址的最新交易动态。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "追踪地址的交易动态结果。", "properties": { "trades": { "type": "array", "description": "追踪地址的交易动态列表。", "items": { "type": "object", "properties": { "txHash": { "type": "string", "example": "0x3a2b1c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b", "description": "追踪到的交易哈希。" }, "walletAddress": { "type": "string", "example": "0x28c6c06298d514db089934071355e5743bf21d60", "description": "发起该笔交易的钱包地址。EVM 全小写，Solana 原样保留。" }, "tokenSymbol": { "type": "string", "example": "PEPE", "description": "交易代币符号。" }, "tokenContractAddress": { "type": "string", "example": "0x6982508145454ce325ddbe47a25d4ec3d2311933", "description": "交易代币合约地址。EVM 全小写，Solana 原样保留。" }, "binanceChainId": { "type": "string", "example": "1", "description": "交易代币所在链的唯一标识。" }, "tokenPrice": { "type": "string", "example": "0.00153", "description": "交易触发时目标代币的成交单价，单位 USD。" }, "marketCap": { "type": "string", "example": "1534835.38", "description": "交易触发时目标代币的市值，单位 USD。" }, "tradeType": { "type": "string", "example": "1", "description": "交易类型。1=买入，2=卖出，3=加仓，4=减仓，5=建仓，6=清仓，7=转入，8=转出。" }, "tradeTime": { "type": "string", "example": "1777113793000", "description": "该笔追踪到的交易上链时间，Unix 毫秒时间戳。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/rwa/platforms": { "get": { "summary": "获取 RWA 代币发行平台列表", "description": "获取当前支持的 RWA 代币发行平台及基础信息。", "tags": ["RWA Data"], "operationId": "getRwaTokenIssuancePlatforms", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/rwa-data#get-rwa-token-issuance-platforms" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/RwaDataApi/getRwaTokenIssuancePlatforms.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/RwaData/get_rwa_token_issuance_platforms.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/rwadata/GetRwaTokenIssuancePlatformsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "schema": { "type": "string", "example": "your-api-key-here" }, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。" }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" }, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。" }, { "name": "X-OC-SIGN", "in": "header", "required": true, "schema": { "type": "string", "example": "Base64EncodedSignature==" }, "description": "请求签名（Base64 编码）。" }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "example": 5000 }, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。" }, { "name": "X-OC-NONCE", "in": "header", "required": false, "schema": { "type": "string", "example": "unique-nonce-string" }, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。" }, { "name": "platformId", "in": "query", "required": false, "schema": { "type": "string", "example": "ondo", "enum": ["ondo", "bstock"] }, "description": "平台唯一标识（ondo=Ondo Finance、bstock=bStocks）。不传返回全部平台；传入则仅返回该平台信息。" } ], "responses": { "200": { "description": "成功返回 RWA 代币发行平台列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success", "description": "状态说明。" }, "data": { "type": "array", "description": "RWA 代币发行平台列表。", "items": { "type": "object", "properties": { "platformId": { "type": "string", "example": "ondo", "description": "平台唯一标识。示例：ondo=Ondo Finance、bstock=bStocks。" }, "tickerCount": { "type": "integer", "format": "int32", "example": 264, "description": "RWA 代币对应底层标的数量。" }, "chainDistribution": { "type": "array", "description": "RWA 代币在各链上的分布。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "tokenCount": { "type": "integer", "format": "int32", "example": 264, "description": "该链上的 RWA 代币数量（同一标的在不同链上的部署分别计数）。" } } } }, "website": { "type": "string", "nullable": true, "example": "https://ondo.finance", "description": "平台官网链接，无数据时返回 null。" }, "logoUrl": { "type": "string", "nullable": true, "example": "https://static.onchainos.com/images/protocols/ondo.png", "description": "平台 Logo 链接，无数据时返回 null。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务器响应时间，Unix 毫秒时间戳。" }, "success": { "type": "boolean", "example": true, "description": "请求是否成功。" } } }, "examples": { "allPlatforms": { "summary": "全部平台", "value": { "code": 0, "msg": "success", "data": [ { "platformId": "ondo", "tickerCount": 264, "chainDistribution": [ { "binanceChainId": "56", "tokenCount": 264 } ], "website": "https://ondo.finance", "logoUrl": "https://static.onchainos.com/images/protocols/ondo.png" } ], "timestamp": 1748601600000, "success": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/rwa/price": { "get": { "summary": "获取 RWA 代币价格", "description": "批量查询 RWA 代币价格，含链上价格与标的参考价格。", "tags": ["RWA Data"], "operationId": "getRwaTokenPrice", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/rwa-data#get-rwa-token-price" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/RwaDataApi/getRwaTokenPrice.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/RwaData/get_rwa_token_price.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/rwadata/GetRwaTokenPriceExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "schema": { "type": "string", "example": "your-api-key-here" }, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。" }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" }, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。" }, { "name": "X-OC-SIGN", "in": "header", "required": true, "schema": { "type": "string", "example": "Base64EncodedSignature==" }, "description": "请求签名（Base64 编码）。" }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "example": 5000 }, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。" }, { "name": "X-OC-NONCE", "in": "header", "required": false, "schema": { "type": "string", "example": "unique-nonce-string" }, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。" }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "tokenContractAddresses", "in": "query", "required": true, "schema": { "type": "string", "example": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe" }, "description": "逗号分隔的代币合约地址列表，单次最多 100 个。" } ], "responses": { "200": { "description": "成功返回币价数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success", "description": "状态说明。" }, "data": { "type": "array", "description": "代币价格数据列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "tokenContractAddress": { "type": "string", "example": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe", "description": "代币合约地址。" }, "platformId": { "type": "string", "example": "ondo", "description": "平台唯一标识。" }, "tokenPrice": { "type": "string", "example": "61.746364", "description": "链上代币价格，美元计价。" }, "referencePrice": { "type": "string", "example": "61.746364", "description": "标的参考价格，美元计价。参考价格是代币价格通过换算得出的“每股折算价”，不是传统股票市场的官方报价。" }, "tokenPriceUpdatedAt": { "type": "integer", "format": "int64", "example": 1748000000000, "description": "链上代币价格更新时间，Unix 毫秒时间戳。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务器响应时间，Unix 毫秒时间戳。" }, "success": { "type": "boolean", "example": true, "description": "请求是否成功。" } } }, "examples": { "tokenQuote": { "summary": "代币报价", "value": { "code": 0, "msg": "success", "data": [ { "binanceChainId": "56", "tokenContractAddress": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe", "platformId": "ondo", "tokenPrice": "61.89", "referencePrice": "61.746364", "tokenPriceUpdatedAt": 1748000000000 } ], "timestamp": 1748601600000, "success": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/rwa/search": { "get": { "summary": "RWA 代币搜索", "description": "通过关键词或合约地址搜索 RWA 代币。", "tags": ["RWA Data"], "operationId": "searchRwaToken", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/rwa-data#search-rwa-token" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/RwaDataApi/searchRwaToken.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/RwaData/search_rwa_token.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/rwadata/SearchRwaTokenExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "schema": { "type": "string", "example": "your-api-key-here" }, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。" }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" }, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。" }, { "name": "X-OC-SIGN", "in": "header", "required": true, "schema": { "type": "string", "example": "Base64EncodedSignature==" }, "description": "请求签名（Base64 编码）。" }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "example": 5000 }, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。" }, { "name": "X-OC-NONCE", "in": "header", "required": false, "schema": { "type": "string", "example": "unique-nonce-string" }, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。" }, { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "example": "NVDA" }, "description": "搜索关键词（ticker、公司名或合约地址），大小写不敏感。" }, { "name": "platformId", "in": "query", "required": false, "schema": { "type": "string", "example": "ondo", "enum": ["ondo", "bstock"] }, "description": "平台筛选（ondo=Ondo Finance、bstock=bStocks）。不传返回所有平台的结果。" } ], "responses": { "200": { "description": "成功返回 Ticker 反查结果。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success", "description": "状态说明。" }, "data": { "type": "array", "description": "匹配到的标的及其代币化资产列表。", "items": { "type": "object", "properties": { "ticker": { "type": "string", "example": "NVDA", "description": "标的资产代码。" }, "companyName": { "type": "string", "example": "NVIDIA Corporation", "description": "公司英文名称。" }, "assets": { "type": "array", "description": "该标的在各平台/链上的代币化资产列表。", "items": { "type": "object", "properties": { "platformId": { "type": "string", "example": "ondo", "description": "平台唯一标识。" }, "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "tokenContractAddress": { "type": "string", "example": "0xa9ee28c80f960b889dfbd1902055218cba016f75", "description": "代币合约地址。" }, "tokenSymbol": { "type": "string", "example": "NVDAon", "description": "代币符号。" }, "assetType": { "type": "integer", "format": "int32", "example": 1, "enum": [1, 2, 3], "description": "资产类型。1=Stock，2=Pre-IPO，3=ETF。" } } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务器响应时间，Unix 毫秒时间戳。" }, "success": { "type": "boolean", "example": true, "description": "请求是否成功。" } } }, "examples": { "multiPlatform": { "summary": "多平台结果", "value": { "code": 0, "msg": "success", "data": [ { "ticker": "NVDA", "companyName": "NVIDIA Corporation", "assets": [ { "platformId": "ondo", "binanceChainId": "56", "tokenContractAddress": "0xa9ee28c80f960b889dfbd1902055218cba016f75", "tokenSymbol": "NVDAon", "assetType": 1 } ] } ], "timestamp": 1748601600000, "success": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/rwa/underlying-profile": { "get": { "summary": "获取 RWA 标的信息", "description": "获取 RWA 代币对应的标的公司信息。", "tags": ["RWA Data"], "operationId": "getRwaUnderlyingInfo", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/rwa-data#get-rwa-underlying-info" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/RwaDataApi/getRwaUnderlyingInfo.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/RwaData/get_rwa_underlying_info.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/rwadata/GetRwaUnderlyingInfoExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "schema": { "type": "string", "example": "your-api-key-here" }, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。" }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" }, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。" }, { "name": "X-OC-SIGN", "in": "header", "required": true, "schema": { "type": "string", "example": "Base64EncodedSignature==" }, "description": "请求签名（Base64 编码）。" }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "example": 5000 }, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。" }, { "name": "X-OC-NONCE", "in": "header", "required": false, "schema": { "type": "string", "example": "unique-nonce-string" }, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。" }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe" }, "description": "代币合约地址。" } ], "responses": { "200": { "description": "成功返回标的公司信息。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success", "description": "状态说明。" }, "data": { "type": "object", "description": "标的公司信息及投资者保护机制。", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "tokenContractAddress": { "type": "string", "example": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe", "description": "代币合约地址。" }, "platformId": { "type": "string", "example": "ondo", "description": "平台唯一标识。" }, "underlyingTicker": { "type": "string", "example": "SEDG", "description": "标的资产代码。" }, "underlyingFullName": { "type": "string", "example": "SolarEdge Technologies, Inc.", "description": "标的资产全称。" }, "assetType": { "type": "integer", "format": "int32", "example": 1, "enum": [1, 2, 3], "description": "资产类型。1=Stock，2=Pre-IPO，3=ETF。" }, "tokenToShareRatio": { "type": "string", "example": "1.003701", "description": "代币与标的股份的兑换比例。例如 \"1.003701\" 表示 1 代币 ≈ 1.003701 股标的股票。" }, "protections": { "type": "object", "description": "投资者保护机制。当前支持每日鉴证报告（dailyAttestationReport）、月度鉴证报告（monthlyAttestationReport）、抵押品证明报告（collateralReport），各平台可能扩展更多机制。", "additionalProperties": { "type": "object", "properties": { "supported": { "type": "boolean", "description": "是否支持该保护机制。" }, "url": { "type": "string", "nullable": true, "description": "相关证明/报告链接。" } } } }, "companyInfo": { "type": "object", "nullable": true, "description": "标的公司信息；ETF 类型返回基金公司信息（如 Invesco、iShares）。", "properties": { "ceo": { "type": "string", "nullable": true, "example": null, "description": "CEO 姓名。" }, "website": { "type": "string", "nullable": true, "example": "https://www.solaredge.com", "description": "公司官网链接。" }, "industry": { "type": "string", "nullable": true, "example": "Technology", "description": "所属行业（英文）。" }, "conceptsEn": { "type": "array", "nullable": true, "description": "概念板块标签（英文）。", "items": { "type": "string" }, "example": [] }, "conceptsCn": { "type": "array", "nullable": true, "description": "概念板块标签（中文）。", "items": { "type": "string" }, "example": [] }, "descriptionEn": { "type": "string", "nullable": true, "example": "SolarEdge Technologies, Inc. is an energy technology company...", "description": "公司英文简介。" }, "descriptionZh": { "type": "string", "nullable": true, "example": "SolarEdge是一家能源科技企业...", "description": "公司中文简介。" } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务器响应时间，Unix 毫秒时间戳。" }, "success": { "type": "boolean", "example": true, "description": "请求是否成功。" } } }, "examples": { "ondoStock": { "summary": "Ondo 股票代币", "value": { "code": 0, "msg": "success", "data": { "binanceChainId": "56", "tokenContractAddress": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe", "platformId": "ondo", "underlyingTicker": "SEDG", "underlyingFullName": "SolarEdge Technologies, Inc.", "assetType": 1, "tokenToShareRatio": "1.003701", "protections": { "dailyAttestationReport": { "supported": true, "url": "https://static.onchainos.com/images/web3-data/public/token/ondo/pdf/daily-2026-06-08.pdf" }, "monthlyAttestationReport": { "supported": true, "url": "https://static.onchainos.com/images/web3-data/public/token/ondo/pdf/monthly-2026-05.pdf" } }, "companyInfo": { "ceo": null, "website": "https://www.solaredge.com", "industry": "Technology", "conceptsEn": [], "conceptsCn": [], "descriptionEn": "SolarEdge Technologies, Inc. is an energy technology company...", "descriptionZh": "SolarEdge是一家能源科技企业..." } }, "timestamp": 1748601600000, "success": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/rwa/tokens": { "get": { "summary": "获取 RWA 代币列表", "description": "获取 RWA 代币列表及标的信息，支持按平台和板块筛选。", "tags": ["RWA Data"], "operationId": "getRwaTokenList", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/rwa-data#get-rwa-token-list" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/RwaDataApi/getRwaTokenList.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/RwaData/get_rwa_token_list.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/rwadata/GetRwaTokenListExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "schema": { "type": "string", "example": "your-api-key-here" }, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。" }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" }, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。" }, { "name": "X-OC-SIGN", "in": "header", "required": true, "schema": { "type": "string", "example": "Base64EncodedSignature==" }, "description": "请求签名（Base64 编码）。" }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "example": 5000 }, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。" }, { "name": "X-OC-NONCE", "in": "header", "required": false, "schema": { "type": "string", "example": "unique-nonce-string" }, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。" }, { "name": "binanceChainId", "in": "query", "required": false, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。不传返回所有链的数据。" }, { "name": "platformId", "in": "query", "required": false, "schema": { "type": "string", "example": "ondo", "enum": ["ondo", "bstock"] }, "description": "平台筛选（ondo=Ondo Finance、bstock=bStocks）。不传返回所有平台。" }, { "name": "tabId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 9 }, "description": "板块筛选（枚举码）。不传返回所有板块。 枚举：1=Serenity Call，2=SpaceX 概念（SpaceX 关联及商业航天概念股）， 3=未来重点财报，4=AI 芯片，5=存储概念，6=能源，7=贵金属， 8=中概股（在美上市的中国公司），9=七姐妹（美股七大科技巨头： Apple、Microsoft、Alphabet、Amazon、Nvidia、Meta、Tesla）， 10=加密概念，11=ETF 基金，12=科技龙头，13=巴菲特持仓。" } ], "responses": { "200": { "description": "成功返回 RWA 代币列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success", "description": "状态说明。" }, "data": { "type": "array", "description": "RWA 代币列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "tokenContractAddress": { "type": "string", "example": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe", "description": "代币合约地址。" }, "platformId": { "type": "string", "example": "ondo", "description": "平台唯一标识。" }, "assetType": { "type": "integer", "format": "int32", "example": 1, "enum": [1, 2, 3], "description": "资产类型。1=Stock，2=Pre-IPO，3=ETF。" }, "tokenName": { "type": "string", "example": "SolarEdge Technologies (Ondo Tokenized)", "description": "代币全称。" }, "tokenSymbol": { "type": "string", "example": "SEDGon", "description": "代币符号。" }, "tokenLogoUrl": { "type": "string", "example": "https://static.onchainos.com/images/web3-data/public/token/logos/7ac70d12b753405fb9ec408f1d1ab81e.png", "description": "代币 Logo 链接。" }, "decimals": { "type": "string", "example": "18", "description": "代币精度。" }, "underlyingTicker": { "type": "string", "example": "SEDG", "description": "标的资产代码。" }, "underlyingName": { "type": "string", "example": "NVIDIA Corporation", "description": "标的上市公司英文名称。" }, "underlyingNameZh": { "type": "string", "nullable": true, "example": "英伟达", "description": "标的上市公司中文名称；无中文时返回英文。" }, "tokenToShareRatio": { "type": "string", "example": "1", "description": "代币与标的股份的兑换比例。例如 \"1.003701\" 表示 1 代币 ≈ 1.003701 股标的股票。" }, "tags": { "type": "array", "nullable": true, "description": "代币标签数组。枚举：alpha、communityRecognized、volumeSurge、volumePlunge。", "items": { "type": "string", "enum": [ "alpha", "communityRecognized", "volumeSurge", "volumePlunge" ] }, "example": ["alpha"] }, "statusInfo": { "type": "object", "description": "市场状态信息。", "properties": { "openState": { "type": "boolean", "example": false, "description": "标的市场当前是否可交易。" }, "marketStatus": { "type": "string", "example": "closed", "enum": [ "premarket", "regular", "postmarket", "overnight", "closed", "pause" ], "description": "当前市场状态：premarket（盘前）/ regular（正常交易）/ postmarket（盘后）/ overnight（夜盘）/ closed（休市）/ pause（熔断或临时停牌）。" }, "reasonCode": { "type": "string", "nullable": true, "example": "MARKET_CLOSED", "enum": [ "TRADING", "MARKET_CLOSED", "MARKET_PAUSED", "MARKET_MAINTENANCE", "ASSET_PAUSED", "ASSET_LIMITED", "UNSUPPORTED" ], "description": "不可交易原因码（openState=false 时返回）。 市场级：MARKET_CLOSED（休市）、MARKET_PAUSED（市场全场暂停）、 MARKET_MAINTENANCE（系统维护）。资产级：ASSET_PAUSED（个股暂停，含公司行动， 详见 reasonMsg）、ASSET_LIMITED（个股受限但未暂停，如财报期）。 其他：TRADING（正常）、UNSUPPORTED（不支持）。" }, "reasonMsg": { "type": "string", "nullable": true, "example": "Weekend or Holiday", "description": "不可交易的具体原因。常规场景如 \"Weekend or Holiday\"。 ASSET_PAUSED（公司行动）时取值：cash_dividend / stock_dividend / stock_split / merger / acquisition / spinoff / maintenance / corporate action；ASSET_LIMITED 时为 earnings。" }, "nextOpenTime": { "type": "integer", "format": "int64", "nullable": true, "example": 1779111060000, "description": "下次预计开市时间，Unix 毫秒时间戳。" }, "nextCloseTime": { "type": "integer", "format": "int64", "nullable": true, "example": null, "description": "下次预计收市时间，Unix 毫秒时间戳。" } } }, "tokenPrice": { "type": "string", "example": "61.746364", "description": "链上代币价格，美元计价。" }, "referencePrice": { "type": "string", "example": "61.746364", "description": "标的参考价格，美元计价。参考价格是代币价格通过换算得出的“每股折算价”，不是传统股票市场的官方报价。" }, "volume24H": { "type": "string", "example": "894138582.57", "description": "24h 成交额，美元计价。" }, "marketCap": { "type": "string", "example": "3055506468", "description": "标的总市值，美元计价。" }, "peRatioTTM": { "type": "string", "nullable": true, "example": null, "description": "市盈率 TTM。无数据返回 null。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务器响应时间，Unix 毫秒时间戳。" }, "success": { "type": "boolean", "example": true, "description": "请求是否成功。" } } }, "examples": { "tokenList": { "summary": "代币列表", "value": { "code": 0, "msg": "success", "data": [ { "binanceChainId": "56", "tokenContractAddress": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe", "platformId": "ondo", "assetType": 1, "tokenName": "SolarEdge Technologies (Ondo Tokenized)", "tokenSymbol": "SEDGon", "tokenLogoUrl": "https://static.onchainos.com/images/web3-data/public/token/logos/7ac70d12b753405fb9ec408f1d1ab81e.png", "decimals": 18, "underlyingTicker": "SEDG", "underlyingName": "SolarEdge Technologies", "underlyingNameZh": "SolarEdge", "tokenToShareRatio": "1.003701", "tags": ["alpha"], "statusInfo": { "openState": false, "marketStatus": "closed", "reasonCode": "MARKET_CLOSED", "reasonMsg": "Weekend or Holiday", "nextOpenTime": 1779111060000, "nextCloseTime": null }, "tokenPrice": "61.89", "referencePrice": "61.746364", "volume24H": "894138582.57", "marketCap": "3055506468", "peRatioTTM": "28.5" } ], "timestamp": 1748601600000, "success": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/market/rwa/underlying-market": { "get": { "summary": "获取 RWA 标的行情", "description": "获取单个 RWA 代币对应的标的资产市场数据。", "tags": ["RWA Data"], "operationId": "getRwaUnderlyingMarketData", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/rwa-data#get-rwa-underlying-market-data" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/RwaDataApi/getRwaUnderlyingMarketData.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/RwaData/get_rwa_underlying_market_data.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/rwadata/GetRwaUnderlyingMarketDataExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "schema": { "type": "string", "example": "your-api-key-here" }, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。" }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" }, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。" }, { "name": "X-OC-SIGN", "in": "header", "required": true, "schema": { "type": "string", "example": "Base64EncodedSignature==" }, "description": "请求签名（Base64 编码）。" }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "schema": { "type": "integer", "format": "int64", "example": 5000 }, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。" }, { "name": "X-OC-NONCE", "in": "header", "required": false, "schema": { "type": "string", "example": "unique-nonce-string" }, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。" }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe" }, "description": "代币合约地址。" } ], "responses": { "200": { "description": "成功返回标的行情数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success", "description": "状态说明。" }, "data": { "type": "object", "description": "RWA 代币对应的标的行情数据。", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识（例如 \"1\"=Ethereum, \"56\"=BSC, \"CT_501\"=Solana）。" }, "tokenContractAddress": { "type": "string", "example": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe", "description": "代币合约地址。" }, "platformId": { "type": "string", "example": "ondo", "description": "平台唯一标识。" }, "assetType": { "type": "integer", "format": "int32", "example": 1, "enum": [1, 2, 3], "description": "资产类型。1=Stock，2=Pre-IPO，3=ETF。" }, "statusInfo": { "type": "object", "description": "市场状态信息。", "properties": { "openState": { "type": "boolean", "example": true, "description": "标的市场当前是否可交易。" }, "marketStatus": { "type": "string", "example": "regular", "enum": [ "premarket", "regular", "postmarket", "overnight", "closed", "pause" ], "description": "当前市场状态：premarket（盘前）/ regular（正常交易）/ postmarket（盘后）/ overnight（夜盘）/ closed（休市）/ pause（熔断或临时停牌）。" }, "reasonCode": { "type": "string", "nullable": true, "example": null, "enum": [ "TRADING", "MARKET_CLOSED", "MARKET_PAUSED", "MARKET_MAINTENANCE", "ASSET_PAUSED", "ASSET_LIMITED", "UNSUPPORTED" ], "description": "不可交易原因码（openState=false 时返回）。 市场级：MARKET_CLOSED（休市）、MARKET_PAUSED（市场全场暂停）、 MARKET_MAINTENANCE（系统维护）。资产级：ASSET_PAUSED（个股暂停，含公司行动， 详见 reasonMsg）、ASSET_LIMITED（个股受限但未暂停，如财报期）。 其他：TRADING（正常）、UNSUPPORTED（不支持）。" }, "reasonMsg": { "type": "string", "nullable": true, "example": null, "description": "不可交易的具体原因。常规场景如 \"Weekend or Holiday\"。 ASSET_PAUSED（公司行动）时取值：cash_dividend / stock_dividend / stock_split / merger / acquisition / spinoff / maintenance / corporate action；ASSET_LIMITED 时为 earnings。" }, "nextOpenTime": { "type": "integer", "format": "int64", "nullable": true, "example": null, "description": "下次预计开市时间，Unix 毫秒时间戳。" }, "nextCloseTime": { "type": "integer", "format": "int64", "nullable": true, "example": 1779134340000, "description": "下次预计收市时间，Unix 毫秒时间戳。" } } }, "marketData": { "type": "object", "description": "标的行情数据，返回字段随资产类型不同。", "properties": { "referencePrice": { "type": "string", "example": "61.746364", "description": "标的参考价格，美元计价。参考价格是代币价格通过换算得出的“每股折算价”，不是传统股票市场的官方报价。" }, "high52W": { "type": "string", "example": "63.53", "description": "52 周最高价。仅 Stock 和 ETF 返回。" }, "low52W": { "type": "string", "example": "13.73", "description": "52 周最低价。仅 Stock 和 ETF 返回。" }, "volumeShares24H": { "type": "string", "example": "14480829", "description": "标的 24h 成交量，以股数/份额计。" }, "avgDailyVolume1Y": { "type": "string", "example": "4243226", "description": "1 年日均成交量。仅 Stock 和 ETF 返回。" }, "totalShares": { "type": "string", "example": "60818202", "description": "总流通股数（Stock）或总流通份额（ETF）。仅 Stock 和 ETF 返回。" }, "marketCap": { "type": "string", "example": "3055506468", "description": "总市值，美元计价。Stock/ETF 为实际市值，Pre-IPO 为隐含总估值。" }, "turnoverRate": { "type": "string", "example": "23.81", "description": "换手率，例如 \"23.81\" 表示 23.81%。仅 Stock 和 ETF 返回。" }, "amplitude": { "type": "string", "nullable": true, "example": "3.05", "description": "振幅（日内），例如 \"3.05\" 表示 3.05%，即（当日最高价 − 最低价）/ 昨收价。仅 Stock 和 ETF 返回。" }, "peRatioTTM": { "type": "string", "nullable": true, "example": "28.5", "description": "滚动市盈率（TTM = Trailing Twelve Months，基于最近 12 个月盈利计算）。仅 Stock 返回。" }, "pbRatio": { "type": "string", "nullable": true, "example": "7.15", "description": "市净率。仅 Stock 返回。" }, "dividendYield": { "type": "string", "nullable": true, "example": "0.85", "description": "股息收益率，例如 \"0.85\" 表示 0.85%。仅 Stock 和 ETF 返回。" }, "latestDividend": { "type": "string", "nullable": true, "example": "0.25", "description": "最近一次分红金额，美元计价。仅 Stock 和 ETF 返回。" } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务器响应时间，Unix 毫秒时间戳。" }, "success": { "type": "boolean", "example": true, "description": "请求是否成功。" } } }, "examples": { "stock": { "summary": "股票类（assetType=1）", "value": { "code": 0, "msg": "success", "data": { "binanceChainId": "56", "tokenContractAddress": "0x8755c5c39b1aa9053a83ac731242a2cf4d04b0fe", "platformId": "ondo", "assetType": 1, "statusInfo": { "openState": true, "marketStatus": "regular", "reasonCode": null, "reasonMsg": null, "nextOpenTime": null, "nextCloseTime": 1779134340000 }, "marketData": { "referencePrice": "61.746364", "high52W": "63.53", "low52W": "13.73", "volumeShares24H": "14480829", "avgDailyVolume1Y": "4243226", "totalShares": "60818202", "marketCap": "3055506468", "turnoverRate": "23.81", "amplitude": "3.05", "peRatioTTM": "28.5", "pbRatio": "7.15", "dividendYield": "0.85", "latestDividend": "0.25" } }, "timestamp": 1748601600000, "success": true } }, "etf": { "summary": "ETF 类（assetType=3）", "value": { "code": 0, "msg": "success", "data": { "binanceChainId": "56", "tokenContractAddress": "0x08ce97f3d5cf11e577d091ab048bc5e2eae3fabb", "platformId": "ondo", "assetType": 3, "statusInfo": { "openState": true, "marketStatus": "regular", "reasonCode": null, "reasonMsg": null, "nextOpenTime": null, "nextCloseTime": 1779134340000 }, "marketData": { "referencePrice": "498.32", "high52W": "510.00", "low52W": "380.15", "volumeShares24H": "52000000", "avgDailyVolume1Y": "38000000", "totalShares": "500000000", "marketCap": "249160000000", "turnoverRate": "10.4", "amplitude": "1.2", "dividendYield": "0.55", "latestDividend": "0.68" } }, "timestamp": 1748601600000, "success": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/supported/chain": { "get": { "summary": "获取聚合器支持的链", "description": "返回 DEX 聚合服务当前支持的所有区块链信息。支持链列表由服务端动态配置，可能随时变更。\n传入 `binanceChainId` 仅返回该链信息；不传则返回全量列表。", "tags": ["Trading API"], "operationId": "getAggregatorSupportedChains", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#get-aggregator-supported-chains" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/getAggregatorSupportedChains.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/get_aggregator_supported_chains.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/GetAggregatorSupportedChainsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": false, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识（可选）。指定时仅返回对应链信息；不传则返回全量列表。" } ], "responses": { "200": { "description": "成功返回支持的链列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功，非 0 表示业务错误。" }, "msg": { "type": "string", "example": "success", "description": "状态描述信息。" }, "data": { "type": "array", "description": "支持的区块链网络列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识（EVM 链遵循 EIP-155 chainId）。" }, "name": { "type": "string", "example": "BNB Smart Chain", "description": "链全称。" }, "shortName": { "type": "string", "example": "BSC", "description": "链简称。" }, "logoUrl": { "type": "string", "example": "https://static.onchainos.com/chains/bsc.png", "description": "链 Logo 图片 URL。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务端响应时间戳（毫秒）。" }, "success": { "type": "boolean", "example": true, "description": "由 `code == 0` 派生的便捷布尔值。" } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/approve-transaction": { "get": { "summary": "获取 ERC-20 代币授权交易数据", "description": "在执行 DEX 兑换前，生成授权 DEX Router 操作用户 ERC-20 代币的链上交易数据。 Calldata 按 ERC-20 ABI 标准编码（approve 函数选择器 + spender + 授权数量）。", "tags": ["Trading API"], "operationId": "getErc20ApproveTransaction", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#get-erc20-approve-transaction" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/getErc20ApproveTransaction.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/get_erc20_approve_transaction.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/GetErc20ApproveTransactionExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（如 \"1\"=Ethereum，\"56\"=BSC）。" }, { "name": "tokenContractAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7" }, "description": "待授权的 ERC-20 代币合约地址（0x + 40 位 hex）。" }, { "name": "approveAmount", "in": "query", "required": true, "schema": { "type": "string", "example": "1000000" }, "description": "授权数量，含精度的正整数字符串。如授权 1 USDT（精度 6）传 \"1000000\"。" }, { "name": "vendor", "in": "query", "required": false, "schema": { "type": "string", "example": "PcsXRfq" }, "description": "RFQ vendor 名称。**权益 / RWA 代币（Ondo、BStock）时必填**，传入 `/quote` 响应中的 `vendorName` （如 `InchFusion`、`CowSwap`、`PcsXRfq`）。指定后，后端返回对应 vendor 合约地址（如 1inch Router、 PcsX Permit2、CowSwap VaultRelayer）的授权 calldata，而非默认 DEX Router。\n\n普通（非 RWA）代币可不传：省略时后端使用标准 DEX Router；若传入合法 RFQ vendor，后端会按该 vendor 解析 spender——用于「用稳定币买入 Ondo/BStock」场景，此时 fromToken（如 USDT）本身不是 RFQ 代币， 但需要 approve 给 RFQ vendor 的 router 才能继续走 RFQ swap 流程。" } ], "responses": { "200": { "description": "成功返回授权交易数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "兑换前需提交的授权交易列表。", "items": { "type": "object", "properties": { "data": { "type": "string", "example": "0x095ea7b3000000000000000000000000c67879f4065d3b9fe1c09ee990b891aa8e3a4c2f0000000000000000000000000000000000000000000000000000000000f4240", "description": "ABI 编码的 ERC-20 `approve()` calldata。函数选择器 + spender 地址 + 授权数量。" }, "dexContractAddress": { "type": "string", "example": "0xc67879F4065d3B9fe1C09EE990B891Aa8E3a4c2f", "description": "DEX 合约地址，即 `approve()` 中的 spender。按链动态配置。" }, "gasLimit": { "type": "string", "example": "50000", "description": "授权交易的 gas limit 上限（整数字符串，单位 gas）。" }, "gasPrice": { "type": "string", "example": "110000000", "description": "授权交易的 gas price（整数字符串，单位 wei）。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/quote": { "get": { "summary": "获取聚合交易报价", "description": "向多个 vendor 并发询价，返回按 `toTokenAmount` 降序排列的路由列表。 每条路由携带独立的 `quoteId`（TTL 约 30 秒），swap 接口通过它定位要构造 calldata 的路由。", "tags": ["Trading API"], "operationId": "getAggregatedQuote", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#get-aggregated-quote" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/getAggregatedQuote.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/get_aggregated_quote.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/GetAggregatedQuoteExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识（如 \"56\"=BSC，\"1\"=Ethereum，\"CT_501\"=Solana）。" }, { "name": "amount", "in": "query", "required": true, "schema": { "type": "string", "example": "1000000" }, "description": "卖出币种数量，含精度的正整数字符串（不允许小数）。如兑换 1 USDT（精度 6）传 \"1000000\"。" }, { "name": "fromTokenAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955" }, "description": "卖出币种合约地址。EVM 链格式 `0x + 40 位 hex`；非 EVM 链使用对应链的地址格式。" }, { "name": "toTokenAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }, "description": "买入币种合约地址，必须与 `fromTokenAddress` 不同。" }, { "name": "vendor", "in": "query", "required": false, "schema": { "type": "string", "example": "LiquidMesh", "enum": ["LiquidMesh", "Pancake", "Jupiter"] }, "description": "可选的询价 vendor。传入后仅向指定 vendor 询价，走单 vendor 快速路径，不经过多 vendor 双窗口、早返和价格检查逻辑。大小写敏感，仅支持 `LiquidMesh`、`Pancake`、`Jupiter`； 同时要求该 vendor 支持请求的链。传入不支持的值，或该 vendor 不支持当前链时，返回 `PARAM_ERROR`（40001）。省略时，接口并发查询所有适用 vendor，并返回聚合路由。" }, { "name": "userWalletAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "description": "用户钱包地址。询价 RFQ 路由（Ondo、BStock 等权益 / RWA 代币）时必填。 该地址将作为 RFQ 订单的接收方，须与后续 `/swap` 中签名 `rfq.typedDataToSign` 的钱包一致。" }, { "name": "feePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "1.5" }, "description": "自定义手续费（分佣 / Add Fee）百分比，十进制字符串。必须与 `feeSource` 搭配使用—— 二者要么同时传入，要么同时省略。\n\n**范围按链区分：**EVM 链（BSC、Ethereum、Base 等）`(0, 5]`，Solana（`CT_501`）`(0, 10]` （大于 0、到链上限含边界），最多 2 位小数。`\"1.5\"` 表示 1.5%，超过 2 位小数返回 `INVALID_FEE_PERCENT`（40466）。\n\n**`four.meme` 代币不支持**——当交易对任意一侧为 `four.meme` 代币时，请勿传入 fee 相关参数。" }, { "name": "feeSource", "in": "query", "required": false, "schema": { "type": "string", "example": "FROM_TOKEN", "enum": ["FROM_TOKEN", "TO_TOKEN"] }, "description": "手续费扣减方向。`FROM_TOKEN` = 从卖出币种扣 fee（传给 DEX 的金额会扣减为净额）； `TO_TOKEN` = 从买入币种输出扣 fee（用户实际到手金额会扣减）。必须与 `feePercent` 搭配使用。" } ], "responses": { "200": { "description": "成功返回询价路由。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "每个返回有效报价的 vendor 对应一条路由，按 `toTokenAmount` 降序排列。", "items": { "type": "object", "properties": { "quoteId": { "type": "string", "example": "a1b2c3d4e5f64a8b9c0d1e2f3a4b5c6d", "description": "单条路由的询价 ID（UUID，无连字符）。在 swap 接口中传入以锁定该路由。" }, "vendorName": { "type": "string", "example": "Lifi", "description": "询价来源 vendor 展示名，可能值：LiquidMesh、Lifi、1inch、Pancake、Jupiter。" }, "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识，回显请求值。" }, "fromTokenAmount": { "type": "string", "example": "1000000", "description": "卖出币种数量（最小单位整数字符串）。" }, "toTokenAmount": { "type": "string", "example": "998500000000000000", "description": "估算的买入币种数量（最小单位整数字符串）。" }, "tradeFee": { "type": "string", "nullable": true, "example": "0.12", "description": "该路由预估的网络费用（USD 计价）。vendor 未返回时为 null。" }, "estimateGasFee": { "type": "string", "nullable": true, "example": "150000", "description": "预估消耗的 Gas（链最小单位，如 wei）。Solana 链可能为 null。" }, "priceImpactPercent": { "type": "string", "nullable": true, "example": "-0.01", "description": "价格影响百分比。vendor 未返回时为 null。" }, "router": { "type": "string", "example": "0x55d3...--0xbb4C...--0x8AC7...", "description": "兑换路径描述，地址间用 \"--\" 连接。" }, "fromToken": { "type": "object", "description": "卖出币种信息。", "properties": { "tokenContractAddress": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955", "description": "代币合约地址。" }, "tokenSymbol": { "type": "string", "example": "USDT", "description": "代币简称（ticker）。" }, "tokenUnitPrice": { "type": "string", "example": "1.0002", "description": "代币美元单价（十进制字符串）。" }, "decimal": { "type": "string", "example": "18", "description": "代币精度（小数位数）。" }, "isHoneyPot": { "type": "boolean", "example": false, "description": "是否为貔貅币（只能买不能卖的蜜罐合约）。" }, "taxRate": { "type": "string", "example": "0", "description": "代币税率，取值范围 0–1，\"0.01\" 表示 1%。" } } }, "toToken": { "type": "object", "description": "买入币种信息，结构同 `fromToken`。", "properties": { "tokenContractAddress": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d", "description": "代币合约地址。" }, "tokenSymbol": { "type": "string", "example": "BTCB", "description": "代币简称（ticker）。" }, "tokenUnitPrice": { "type": "string", "example": "67000.5", "description": "代币美元单价。" }, "decimal": { "type": "string", "example": "18", "description": "代币精度。" }, "isHoneyPot": { "type": "boolean", "example": false, "description": "是否为貔貅币。" }, "taxRate": { "type": "string", "example": "0", "description": "代币税率。" } } }, "dexRouterList": { "type": "array", "description": "询价路径数据集合。每跳 × 每 DEX 展平为一条记录。", "items": { "type": "object", "properties": { "dexProtocol": { "type": "object", "description": "该路径段使用的 DEX 协议信息。", "properties": { "dexName": { "type": "string", "example": "Uniswap V3", "description": "DEX 协议名称。" }, "percent": { "type": "string", "example": "85.99", "description": "该 DEX 在整条路径中的流量百分比（2 位小数）。" } } }, "fromToken": { "type": "object", "description": "该路径段的卖出币种信息，结构同顶层 `fromToken`。", "properties": { "tokenContractAddress": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955" }, "tokenSymbol": { "type": "string", "example": "USDT" } } }, "fromTokenIndex": { "type": "string", "example": "0", "description": "卖出币种全局去重后的索引（字符串形式）。" }, "toToken": { "type": "object", "description": "该路径段的买入币种信息。", "properties": { "tokenContractAddress": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }, "tokenSymbol": { "type": "string", "example": "BTCB" } } }, "toTokenIndex": { "type": "string", "example": "1", "description": "买入币种全局去重后的索引。" } } } }, "executionMode": { "type": "string", "example": "SWAP", "enum": ["SWAP", "RFQ"], "description": "该路由的执行模式。`SWAP` = 标准链上兑换（签名 `/swap` 返回的 `tx` 对象后广播）。 `RFQ` = 签名订单流程（对 `/swap` 返回的 `rfq.typedDataToSign` 做 EIP-712 签名， 通过 `POST /order/submit` 提交，轮询 `GET /order/{orderId}`）。 权益 / RWA 代币始终返回 `RFQ`。" }, "approveTarget": { "type": "string", "nullable": true, "example": "0xc67879F4065d3B9fe1C09EE990B891Aa8E3a4c2f", "description": "后端将为该路由编码进授权 calldata 的 spender 合约地址。 如需获取授权 calldata，请调用 `/approve-transaction` 并传入 `vendor=`（vendor 名字字符串，如 `\"PcsXRfq\"`）——后端会根据 vendor 名字 在内部解析出 spender 地址。本字段仅供参考（例如不经 `/approve-transaction` 直接调用 ERC-20 `approve()` 时使用）。无需授权时为 null（如原生代币兑换或已授权）。" }, "isBest": { "type": "boolean", "example": true, "description": "该路由是否为本次响应所有路由中 `toTokenAmount` 最高的最优路由。 每次响应至多一条路由的 `isBest` 为 `true`。" }, "feeAmount": { "type": "string", "nullable": true, "example": "15000", "description": "本次兑换扣除的手续费金额（含精度整数字符串）。仅在请求开启自定义手续费 （`feePercent` + `feeSource` 同时传入）时返回，否则为 `null`。 `FROM_TOKEN` 方向 = 原始卖出额 × feePercent/100（HALF_UP）； `TO_TOKEN` 方向 = DEX 原始买入额 × feePercent/100（HALF_DOWN）。" }, "feeToken": { "type": "string", "nullable": true, "example": "0x55d398326f99059fF775485246999027B3197955", "description": "手续费计价币种合约地址。`FROM_TOKEN` 方向为卖出币种地址，`TO_TOKEN` 方向为买入币种 地址。未开启自定义手续费时为 `null`。" }, "actualSwapAmount": { "type": "string", "nullable": true, "example": "985000", "description": "实际参与 DEX 兑换的金额（含精度整数字符串）。`FROM_TOKEN` 方向为扣减手续费后的净额 （`fromTokenAmount − feeAmount`，即传给 DEX 的 amountIn）；`TO_TOKEN` 方向为原始输入额 （fee 从输出端扣，输入端全额参与兑换）。未开启自定义手续费时为 `null`。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/swap": { "get": { "summary": "执行代币兑换（构造链上交易数据）", "description": "基于先前的询价路由构造链上 swap 交易的 calldata。请求按 `quoteId` 命中 Redis 缓存（TTL 约 30 秒）；缓存过期返回 `QUOTE_EXPIRED`（40401）， 参数与缓存不一致返回 `SWAP_QUOTE_MISMATCH`（40462）。", "tags": ["Trading API"], "operationId": "buildSwapTransaction", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#build-swap-transaction" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/buildSwapTransaction.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/build_swap_transaction.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/BuildSwapTransactionExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识。" }, { "name": "amount", "in": "query", "required": true, "schema": { "type": "string", "example": "1000000" }, "description": "卖出币种数量（含精度的正整数字符串）。" }, { "name": "fromTokenAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955" }, "description": "卖出币种合约地址。" }, { "name": "toTokenAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }, "description": "买入币种合约地址。" }, { "name": "slippagePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "0.5" }, "description": "最大滑点容忍度（百分比字符串）。`autoSlippage=true` 时可不传，否则必填。\n\n**按链区分范围：**\n- EVM 链（BSC、Ethereum、Base 等）：`0` 到 `100`（含边界）\n- Solana（`CT_501`）：`0` 到小于 `100`（即 `< 100`）\n\n**按 vendor 区分范围：**\n- 1inch、PancakeSwap：`0` 到 `50`（超过 50 会报参数错误）\n- LiFi、LiquidMesh：`0` 到 `100`（EVM）或 `0` 到小于 `100`（Solana）\n- Jupiter（Solana）：`0` 到小于 `100`；传入值会换算为 basis points（`slippageBps = ceil(slippagePercent × 100)`）并作用于链上 swap\n\n`\"0.5\"` 表示最大滑点 0.5%。`autoSlippage=true` 时，此字段会被自动计算的滑点值覆盖。" }, { "name": "userWalletAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "description": "用户钱包地址。" }, { "name": "quoteId", "in": "query", "required": true, "schema": { "type": "string", "example": "a1b2c3d4e5f64a8b9c0d1e2f3a4b5c6d" }, "description": "`/quote` 返回的 quoteId，用于定位要执行的路由。TTL 约 30 秒，过期返回 `QUOTE_EXPIRED`（40401）。" }, { "name": "approveTransaction", "in": "query", "required": false, "schema": { "type": "string", "example": "false", "enum": ["true", "false"] }, "description": "为 \"true\" 时在 `signatureData` 内返回授权地址及授权 calldata，便于客户端在 swap 前提交授权。默认 false。" }, { "name": "approveAmount", "in": "query", "required": false, "schema": { "type": "string", "example": "1000000" }, "description": "授权数量（含精度的正整数字符串）。默认与本次交易数量相同。" }, { "name": "gasLimit", "in": "query", "required": false, "schema": { "type": "string", "example": "200000" }, "description": "Gas limit 上限（正整数字符串）。仅 EVM 链生效。" }, { "name": "gasLevel", "in": "query", "required": false, "schema": { "type": "string", "example": "average", "enum": ["slow", "average", "fast"] }, "description": "Gas 价格档位，默认 \"average\"。" }, { "name": "priceImpactProtectionPercent", "in": "query", "required": false, "schema": { "type": "string", "example": "90" }, "description": "允许的价格影响百分比（0–100）。默认 90，设为 100 时禁用此功能。" }, { "name": "autoSlippage", "in": "query", "required": false, "schema": { "type": "string", "example": "false", "enum": ["true", "false"] }, "description": "为 `\"true\"` 时，基于市场数据自动计算滑点并覆盖 `slippagePercent`。 `slippagePercent` 与 `autoSlippage=true` 二选一必填，两者均不传时返回参数错误。 默认 `\"false\"`。" }, { "name": "maxAutoSlippagePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "3" }, "description": "自动滑点上限，仅在 `autoSlippage=true` 时生效。" }, { "name": "computeUnitLimit", "in": "query", "required": false, "schema": { "type": "string", "example": "1400000" }, "description": "Solana 专用 — 限制本次交易最大可消耗的 Compute Units，类比 EVM 的 gasLimit。仅 `binanceChainId=CT_501` 时生效。" }, { "name": "computeUnitPrice", "in": "query", "required": false, "schema": { "type": "string", "example": "1000" }, "description": "Solana 专用 — 每个 Compute Unit 的优先费（micro-lamports），类比 EVM 的 gasPrice。未传入时由平台动态计算。仅 `binanceChainId=CT_501` 时生效。" }, { "name": "tips", "in": "query", "required": false, "schema": { "type": "string", "example": "0.001" }, "description": "Solana 专用 — Jito tips 小费（单位 SOL），用于 MEV 保护。有效范围 [0.000000001, 2]（最小 1 lamport）。指定后建议将 `computeUnitPrice` 设为 0。仅 `binanceChainId=CT_501` 时生效。" }, { "name": "feePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "1.5" }, "description": "自定义手续费（分佣 / Add Fee）百分比，十进制字符串。必须与 `fromTokenReferrerWalletAddress` 或 `toTokenReferrerWalletAddress` 中的一个搭配（两个 referrer 地址互斥，二选一）。\n\n**范围按链区分：**EVM 链（BSC、Ethereum、Base 等）`(0, 5]`，Solana（`CT_501`）`(0, 10]` （大于 0、到链上限含边界），最多 2 位小数。`\"1.5\"` 表示 1.5%，超过 2 位小数返回 `INVALID_FEE_PERCENT`（40466）。\n\n**`four.meme` 代币不支持**——当交易对任意一侧为 `four.meme` 代币时，请勿传入 fee 相关参数。" }, { "name": "fromTokenReferrerWalletAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "0xCbF2B6E6e3D7e9e4e4e4e4e4e4e4e4e4e4e4e4e4" }, "description": "从卖出币种扣减手续费的接收钱包地址（`FROM_TOKEN` 方向）。与 `toTokenReferrerWalletAddress` 互斥，同时传入返回 `CONFLICT_REFERRER_PARAMS`（40468）。地址格式按链区分：EVM 链为 `0x` + 40 位 hex，Solana（`CT_501`）为 Base58 公钥，格式非法返回 `INVALID_REFERRER_ADDRESS`（40467）。必须与 `feePercent` 搭配。" }, { "name": "toTokenReferrerWalletAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "0xCbF2B6E6e3D7e9e4e4e4e4e4e4e4e4e4e4e4e4e4" }, "description": "从买入币种输出扣减手续费的接收钱包地址（`TO_TOKEN` 方向）。与 `fromTokenReferrerWalletAddress` 互斥，同时传入返回 `CONFLICT_REFERRER_PARAMS`（40468）。地址格式按链区分：EVM 链为 `0x` + 40 位 hex，Solana（`CT_501`）为 Base58 公钥，格式非法返回 `INVALID_REFERRER_ADDRESS`（40467）。必须与 `feePercent` 搭配。Solana 链要求该地址已激活 （持有少量 SOL 余额），否则返回 `REFERRER_NOT_ACTIVATED`（40469）。" } ], "responses": { "200": { "description": "成功返回兑换交易数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "routerResult": { "type": "object", "description": "路由结果，包含本次 swap 使用的 vendor 及报价信息。", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识。" }, "vendorName": { "type": "string", "example": "Lifi", "description": "提供本次 swap 报价的 vendor。" }, "fromTokenAmount": { "type": "string", "example": "1000000", "description": "卖出币种数量（最小单位整数字符串）。" }, "toTokenAmount": { "type": "string", "example": "998500000000000000", "description": "估算的买入币种数量。" }, "tradeFee": { "type": "string", "nullable": true, "example": "0.12", "description": "询价路径预估消耗的网络费用（USD 计价）。" }, "estimateGasFee": { "type": "string", "nullable": true, "example": "150000", "description": "预估消耗的 Gas（链最小单位）。" }, "router": { "type": "string", "example": "0x55d3...--0xbb4C...--0x8AC7...", "description": "兑换路径描述。" }, "priceImpactPercent": { "type": "string", "example": "-0.01", "description": "价格影响百分比。计算公式：（接收价值 - 支付价值）/ 支付价值。" }, "dexRouterList": { "type": "array", "description": "询价路径数据集合，结构同 `/quote` 接口的 `dexRouterList`。", "items": { "type": "object", "properties": { "dexProtocol": { "type": "object", "properties": { "dexName": { "type": "string", "example": "Uniswap V3" }, "percent": { "type": "string", "example": "85.99" } } }, "fromToken": { "type": "object", "properties": { "tokenContractAddress": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955" }, "tokenSymbol": { "type": "string", "example": "USDT" } } }, "fromTokenIndex": { "type": "string", "example": "0" }, "toToken": { "type": "object", "properties": { "tokenContractAddress": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }, "tokenSymbol": { "type": "string", "example": "BTCB" } } }, "toTokenIndex": { "type": "string", "example": "1" } } } }, "fromToken": { "type": "object", "description": "卖出币种信息。", "properties": { "tokenContractAddress": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955" }, "tokenSymbol": { "type": "string", "example": "USDT" }, "tokenUnitPrice": { "type": "string", "example": "1.0002" }, "decimal": { "type": "string", "example": "18" }, "isHoneyPot": { "type": "boolean", "example": false }, "taxRate": { "type": "string", "example": "0" } } }, "toToken": { "type": "object", "description": "买入币种信息。", "properties": { "tokenContractAddress": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }, "tokenSymbol": { "type": "string", "example": "BTCB" }, "tokenUnitPrice": { "type": "string", "example": "67000.5" }, "decimal": { "type": "string", "example": "18" }, "isHoneyPot": { "type": "boolean", "example": false }, "taxRate": { "type": "string", "example": "0" } } }, "feeAmount": { "type": "string", "nullable": true, "example": "15000", "description": "本次兑换扣除的手续费金额（含精度整数字符串）。仅在请求开启自定义手续费时返回， 否则为 `null`。`FROM_TOKEN` 方向 = 原始卖出额 × feePercent/100（HALF_UP）； `TO_TOKEN` 方向 = DEX 原始买入额 × feePercent/100（HALF_DOWN）。" }, "feeToken": { "type": "string", "nullable": true, "example": "0x55d398326f99059fF775485246999027B3197955", "description": "手续费计价币种合约地址。`FROM_TOKEN` 方向为卖出币种地址，`TO_TOKEN` 方向为买入币种 地址。未开启自定义手续费时为 `null`。" }, "actualSwapAmount": { "type": "string", "nullable": true, "example": "985000", "description": "实际参与 DEX 兑换的金额（含精度整数字符串）。`FROM_TOKEN` 方向为扣减手续费后的净额 （`fromTokenAmount − feeAmount`）；`TO_TOKEN` 方向为原始输入额（fee 从输出端扣）。 未开启自定义手续费时为 `null`。" } } }, "tx": { "type": "object", "description": "待签名并提交的链上交易数据。", "properties": { "from": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "用户钱包地址（交易发起方）。" }, "to": { "type": "string", "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "DEX Router 合约地址（链上交易的 `to` 字段）。" }, "data": { "type": "string", "example": "0x12aa3caf...", "description": "交易 calldata（ABI 编码的合约调用数据）。" }, "value": { "type": "string", "example": "0", "description": "交易携带的原生代币数量（wei）。ERC-20 兑换时为 \"0\"。" }, "gas": { "type": "string", "example": "200000", "description": "Gas Limit 估算值。" }, "gasPrice": { "type": "string", "example": "5000000000", "description": "Gas Price（wei）。" }, "maxPriorityFeePerGas": { "type": "string", "example": "1000000000", "description": "EIP-1559 优先费（wei）。" }, "minReceiveAmount": { "type": "string", "example": "993507500000000000", "description": "目标币种最小收到数量（达到滑点限制时的最小到账数量）。" }, "slippagePercent": { "type": "string", "example": "0.5", "description": "当前交易使用的滑点值（百分比字符串）。" }, "signatureData": { "type": "array", "description": "额外签名数据。开启 `approveTransaction` 时，内含授权地址及授权 calldata。", "items": { "type": "string", "example": "0xc67879F4065d3B9fe1C09EE990B891Aa8E3a4c2f" } }, "computeUnitPrice": { "type": "string", "nullable": true, "example": "1000", "description": "Solana 优先费（micro-lamports per Compute Unit）。用户传入时回显；未传入时由平台动态计算。EVM 链此字段为 null。" }, "computeUnitLimit": { "type": "string", "nullable": true, "example": "1400000", "description": "Solana 最大可消耗的 Compute Units。用户传入时回显；未传入时不返回。EVM 链此字段为 null。" } } }, "executionMode": { "type": "string", "example": "SWAP", "enum": ["SWAP", "RFQ"], "description": "本次 swap 的执行模式。`SWAP` = 签名 `tx` 对象后广播到链上。 `RFQ` = 对 `rfq.typedDataToSign` 做 EIP-712 签名（`eth_signTypedData_v4`）， 通过 `POST /order/submit` 提交，轮询 `GET /order/{orderId}` 获取结算状态。 权益 / RWA 代币始终返回 `RFQ`。" }, "rfq": { "type": "object", "nullable": true, "description": "RFQ 订单载荷，仅 `executionMode=RFQ` 时存在。包含用户须签名的 EIP-712 typed data、 目标 vendor、签名方案，以及（按需返回的）授权交易数据。", "properties": { "vendor": { "type": "string", "example": "PcsXRfq", "enum": ["InchFusion", "CowSwap", "PcsXRfq"], "description": "负责链上撮合的 RFQ vendor，在 `POST /order/submit` 的 `vendor` 字段中传入。" }, "txType": { "type": "string", "example": "EIP712", "enum": ["EIP712", "RAW_TX"], "description": "RFQ 交易类型。当前固定为 `EIP712`（三个 RFQ vendor 均走 typed-data 签名）； 保留字段以备未来扩展。" }, "typedDataToSign": { "type": "string", "example": "0x1901...", "description": "用于 `eth_signTypedData_v4` 的 EIP-712 typed data（hex 字符串或 JSON 字符串）。 使用 `/quote` 时传入的 `userWalletAddress` 对应钱包签名，签名结果通过 `POST /order/submit` 的 `userSignature` 字段提交。" }, "signingScheme": { "type": "string", "example": "EIP712", "description": "该 vendor 要求的签名方案，在 `POST /order/submit` 的 `signingScheme` 字段中传入。" }, "signatureData": { "type": "array", "items": { "type": "string", "example": "{\"approveContract\":\"0xc67879F4065d3B9fe1C09EE990B891Aa8E3a4c2f\",\"approveTxCalldata\":\"0x095ea7b3...\"}" }, "description": "授权交易数据（仅 `approveTransaction=true` 且 from 为 EVM ERC-20 时返回；否则为空列表）。 元素为 JSON 字符串，含 `approveContract`（按 vendor 解析的 spender 地址）与 `approveTxCalldata`（ERC-20 `approve()` calldata）。" } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/quote-and-swap": { "get": { "summary": "一步询价并构造交易（Flash API）", "description": "单次调用同时完成询价与 swap 交易构造。与两步走的 `/quote` + `/swap` 不同，本接口无需前置 `/quote` 调用，不依赖 `quoteId`，直接返回可上链 执行的 calldata / swapTransaction，减少一次 HTTP 往返。\n适合对延迟敏感且已知 vendor 的交易场景。响应结构与 `/swap` 完全一致， 客户端可复用同一套响应解析逻辑。", "tags": ["Trading API"], "operationId": "quoteAndBuildSwapTransaction", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#quote-and-build-swap-transaction" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/quoteAndBuildSwapTransaction.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/quote_and_build_swap_transaction.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/QuoteAndBuildSwapTransactionExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识。" }, { "name": "amount", "in": "query", "required": true, "schema": { "type": "string", "example": "1000000" }, "description": "卖出币种数量（含精度的正整数字符串）。" }, { "name": "fromTokenAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955" }, "description": "卖出币种合约地址。" }, { "name": "toTokenAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }, "description": "买入币种合约地址。" }, { "name": "slippagePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "0.5" }, "description": "最大滑点容忍度（百分比字符串）。`autoSlippage=true` 时可不传，否则必填。\n\n**按链区分范围：**\n- EVM 链（BSC、Ethereum、Base 等）：`0` 到 `100`（含边界）\n- Solana（`CT_501`）：`0` 到小于 `100`（即 `< 100`）\n\n`\"0.5\"` 表示最大滑点 0.5%。`autoSlippage=true` 时，此字段会被自动计算的滑点值覆盖。" }, { "name": "userWalletAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "description": "用户钱包地址（交易发起方）。Solana 链需为 Base58 的 system-account 地址且持有足够 SOL 付 gas。" }, { "name": "vendor", "in": "query", "required": true, "schema": { "type": "string", "example": "LiquidMesh", "enum": ["LiquidMesh"] }, "description": "本次 swap 使用的 vendor。**必填**，大小写敏感，需与 enum 列表一致， 其他值返回 `PARAM_ERROR`（40001）。多 vendor 聚合请改用 `/swap` + `quoteId`。" }, { "name": "approveTransaction", "in": "query", "required": false, "schema": { "type": "string", "example": "false", "enum": ["true", "false"] }, "description": "为 \"true\" 时在 `signatureData` 内返回授权地址及授权 calldata，便于客户端在 swap 前提交授权。默认 false。" }, { "name": "approveAmount", "in": "query", "required": false, "schema": { "type": "string", "example": "1000000" }, "description": "授权数量（含精度的正整数字符串）。默认与本次交易数量相同。" }, { "name": "gasLimit", "in": "query", "required": false, "schema": { "type": "string", "example": "200000" }, "description": "Gas limit 上限（正整数字符串）。仅 EVM 链生效。" }, { "name": "gasLevel", "in": "query", "required": false, "schema": { "type": "string", "example": "average", "enum": ["slow", "average", "fast"] }, "description": "Gas 价格档位，默认 \"average\"。" }, { "name": "priceImpactProtectionPercent", "in": "query", "required": false, "schema": { "type": "string", "example": "90" }, "description": "允许的价格影响百分比（0–100）。默认 90，设为 100 时禁用此功能。" }, { "name": "autoSlippage", "in": "query", "required": false, "schema": { "type": "string", "example": "false", "enum": ["true", "false"] }, "description": "为 `\"true\"` 时，基于市场数据自动计算滑点并覆盖 `slippagePercent`。 `slippagePercent` 与 `autoSlippage=true` 二选一必填，两者均不传时返回参数错误。 默认 `\"false\"`。" }, { "name": "maxAutoSlippagePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "3" }, "description": "自动滑点上限，仅在 `autoSlippage=true` 时生效。" }, { "name": "computeUnitLimit", "in": "query", "required": false, "schema": { "type": "string", "example": "1400000" }, "description": "Solana 专用 — 限制本次交易最大可消耗的 Compute Units，类比 EVM 的 gasLimit。仅 `binanceChainId=CT_501` 时生效。" }, { "name": "computeUnitPrice", "in": "query", "required": false, "schema": { "type": "string", "example": "1000" }, "description": "Solana 专用 — 每个 Compute Unit 的优先费（micro-lamports），类比 EVM 的 gasPrice。未传入时由平台动态计算。仅 `binanceChainId=CT_501` 时生效。" }, { "name": "tips", "in": "query", "required": false, "schema": { "type": "string", "example": "0.001" }, "description": "Solana 专用 — Jito tips 小费（单位 SOL），用于 MEV 保护。有效范围 [0.000000001, 2]（最小 1 lamport）。指定后建议将 `computeUnitPrice` 设为 0。仅 `binanceChainId=CT_501` 时生效。" }, { "name": "feePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "1.5" }, "description": "自定义手续费（分佣 / Add Fee）百分比，十进制字符串。必须与 `fromTokenReferrerWalletAddress` 或 `toTokenReferrerWalletAddress` 中的一个搭配（两个 referrer 地址互斥，二选一）。\n\n**范围按链区分：**EVM 链（BSC、Ethereum、Base 等）`(0, 5]`，Solana（`CT_501`）`(0, 10]` （大于 0、到链上限含边界），最多 2 位小数。`\"1.5\"` 表示 1.5%，超过 2 位小数返回 `INVALID_FEE_PERCENT`（40466）。\n\n**`four.meme` 代币不支持**——当交易对任意一侧为 `four.meme` 代币时，请勿传入 fee 相关参数。" }, { "name": "fromTokenReferrerWalletAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "0xCbF2B6E6e3D7e9e4e4e4e4e4e4e4e4e4e4e4e4e4" }, "description": "从卖出币种扣减手续费的接收钱包地址（`FROM_TOKEN` 方向）。与 `toTokenReferrerWalletAddress` 互斥，同时传入返回 `CONFLICT_REFERRER_PARAMS`（40468）。地址格式按链区分：EVM 链为 `0x` + 40 位 hex，Solana（`CT_501`）为 Base58 公钥，格式非法返回 `INVALID_REFERRER_ADDRESS`（40467）。必须与 `feePercent` 搭配。" }, { "name": "toTokenReferrerWalletAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "0xCbF2B6E6e3D7e9e4e4e4e4e4e4e4e4e4e4e4e4e4" }, "description": "从买入币种输出扣减手续费的接收钱包地址（`TO_TOKEN` 方向）。与 `fromTokenReferrerWalletAddress` 互斥，同时传入返回 `CONFLICT_REFERRER_PARAMS`（40468）。地址格式按链区分：EVM 链为 `0x` + 40 位 hex，Solana（`CT_501`）为 Base58 公钥，格式非法返回 `INVALID_REFERRER_ADDRESS`（40467）。必须与 `feePercent` 搭配。Solana 链要求该地址已激活 （持有少量 SOL 余额），否则返回 `REFERRER_NOT_ACTIVATED`（40469）。" } ], "responses": { "200": { "description": "成功返回兑换交易数据。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "routerResult": { "type": "object", "description": "路由结果，包含本次 swap 使用的 vendor 及报价信息。", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识。" }, "vendorName": { "type": "string", "example": "Lifi", "description": "提供本次 swap 报价的 vendor。" }, "fromTokenAmount": { "type": "string", "example": "1000000", "description": "卖出币种数量（最小单位整数字符串）。" }, "toTokenAmount": { "type": "string", "example": "998500000000000000", "description": "估算的买入币种数量。" }, "tradeFee": { "type": "string", "nullable": true, "example": "0.12", "description": "询价路径预估消耗的网络费用（USD 计价）。" }, "estimateGasFee": { "type": "string", "nullable": true, "example": "150000", "description": "预估消耗的 Gas（链最小单位）。" }, "router": { "type": "string", "example": "0x55d3...--0xbb4C...--0x8AC7...", "description": "兑换路径描述。" }, "priceImpactPercent": { "type": "string", "example": "-0.01", "description": "价格影响百分比。计算公式：（接收价值 - 支付价值）/ 支付价值。" }, "dexRouterList": { "type": "array", "description": "询价路径数据集合，结构同 `/quote` 接口的 `dexRouterList`。", "items": { "type": "object", "properties": { "dexProtocol": { "type": "object", "properties": { "dexName": { "type": "string", "example": "Uniswap V3" }, "percent": { "type": "string", "example": "85.99" } } }, "fromToken": { "type": "object", "properties": { "tokenContractAddress": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955" }, "tokenSymbol": { "type": "string", "example": "USDT" } } }, "fromTokenIndex": { "type": "string", "example": "0" }, "toToken": { "type": "object", "properties": { "tokenContractAddress": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }, "tokenSymbol": { "type": "string", "example": "BTCB" } } }, "toTokenIndex": { "type": "string", "example": "1" } } } }, "fromToken": { "type": "object", "description": "卖出币种信息。", "properties": { "tokenContractAddress": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955" }, "tokenSymbol": { "type": "string", "example": "USDT" }, "tokenUnitPrice": { "type": "string", "example": "1.0002" }, "decimal": { "type": "string", "example": "18" }, "isHoneyPot": { "type": "boolean", "example": false }, "taxRate": { "type": "string", "example": "0" } } }, "toToken": { "type": "object", "description": "买入币种信息。", "properties": { "tokenContractAddress": { "type": "string", "example": "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d" }, "tokenSymbol": { "type": "string", "example": "BTCB" }, "tokenUnitPrice": { "type": "string", "example": "67000.5" }, "decimal": { "type": "string", "example": "18" }, "isHoneyPot": { "type": "boolean", "example": false }, "taxRate": { "type": "string", "example": "0" } } }, "feeAmount": { "type": "string", "nullable": true, "example": "15000", "description": "本次兑换扣除的手续费金额（含精度整数字符串）。仅在请求开启自定义手续费时返回， 否则为 `null`。`FROM_TOKEN` 方向 = 原始卖出额 × feePercent/100（HALF_UP）； `TO_TOKEN` 方向 = DEX 原始买入额 × feePercent/100（HALF_DOWN）。" }, "feeToken": { "type": "string", "nullable": true, "example": "0x55d398326f99059fF775485246999027B3197955", "description": "手续费计价币种合约地址。`FROM_TOKEN` 方向为卖出币种地址，`TO_TOKEN` 方向为买入币种 地址。未开启自定义手续费时为 `null`。" }, "actualSwapAmount": { "type": "string", "nullable": true, "example": "985000", "description": "实际参与 DEX 兑换的金额（含精度整数字符串）。`FROM_TOKEN` 方向为扣减手续费后的净额 （`fromTokenAmount − feeAmount`）；`TO_TOKEN` 方向为原始输入额（fee 从输出端扣）。 未开启自定义手续费时为 `null`。" } } }, "tx": { "type": "object", "description": "待签名并提交的链上交易数据。", "properties": { "from": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "用户钱包地址（交易发起方）。" }, "to": { "type": "string", "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "DEX Router 合约地址（链上交易的 `to` 字段）。" }, "data": { "type": "string", "example": "0x12aa3caf...", "description": "交易 calldata（ABI 编码的合约调用数据）。" }, "value": { "type": "string", "example": "0", "description": "交易携带的原生代币数量（wei）。ERC-20 兑换时为 \"0\"。" }, "gas": { "type": "string", "example": "200000", "description": "Gas Limit 估算值。" }, "gasPrice": { "type": "string", "example": "5000000000", "description": "Gas Price（wei）。" }, "maxPriorityFeePerGas": { "type": "string", "example": "1000000000", "description": "EIP-1559 优先费（wei）。" }, "minReceiveAmount": { "type": "string", "example": "993507500000000000", "description": "目标币种最小收到数量（达到滑点限制时的最小到账数量）。" }, "slippagePercent": { "type": "string", "example": "0.5", "description": "当前交易使用的滑点值（百分比字符串）。" }, "signatureData": { "type": "array", "description": "额外签名数据。开启 `approveTransaction` 时，内含授权地址及授权 calldata。", "items": { "type": "string", "example": "0xc67879F4065d3B9fe1C09EE990B891Aa8E3a4c2f" } }, "computeUnitPrice": { "type": "string", "nullable": true, "example": "1000", "description": "Solana 优先费（micro-lamports per Compute Unit）。用户传入时回显；未传入时由平台动态计算。EVM 链此字段为 null。" }, "computeUnitLimit": { "type": "string", "nullable": true, "example": "1400000", "description": "Solana 最大可消耗的 Compute Units。用户传入时回显；未传入时不返回。EVM 链此字段为 null。" } } }, "executionMode": { "type": "string", "example": "SWAP", "enum": ["SWAP"], "description": "本次 swap 的执行模式。本接口固定返回 `SWAP`：签名 `tx` 对象后广播到链上，不会返回 `RFQ` 模式。" }, "rfq": { "type": "object", "nullable": true, "description": "本接口固定为 `null`（仅返回 `SWAP` 模式）。", "properties": { "vendor": { "type": "string", "example": "PcsXRfq", "enum": ["InchFusion", "CowSwap", "PcsXRfq"], "description": "负责链上撮合的 RFQ vendor，在 `POST /order/submit` 的 `vendor` 字段中传入。" }, "txType": { "type": "string", "example": "EIP712", "enum": ["EIP712", "RAW_TX"], "description": "RFQ 交易类型。当前固定为 `EIP712`（三个 RFQ vendor 均走 typed-data 签名）； 保留字段以备未来扩展。" }, "typedDataToSign": { "type": "string", "example": "0x1901...", "description": "用于 `eth_signTypedData_v4` 的 EIP-712 typed data（hex 字符串或 JSON 字符串）。 使用 `/quote` 时传入的 `userWalletAddress` 对应钱包签名，签名结果通过 `POST /order/submit` 的 `userSignature` 字段提交。" }, "signingScheme": { "type": "string", "example": "EIP712", "description": "该 vendor 要求的签名方案，在 `POST /order/submit` 的 `signingScheme` 字段中传入。" }, "signatureData": { "type": "array", "items": { "type": "string", "example": "{\"approveContract\":\"0xc67879F4065d3B9fe1C09EE990B891Aa8E3a4c2f\",\"approveTxCalldata\":\"0x095ea7b3...\"}" }, "description": "授权交易数据（仅 `approveTransaction=true` 且 from 为 EVM ERC-20 时返回；否则为空列表）。 元素为 JSON 字符串，含 `approveContract`（按 vendor 解析的 spender 地址）与 `approveTxCalldata`（ERC-20 `approve()` calldata）。" } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/swap-instruction": { "get": { "summary": "构造 Solana 交易指令", "description": "`/swap` 的 Solana 专用对偶接口。共享完整的 quote → route → vendor `buildSwapTx` → priceImpact → minReceive → 指令组装 流水线；唯一区别 在响应：本接口不返回签名序列化后的 base64 完整交易，而是返回 **未编译 （uncompiled）** 的指令列表 + Address Lookup Table (ALT) 地址列表， 由调用方自行完成 v0 交易编译、签名、上链。\n\n适用场景：\n- 调用方需在签名前追加 / 前置自定义指令（例如手续费拆分、自定义日志）；\n- 复用平台策划好的路由、滑点、PS 变体重写、ALT 注入、ComputeBudget\n 覆盖、ATA 合批，同时自行掌控最终上链字节。\n\n\n仅支持 `binanceChainId=CT_501`（Solana），其他链返回 `CHAIN_NOT_SUPPORTED` (40411)。参数与 `/swap` 的 Solana 子集对齐 （不含 EVM 专用的 `approveTransaction` / `approveAmount` / `gasLimit`）。支持自定义手续费（Add Fee / 分佣）参数（`feePercent` + `fromTokenReferrerWalletAddress` / `toTokenReferrerWalletAddress`）， 语义与 `/swap` 一致——fee 指令会注入到返回的未编译指令列表中。", "tags": ["Trading API"], "operationId": "buildSolanaSwapInstructions", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#build-solana-swap-instructions" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/buildSolanaSwapInstructions.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/build_solana_swap_instructions.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/BuildSolanaSwapInstructionsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "CT_501", "enum": ["CT_501"] }, "description": "链唯一标识。仅接受 `CT_501`（Solana），其他值返回 `CHAIN_NOT_SUPPORTED`（40411）。" }, { "name": "amount", "in": "query", "required": true, "schema": { "type": "string", "example": "12000000" }, "description": "卖出币种数量（含精度的正整数字符串）。" }, { "name": "fromTokenAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" }, "description": "卖出币种 mint 地址（Solana Base58，大小写敏感）。" }, { "name": "toTokenAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "So11111111111111111111111111111111111111112" }, "description": "买入币种 mint 地址（Solana Base58，大小写敏感）。" }, { "name": "slippagePercent", "in": "query", "required": true, "schema": { "type": "string", "example": "0.5" }, "description": "最大滑点百分比。Solana 链范围 0–小于 100。\"0.5\" 表示 0.5%。" }, { "name": "userWalletAddress", "in": "query", "required": true, "schema": { "type": "string", "example": "J5CBzXpcYn6WR2JBah8zU4Yxct985CAFGwXRcFaX2pbS" }, "description": "用户钱包地址（Solana Base58），作为 v0 交易的 `feePayer`。" }, { "name": "quoteId", "in": "query", "required": true, "schema": { "type": "string", "example": "a1b2c3d4e5f64a8b9c0d1e2f3a4b5c6d" }, "description": "`/quote` 返回的 quoteId，用于定位要执行的路由。TTL 约 30 秒，过期返回 `QUOTE_EXPIRED`（40401）。" }, { "name": "priceImpactProtectionPercent", "in": "query", "required": false, "schema": { "type": "string", "example": "90" }, "description": "允许的价格影响百分比（0–100）。默认 90，设为 100 时禁用此功能。" }, { "name": "autoSlippage", "in": "query", "required": false, "schema": { "type": "string", "example": "false", "enum": ["true", "false"] }, "description": "为 \"true\" 时基于市场数据自动设定滑点，覆盖 `slippagePercent`。默认 false。" }, { "name": "maxAutoSlippagePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "3" }, "description": "自动滑点上限，仅在 `autoSlippage=true` 时生效。" }, { "name": "computeUnitLimit", "in": "query", "required": false, "schema": { "type": "string", "example": "1400000" }, "description": "限制本次交易最大可消耗的 Compute Units，类比 EVM 的 gasLimit。未传入时使用平台默认值。" }, { "name": "computeUnitPrice", "in": "query", "required": false, "schema": { "type": "string", "example": "1000" }, "description": "每个 Compute Unit 的优先费（micro-lamports）。未传入时，平台根据 `gasLevel` 档位或链级默认值动态计算。" }, { "name": "gasLevel", "in": "query", "required": false, "schema": { "type": "string", "example": "average", "enum": ["slow", "average", "fast"] }, "description": "优先费档位，仅在未传入 `computeUnitPrice` 时生效。默认 \"average\"。" }, { "name": "tips", "in": "query", "required": false, "schema": { "type": "string", "example": "0.001" }, "description": "Jito tips 小费（单位 SOL），用于 MEV 保护。有效范围 [0.000000001, 2]（最小 1 lamport）。指定后建议将 `computeUnitPrice` 设为 0。平台按 Jito 协议在每次请求中随机选取一个 tip 账户。" }, { "name": "feePercent", "in": "query", "required": false, "schema": { "type": "string", "example": "1.5" }, "description": "自定义手续费（分佣 / Add Fee）百分比，十进制字符串。必须与 `fromTokenReferrerWalletAddress` 或 `toTokenReferrerWalletAddress` 中的一个搭配（两个 referrer 地址互斥，二选一）。语义与 `/swap` 一致。\n\n**范围（Solana）：**`(0, 10]`（大于 0、最多 10），最多 2 位小数。`\"1.5\"` 表示 1.5%，超过 2 位小数返回 `INVALID_FEE_PERCENT`（40466）。\n\n**`four.meme` 代币不支持**——当交易对任意一侧为 `four.meme` 代币时，请勿传入 fee 相关参数。" }, { "name": "fromTokenReferrerWalletAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "J5CBzXpcYn6WR2JBah8zU4Yxct985CAFGwXRcFaX2pbS" }, "description": "从卖出币种扣减手续费的接收钱包地址（`FROM_TOKEN` 方向）。与 `toTokenReferrerWalletAddress` 互斥，同时传入返回 `CONFLICT_REFERRER_PARAMS`（40468）。Solana 格式为 Base58 公钥，格式非法 返回 `INVALID_REFERRER_ADDRESS`（40467）。必须与 `feePercent` 搭配。" }, { "name": "toTokenReferrerWalletAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "J5CBzXpcYn6WR2JBah8zU4Yxct985CAFGwXRcFaX2pbS" }, "description": "从买入币种输出扣减手续费的接收钱包地址（`TO_TOKEN` 方向）。与 `fromTokenReferrerWalletAddress` 互斥，同时传入返回 `CONFLICT_REFERRER_PARAMS`（40468）。Solana 格式为 Base58 公钥，格式非法 返回 `INVALID_REFERRER_ADDRESS`（40467）。必须与 `feePercent` 搭配。该地址必须已激活 （持有少量 SOL 余额），否则返回 `REFERRER_NOT_ACTIVATED`（40469）。" } ], "responses": { "200": { "description": "成功返回未编译的 Solana 指令列表与 ALT 地址。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "addressLookupTableAccount": { "type": "array", "description": "交易引用的 Address Lookup Table 地址列表（Base58），含平台注入的自定义 ALT。调用方在编译 v0 message 前需自行 `getAccountInfo` 拉取每个 ALT 账户并填充查表数据。", "items": { "type": "string", "example": "AcL1Vo8oy1ULiavEcjSUcwfBSForXMudbWLPYz2gTW4D" } }, "instructionLists": { "type": "array", "description": "按执行顺序排列的未编译指令列表，组装 v0 交易时按本顺序加入。", "items": { "type": "object", "properties": { "programId": { "type": "string", "example": "ComputeBudget111111111111111111111111111111", "description": "指令所属的 Program ID（Base58）。" }, "data": { "type": "string", "example": "AgY6BAA=", "description": "指令数据（Base64 编码）。无数据指令返回空字符串。" }, "accounts": { "type": "array", "description": "指令涉及的账户列表（按指令 ABI 顺序）。", "items": { "type": "object", "properties": { "pubkey": { "type": "string", "example": "J5CBzXpcYn6WR2JBah8zU4Yxct985CAFGwXRcFaX2pbS", "description": "账户公钥（Base58）。" }, "isSigner": { "type": "boolean", "example": false, "description": "是否为签名者。" }, "isWritable": { "type": "boolean", "example": true, "description": "是否可写。" } } } } } } }, "routerResult": { "type": "object", "description": "路由结果，结构与语义同 `/swap` 的 `routerResult`。", "properties": { "binanceChainId": { "type": "string", "example": "CT_501", "description": "链唯一标识（恒为 `CT_501`）。" }, "vendorName": { "type": "string", "example": "Jupiter", "description": "提供本次 swap 报价的 vendor（Solana 链支持 Jupiter、LiquidMesh）。" }, "fromTokenAmount": { "type": "string", "example": "12000000", "description": "卖出币种数量（最小单位整数字符串）。" }, "toTokenAmount": { "type": "string", "example": "607402", "description": "估算的买入币种数量（最小单位整数字符串）。" }, "tradeFee": { "type": "string", "nullable": true, "example": "0.12", "description": "询价路径预估消耗的网络费用（USD 计价）。" }, "estimateGasFee": { "type": "string", "nullable": true, "example": "1400000", "description": "估算的 Compute Units（回显 `computeUnitLimit`）。" }, "router": { "type": "string", "example": "So11...112--EPjF...DT1v", "description": "兑换路径描述。" }, "priceImpactPercent": { "type": "string", "example": "-0.01", "description": "价格影响百分比。" }, "dexRouterList": { "type": "array", "description": "询价路径数据集合，结构同 `/quote`。", "items": { "type": "object", "properties": { "dexProtocol": { "type": "object", "properties": { "dexName": { "type": "string", "example": "Raydium" }, "percent": { "type": "string", "example": "100" } } }, "fromToken": { "type": "object", "properties": { "tokenContractAddress": { "type": "string", "example": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" }, "tokenSymbol": { "type": "string", "example": "USDC" } } }, "fromTokenIndex": { "type": "string", "example": "0" }, "toToken": { "type": "object", "properties": { "tokenContractAddress": { "type": "string", "example": "So11111111111111111111111111111111111111112" }, "tokenSymbol": { "type": "string", "example": "WSOL" } } }, "toTokenIndex": { "type": "string", "example": "1" } } } }, "fromToken": { "type": "object", "description": "卖出币种信息。", "properties": { "tokenContractAddress": { "type": "string", "example": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" }, "tokenSymbol": { "type": "string", "example": "USDC" }, "decimal": { "type": "string", "example": "6" } } }, "toToken": { "type": "object", "description": "买入币种信息。", "properties": { "tokenContractAddress": { "type": "string", "example": "So11111111111111111111111111111111111111112" }, "tokenSymbol": { "type": "string", "example": "WSOL" }, "decimal": { "type": "string", "example": "9" } } }, "feeAmount": { "type": "string", "nullable": true, "example": "15000", "description": "本次兑换扣除的手续费金额（含精度整数字符串）。仅在请求开启自定义手续费时返回， 否则为 `null`。`FROM_TOKEN` 方向 = 原始卖出额 × feePercent/100（HALF_UP）； `TO_TOKEN` 方向 = DEX 原始买入额 × feePercent/100（HALF_DOWN）。" }, "feeToken": { "type": "string", "nullable": true, "example": "So11111111111111111111111111111111111111112", "description": "手续费计价币种合约地址。`FROM_TOKEN` 方向为卖出币种地址，`TO_TOKEN` 方向为买入币种 地址。未开启自定义手续费时为 `null`。" }, "actualSwapAmount": { "type": "string", "nullable": true, "example": "985000", "description": "实际参与 DEX 兑换的金额（含精度整数字符串）。`FROM_TOKEN` 方向为扣减手续费后的净额 （`fromTokenAmount − feeAmount`）；`TO_TOKEN` 方向为原始输入额（fee 从输出端扣）。 未开启自定义手续费时为 `null`。" } } }, "tx": { "type": "object", "description": "交易摘要（无 `data` 字段，已由 `instructionLists` 替代），含调用方在签名前需展示或审计的关键字段。", "properties": { "from": { "type": "string", "example": "J5CBzXpcYn6WR2JBah8zU4Yxct985CAFGwXRcFaX2pbS", "description": "用户钱包地址（交易发起方 / fee payer）。" }, "to": { "type": "string", "example": "proVF4pMXVaYqmy4NjniPh4pqKNfMmsihgd4wdkCX3u", "description": "平台 Router 程序地址（即 swap 执行的目标 program）。" }, "minReceiveAmount": { "type": "string", "example": "604365", "description": "目标币种最小收到数量（达到滑点限制时的最小到账数量）。" }, "slippagePercent": { "type": "string", "example": "0.5", "description": "当前交易使用的滑点值（百分比字符串）。" } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/history": { "get": { "summary": "查询交易状态", "description": "根据 `binanceChainId` + `txHash` 查询链上 DEX 兑换交易的详细状态。\n响应说明：\n- 交易不存在：`data` 为 `null`（非 HTTP 404）。\n- 交易失败：`status=failed`，含 `errorMsg`；聚合业务字段（`txType`、`dexRouter`、\n `fromTokenDetails`、`toTokenDetails`）为 `null`。\n\n- 交易成功：`status=success`，有聚合事件时包含完整 token 详情。", "tags": ["Trading API"], "operationId": "getTransactionStatus", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#get-transaction-status" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/getTransactionStatus.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/get_transaction_status.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/GetTransactionStatusExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "56" }, "description": "链唯一标识。" }, { "name": "txHash", "in": "query", "required": true, "schema": { "type": "string", "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890" }, "description": "链上交易 Hash。" } ], "responses": { "200": { "description": "交易详情。未找到记录时 `data` 为 null。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "nullable": true, "description": "交易详情。两表均无记录时为 null。", "properties": { "binanceChainId": { "type": "string", "example": "56", "description": "链唯一标识。" }, "txHash": { "type": "string", "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890", "description": "交易 Hash。" }, "height": { "type": "string", "example": "39812345", "description": "交易所在的区块高度（十进制字符串）。" }, "txTime": { "type": "string", "example": "1748601600000", "description": "交易时间，Unix 时间戳毫秒（字符串形式）。" }, "status": { "type": "string", "example": "success", "description": "交易状态，典型值 \"success\" / \"failed\"。" }, "fromAddress": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发送地址。" }, "toAddress": { "type": "string", "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "接收地址（通常为 DEX Router 合约地址）。" }, "errorMsg": { "type": "string", "nullable": true, "example": "execution reverted: insufficient liquidity", "description": "错误信息，`status=failed` 时有值，否则为 null。" }, "gasLimit": { "type": "string", "nullable": true, "example": "200000", "description": "Gas 限额（十进制字符串）。Solana 链为 null。" }, "gasUsed": { "type": "string", "nullable": true, "example": "150000", "description": "Gas 实际消耗量（十进制字符串，单位 wei）。Solana 链为 null。" }, "gasPrice": { "type": "string", "nullable": true, "example": "5000000000", "description": "Gas Price（十进制字符串，单位 wei）。Solana 链为 null。" }, "txFee": { "type": "string", "nullable": true, "example": "750000000000000", "description": "手续费（原生代币最小单位）。Solana 链为 null。" }, "priorityFee": { "type": "string", "nullable": true, "example": "1000000000", "description": "EIP-1559 优先费（wei）；Solana 为 prioritization fee（lamports）；Legacy EVM 交易为 null。" }, "txType": { "type": "string", "nullable": true, "example": "Swap", "description": "交易行为，有聚合事件时固定 \"Swap\"，否则为 null。" }, "dexRouter": { "type": "string", "nullable": true, "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "交互的 DEX Router 合约地址（同 `toAddress`）。无聚合事件时为 null。" }, "fromTokenDetails": { "type": "array", "nullable": true, "description": "输入 token 详情列表。有聚合事件时有值，否则为 null。", "items": { "type": "object", "properties": { "symbol": { "type": "string", "nullable": true, "example": "USDT", "description": "币种简称。元数据查不到时为 null。" }, "amount": { "type": "string", "example": "1500000", "description": "币种兑换数量（最小单位整数字符串）。" }, "tokenAddress": { "type": "string", "example": "0x55d398326f99059fF775485246999027B3197955", "description": "币种合约地址。" } } } }, "toTokenDetails": { "type": "array", "nullable": true, "description": "输出 token 详情列表。有聚合事件时有值，否则为 null。", "items": { "type": "object", "properties": { "symbol": { "type": "string", "nullable": true, "example": "BTCB" }, "amount": { "type": "string", "example": "22500000000000", "description": "币种兑换数量（最小单位整数字符串）。" }, "tokenAddress": { "type": "string", "example": "0x7130d2A12B9BCbFAe4f2634d864A1Ee1Ce3Ead9c", "description": "币种合约地址。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/order/submit": { "post": { "summary": "提交 RFQ 订单", "description": "将已签名的 RFQ 订单提交至后端，由后端转发给对应 vendor relayer 完成链上撮合。 仅当 `executionMode=RFQ`（Ondo、BStock 等权益 / RWA 代币）时使用。\n\n**流程**：`GET /quote` → 选择 RFQ 路由 → `GET /swap` → 对 `rfq.typedDataToSign` 做 EIP-712 签名（`eth_signTypedData_v4`）→ 调用本接口 → 轮询 `GET /order/{orderId}` 直到 `FILLED` 或 `FAILED`。\n\n**幂等性**：30 分钟内相同 `requestId` 重复提交直接返回首次结果，不重复调 vendor。 每次新提交生成新 UUID；重试时复用同一 UUID。", "tags": ["Trading API"], "operationId": "submitRfqOrder", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#submit-rfq-order" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/submitRfqOrder.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/submit_rfq_order.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/SubmitRfqOrderExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["requestId", "userSignature", "vendor", "quoteId"], "properties": { "requestId": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000", "description": "幂等键（UUID v4）。30 分钟内相同 `requestId` 重复提交直接返回首次结果，不重复调 vendor。 每次新提交生成新 UUID；重试同一次提交时复用同一 UUID。" }, "userSignature": { "type": "string", "example": "0x1234abcd...5678ef", "description": "对 `/swap` 响应中 `rfq.typedDataToSign` 做 EIP-712 签名的结果。须为 `0x` 前缀的 hex 字符串 （132 字符 = `0x` + 65 字节）。签名钱包须与 `/quote` 时的 `userWalletAddress` 一致。 后端自动修正 Ethereum `v` 值 `00`/`01` → `1b`/`1c`。" }, "vendor": { "type": "string", "example": "PcsXRfq", "enum": ["InchFusion", "CowSwap", "PcsXRfq"], "description": "RFQ vendor 名称，须与 `/swap` 响应中 `rfq.vendor` 一致。后端结合 `quoteId` 做强校验，防止错误路由。" }, "quoteId": { "type": "string", "example": "a1b2c3d4e5f64a8b9c0d1e2f3a4b5c6d", "description": "`/swap` 响应中 `rfq.orderId` 的值。后端据此反查 vendor 及链上下文后转发签名订单。" }, "signingScheme": { "type": "string", "example": "EIP712", "description": "`/swap` 响应中 `rfq.signingScheme` 的值。可选，省略时后端按 vendor 推断默认值。" } } } } } }, "responses": { "200": { "description": "RFQ 订单提交成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "提交订单结果。", "properties": { "orderId": { "type": "string", "example": "oc-o-abc123def456", "description": "平台生成的订单 ID，用于轮询 `GET /order/{orderId}` 获取最终结算状态。" }, "status": { "type": "string", "example": "PENDING_VENDOR", "description": "提交后的初始订单状态，通常为 `PENDING_VENDOR`（已转发至 vendor，等待结算）。" }, "createdAt": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "订单创建时间（Unix 时间戳毫秒）。" } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/aggregator/order/{orderId}": { "get": { "summary": "查询 RFQ 订单状态", "description": "按平台 `orderId`（由 `POST /order/submit` 返回）查询 RFQ 订单的结算状态。 持续轮询直到 `status` 到达终态：`FILLED`（链上已结算）或 `FAILED`（结算失败）。", "tags": ["Trading API"], "operationId": "getRfqOrderStatus", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/trading-api#get-rfq-order-status" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TradingApi/getRfqOrderStatus.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Trading/get_rfq_order_status.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/trading/GetRfqOrderStatusExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "example": "oc-o-abc123def456" }, "description": "`POST /order/submit` 返回的平台订单 ID。" } ], "responses": { "200": { "description": "成功返回订单状态。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "订单状态详情。", "properties": { "orderId": { "type": "string", "example": "oc-o-abc123def456", "description": "平台订单 ID。" }, "status": { "type": "string", "example": "FILLED", "description": "当前订单状态。\n\n- **终态**：`FILLED`（链上已结算）、`FAILED`（结算失败）、`EXPIRED`（vendor 在订单截止前未撮合成功）、`CANCELLED`（用户或 vendor 主动取消）。\n- **中间状态**：`PENDING_VENDOR`（已转发给 vendor，等待撮合）、`PENDING_ONCHAIN`（vendor 已发出链上交易，等待区块确认）。" }, "txHash": { "type": "string", "nullable": true, "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890", "description": "链上交易 Hash，仅 `status=FILLED` 时有值。" }, "fromAmount": { "type": "string", "nullable": true, "example": "1000000", "description": "实际结算的卖出币种数量（最小单位整数字符串），成交后有值。" }, "toAmount": { "type": "string", "nullable": true, "example": "998500000000000000", "description": "实际收到的买入币种数量（最小单位整数字符串），成交后有值。" }, "filledAt": { "type": "integer", "format": "int64", "nullable": true, "example": 1748601700000, "description": "成交时间（Unix 时间戳毫秒），成交后有值。" }, "createdAt": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "订单创建时间（Unix 时间戳毫秒）。" } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/pre-transaction/supported/chain": { "get": { "summary": "获取链上交易支持的链", "description": "返回 Transaction 服务当前支持的区块链列表（用于 Gas 估算、模拟和广播）。 支持链由服务端动态配置，可能随时变更。", "tags": ["Transaction API"], "operationId": "getTransactionSupportedChains", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/transaction-api#get-transaction-supported-chains" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TransactionApi/getTransactionSupportedChains.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Transaction/get_transaction_supported_chains.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/transaction/GetTransactionSupportedChainsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "responses": { "200": { "description": "成功返回支持的链列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功，非 0 表示业务错误。" }, "msg": { "type": "string", "example": "success", "description": "状态描述信息。" }, "data": { "type": "array", "description": "支持的区块链网络列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识（EVM 链遵循 EIP-155 chainId；如 \"1\"=Ethereum，\"56\"=BSC，\"CT_501\"=Solana，\"CT_195\"=Tron）。" }, "name": { "type": "string", "example": "Ethereum", "description": "链全称。" }, "shortName": { "type": "string", "example": "ETH", "description": "链简称。" }, "logoUrl": { "type": "string", "example": "https://onchainos.bnbstatic.com/image/admin_mgs_image_upload/20250228/b549e557-76ca-4873-88ef-3a107cf2c9fe.png", "description": "链 Logo 图片 URL。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务端响应时间戳（毫秒）。" }, "success": { "type": "boolean", "example": true, "description": "由 `code == 0` 派生的便捷布尔值。" } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/pre-transaction/gas-price": { "get": { "summary": "获取 Gas 价格", "description": "查询指定链当前的网络 Gas 价格。返回结构因链族而异：\n- EVM 链：同时返回 `evmLegacyGasPrice`（传统 gasPrice）和 `eip1559GasPrice`（baseFee + priority/max fee，链支持 EIP-1559 时）。 - Solana 链：返回 `solanaGasPrice`（compute-unit 价格和 Jito 小费）。 - Tron 链（\"CT_195\"）：返回空 `data` 对象，因为 Tron 没有链上 Gas 价格概念，请改用 gas-limit 接口。\n与当前链族无关的字段为 `null`。", "tags": ["Transaction API"], "operationId": "getGasPrice", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/transaction-api#get-gas-price" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TransactionApi/getGasPrice.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Transaction/get_gas_price.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/transaction/GetGasPriceExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（如 \"1\"=Ethereum，\"56\"=BSC，\"CT_501\"=Solana，\"CT_195\"=Tron）。" } ], "responses": { "200": { "description": "指定链当前的 Gas 价格。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "Gas 价格详情，填充字段取决于链族。", "properties": { "evmLegacyGasPrice": { "type": "object", "nullable": true, "description": "EVM 传统 gasPrice 三档（wei，整数字符串）。非 EVM 链为 null。", "properties": { "lowGasPrice": { "type": "string", "example": "1000000000", "description": "慢速档位 gas price（wei）。" }, "mediumGasPrice": { "type": "string", "example": "2000000000", "description": "平均档位 gas price（wei）。" }, "highGasPrice": { "type": "string", "example": "5000000000", "description": "快速档位 gas price（wei）。" } } }, "eip1559GasPrice": { "type": "object", "nullable": true, "description": "EIP-1559 费用结构（wei，整数字符串）。不支持 EIP-1559 或非 EVM 链为 null。", "properties": { "baseFee": { "type": "string", "example": "1500000000", "description": "当前区块的基础费（wei）。" }, "lowPriorityFee": { "type": "string", "example": "100000000", "description": "慢速档位 max priority fee（wei）。" }, "lowMaxFee": { "type": "string", "example": "1700000000", "description": "慢速档位 max fee（wei）。" }, "mediumPriorityFee": { "type": "string", "example": "500000000", "description": "平均档位 max priority fee（wei）。" }, "mediumMaxFee": { "type": "string", "example": "2200000000", "description": "平均档位 max fee（wei）。" }, "highPriorityFee": { "type": "string", "example": "1000000000", "description": "快速档位 max priority fee（wei）。" }, "highMaxFee": { "type": "string", "example": "3000000000", "description": "快速档位 max fee（wei）。" } } }, "solanaGasPrice": { "type": "object", "nullable": true, "description": "Solana 链 compute-unit 价格与 Jito 小费。非 Solana 链为 null。", "properties": { "lowComputeUnitPrice": { "type": "string", "example": "500", "description": "慢速档位 compute-unit price（micro-lamports per CU）。" }, "lowJitoTip": { "type": "string", "example": "10000", "description": "慢速档位 Jito 小费（lamports）。" }, "mediumComputeUnitPrice": { "type": "string", "example": "1000" }, "mediumJitoTip": { "type": "string", "example": "50000" }, "highComputeUnitPrice": { "type": "string", "example": "5000" }, "highJitoTip": { "type": "string", "example": "200000" } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/pre-transaction/block-height": { "get": { "summary": "获取最新区块高度", "description": "返回 Binance Web3 节点在指定链上当前同步到的最新区块高度。调用方可据此监控节点同步进度， 用于风控以检测节点是否落后于主链高度。", "tags": ["Transaction API"], "operationId": "getLatestBlockHeight", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/transaction-api#get-latest-block-height" }, "x-connectors-examples": {}, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识（如 \"1\"=Ethereum，\"56\"=BSC，\"CT_501\"=Solana，\"CT_195\"=Tron）。" } ], "responses": { "200": { "description": "指定链的最新区块高度。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功，非 0 表示业务错误。" }, "msg": { "type": "string", "example": "success", "description": "状态描述信息。" }, "data": { "type": "object", "description": "最新区块高度信息。", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "请求中传入的链标识，原样回传。" }, "blockHeight": { "type": "integer", "format": "int64", "example": 21000000, "description": "Binance Web3 节点跟踪的最新区块高度（Solana 为 slot）。以 64 位整数表示。" } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000, "description": "服务端响应时间戳（毫秒）。" }, "success": { "type": "boolean", "example": true, "description": "由 `code == 0` 派生的便捷布尔值。" } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/pre-transaction/gas-limit": { "post": { "summary": "估算 Gas Limit", "description": "为未签名交易估算 Gas Limit（Solana 链则为 compute-unit 上限）。\n根据 `binanceChainId` 提供 `evmTx`（EVM 链）、`solTx`（Solana 链）或 `tronTx`（Tron 链，\"CT_195\"）。\nTron 链的响应返回 energy/bandwidth 相关字段而非单一 gas limit； `gasLimit` 为 fee limit（单位 sun），energy/bandwidth 字段描述资源消耗与定价。", "tags": ["Transaction API"], "operationId": "getGasLimit", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/transaction-api#get-gas-limit" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TransactionApi/getGasLimit.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Transaction/get_gas_limit.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/transaction/GetGasLimitExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["binanceChainId", "evmTx", "solTx", "tronTx"], "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识（如 \"1\"=Ethereum，\"56\"=BSC，\"CT_501\"=Solana，\"CT_195\"=Tron）。 EVM 链提供 `evmTx`，Solana 链提供 `solTx`，Tron 链提供 `tronTx`，三者必须且只能提供其一。 注：`evmTx`、`solTx` 与 `tronTx` 在 schema 中均标记为 required，仅为渲染需要；实际调用时按 `binanceChainId` 三选一传入。" }, "evmTx": { "type": "object", "description": "EVM 交易体。`binanceChainId` 为 EVM 链时必填。", "required": ["from", "to", "value", "data"], "example": { "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "to": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "value": "0", "data": "0xa9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240" }, "properties": { "from": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发起方地址。" }, "to": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "接收方地址（合约或外部账户）。" }, "value": { "type": "string", "example": "0", "description": "原生代币转账金额（wei，整数字符串）。ERC-20 转账填 \"0\"。" }, "data": { "type": "string", "example": "0xa9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240", "description": "ABI 编码的 calldata（十六进制）。无合约调用时可省略。" } } }, "solTx": { "type": "object", "description": "Solana 交易体。`binanceChainId=CT_501` 时必填。", "required": ["base64Tx"], "example": { "base64Tx": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAECAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEAAA==" }, "properties": { "base64Tx": { "type": "string", "example": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAECAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEAAA==", "description": "Base64 编码的未签名 Solana 交易。" } } }, "tronTx": { "type": "object", "description": "Tron 交易体。`binanceChainId=CT_195` 时必填。", "required": ["from", "txType"], "properties": { "from": { "type": "string", "example": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8", "description": "发起方地址（base58check）。" }, "txType": { "type": "string", "enum": ["TRIGGER_SMART_CONTRACT", "TRANSFER_CONTRACT"], "example": "TRIGGER_SMART_CONTRACT", "description": "Tron 合约类型。`TRIGGER_SMART_CONTRACT` 需提供 `triggerSmartContractParams`；`TRANSFER_CONTRACT` 需提供 `transferContractParams`。" }, "triggerSmartContractParams": { "type": "object", "description": "当 `txType=TRIGGER_SMART_CONTRACT` 时必填。", "required": ["contractAddress", "data", "callValue"], "properties": { "contractAddress": { "type": "string", "example": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t", "description": "合约地址（base58check）。" }, "data": { "type": "string", "example": "a9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240", "description": "ABI 编码的 calldata（十六进制，无 `0x` 前缀）。" }, "callValue": { "type": "integer", "format": "int64", "example": 0, "description": "附带的 TRX 金额（单位 sun），对应 `call_value`。" }, "feeLimitSun": { "type": "integer", "format": "int64", "nullable": true, "example": 100000000, "description": "调用方愿意支付的最大费用（单位 sun），可选。未提供时使用服务端默认值。" } } }, "transferContractParams": { "type": "object", "description": "当 `txType=TRANSFER_CONTRACT` 时必填。", "required": ["toAddress", "amount"], "properties": { "toAddress": { "type": "string", "example": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8", "description": "接收方地址（base58check）。" }, "amount": { "type": "integer", "format": "int64", "minimum": 1, "example": 1000000, "description": "TRX 金额（单位 sun，1 TRX = 1_000_000 sun）。" } } } } } } }, "examples": { "evm": { "summary": "EVM 链（Ethereum ERC-20 转账）", "value": { "binanceChainId": "1", "evmTx": { "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "to": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "value": "0", "data": "0xa9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240" } } }, "solana": { "summary": "Solana 链", "value": { "binanceChainId": "CT_501", "solTx": { "base64Tx": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAECAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEAAA==" } } }, "tron": { "summary": "Tron 链（TRC-20 转账）", "value": { "binanceChainId": "CT_195", "tronTx": { "from": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8", "txType": "TRIGGER_SMART_CONTRACT", "triggerSmartContractParams": { "contractAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t", "data": "a9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240", "callValue": 0, "feeLimitSun": 100000000 } } } } } } } }, "responses": { "200": { "description": "估算的 Gas Limit。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "description": "估算的 Gas Limit。Tron 链响应会额外返回 energy/bandwidth 字段，不适用的字段为 `null`。", "properties": { "gasLimit": { "type": "string", "example": "21000", "description": "估算的 Gas Limit（EVM）、compute-unit 上限（Solana）或 fee limit（Tron，单位 sun），整数字符串。" }, "energyRequired": { "type": "string", "nullable": true, "example": "15000", "description": "Tron 交易消耗的 energy（整数字符串）。非 Tron 链为 null。" }, "bandwidthRequired": { "type": "string", "nullable": true, "example": "268", "description": "Tron 交易消耗的 bandwidth（整数字符串）。非 Tron 链为 null。" }, "freeEnergy": { "type": "string", "nullable": true, "example": "14145", "description": "账户在 Tron 上可用的免费 energy（整数字符串）。非 Tron 链为 null。" }, "freeBandwidth": { "type": "string", "nullable": true, "example": "600", "description": "账户在 Tron 上可用的免费 bandwidth（整数字符串）。非 Tron 链为 null。" }, "energyFee": { "type": "string", "nullable": true, "example": "210", "description": "Tron 上 energy 的单价（sun/energy，整数字符串）。非 Tron 链为 null。" }, "bandwidthFee": { "type": "string", "nullable": true, "example": "1000", "description": "Tron 上 bandwidth 的单价（sun/byte，整数字符串）。非 Tron 链为 null。" } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/pre-transaction/simulate": { "post": { "summary": "模拟交易", "description": "在广播前对交易进行链下模拟，预测执行结果。 响应包含预测的执行状态、各账户/代币余额变化以及 ERC-20 授权变化（EVM 链）。\n根据 `binanceChainId` 提供 `evmTx`（EVM 链）、`solTx`（Solana 链）或 `tronTx`（Tron 链，\"CT_195\"）。Tron 链下 `allowanceChanges` 返回空数组。\n注意：本接口不支持 Metis 链（chainId 1088）。", "tags": ["Transaction API"], "operationId": "simulateTransactions", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/transaction-api#simulate-transactions" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TransactionApi/simulateTransactions.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Transaction/simulate_transactions.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/transaction/SimulateTransactionsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["binanceChainId", "evmTx", "solTx", "tronTx"], "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识（如 \"1\"=Ethereum，\"56\"=BSC，\"CT_501\"=Solana，\"CT_195\"=Tron）。 EVM 链提供 `evmTx`，Solana 链提供 `solTx`，Tron 链提供 `tronTx`，三者必须且只能提供其一。 注：`evmTx`、`solTx` 与 `tronTx` 在 schema 中均标记为 required，仅为渲染需要；实际调用时按 `binanceChainId` 三选一传入。" }, "evmTx": { "type": "object", "description": "EVM 交易体。`binanceChainId` 为 EVM 链时必填。", "required": ["from", "to", "value", "data"], "example": { "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "to": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "value": "0", "data": "0xa9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240" }, "properties": { "from": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发起方地址。" }, "to": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "接收方地址。" }, "value": { "type": "string", "example": "0", "description": "原生代币转账金额（wei，整数字符串）。" }, "data": { "type": "string", "example": "0xa9059cbb...", "description": "ABI 编码的 calldata（十六进制），可选。" } } }, "solTx": { "type": "object", "description": "Solana 交易体。`binanceChainId=CT_501` 时必填。", "required": ["base64Tx"], "example": { "base64Tx": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAECAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEAAA==" }, "properties": { "base64Tx": { "type": "string", "example": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAECAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEAAA==", "description": "Base64 编码的未签名 Solana 交易。" }, "address": { "type": "string", "example": "9Wzo3FQbtaJWQ7AsxLNMy5rgPVVQVGcG2v8CpfrChZNd", "description": "用于归属余额变化的 Solana 拥有者 / 付费方地址。" } } }, "tronTx": { "type": "object", "description": "Tron 交易体。`binanceChainId=CT_195` 时必填。", "required": ["from", "txType"], "properties": { "from": { "type": "string", "example": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8", "description": "发起方地址（base58check），同时用于归属余额变化。" }, "txType": { "type": "string", "enum": ["TRIGGER_SMART_CONTRACT", "TRANSFER_CONTRACT"], "example": "TRIGGER_SMART_CONTRACT", "description": "Tron 合约类型。`TRIGGER_SMART_CONTRACT` 需提供 `triggerSmartContractParams`；`TRANSFER_CONTRACT` 需提供 `transferContractParams`。" }, "triggerSmartContractParams": { "type": "object", "description": "当 `txType=TRIGGER_SMART_CONTRACT` 时必填。", "required": ["contractAddress", "data", "callValue"], "properties": { "contractAddress": { "type": "string", "example": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t", "description": "合约地址（base58check）。" }, "data": { "type": "string", "example": "a9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240", "description": "ABI 编码的 calldata（十六进制，无 `0x` 前缀）。" }, "callValue": { "type": "integer", "format": "int64", "example": 0, "description": "附带的 TRX 金额（单位 sun），对应 `call_value`。" }, "feeLimitSun": { "type": "integer", "format": "int64", "nullable": true, "example": 100000000, "description": "调用方愿意支付的最大费用（单位 sun），可选。未提供时使用服务端默认值。" } } }, "transferContractParams": { "type": "object", "description": "当 `txType=TRANSFER_CONTRACT` 时必填。", "required": ["toAddress", "amount"], "properties": { "toAddress": { "type": "string", "example": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8", "description": "接收方地址（base58check）。" }, "amount": { "type": "integer", "format": "int64", "minimum": 1, "example": 1000000, "description": "TRX 金额（单位 sun，1 TRX = 1_000_000 sun）。" } } } } } } }, "examples": { "evm": { "summary": "EVM 链（Ethereum ERC-20 转账）", "value": { "binanceChainId": "1", "evmTx": { "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "to": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "value": "0", "data": "0xa9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240" } } }, "solana": { "summary": "Solana 链", "value": { "binanceChainId": "CT_501", "solTx": { "base64Tx": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAECAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEAAA==" } } }, "tron": { "summary": "Tron 链（TRC-20 转账）", "value": { "binanceChainId": "CT_195", "tronTx": { "from": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8", "txType": "TRIGGER_SMART_CONTRACT", "triggerSmartContractParams": { "contractAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t", "data": "a9059cbb000000000000000000000000d8dA6BF26964aF9D7eEd9e03E53415D37aA960450000000000000000000000000000000000000000000000000000000000f4240", "callValue": 0, "feeLimitSun": 100000000 } } } } } } } }, "responses": { "200": { "description": "模拟结果。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "status": { "type": "string", "example": "SUCCESS", "description": "预测的执行状态。" }, "failReason": { "type": "string", "nullable": true, "example": "execution reverted: ERC20InsufficientBalance", "description": "当 `status=FAILED` 时返回失败原因，否则为 null。" }, "balanceChanges": { "type": "array", "description": "模拟交易中预测的余额变化。", "items": { "type": "object", "properties": { "contractAddress": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "代币合约地址。原生代币使用空值或链定义的标识。" }, "tokenType": { "type": "string", "example": "ERC20", "description": "代币标准。" }, "change": { "type": "string", "example": "-1000000", "description": "以代币最小单位表示的有符号变化（整数字符串）。负值代表流出，正值代表流入。" }, "owner": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发生余额变化的地址。" } } } }, "allowanceChanges": { "type": "array", "description": "预测的 ERC-20 授权变化（仅 EVM 链）。", "items": { "type": "object", "properties": { "tokenAddress": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "ERC-20 代币合约地址。" }, "owner": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "代币拥有者地址。" }, "spender": { "type": "string", "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "授权额度发生变化的 spender 地址。" }, "preAmount": { "type": "string", "example": "0", "description": "交易前的授权额度（最小单位，整数字符串）。" }, "postAmount": { "type": "string", "example": "1000000", "description": "交易后的授权额度（最小单位，整数字符串）。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/pre-transaction/broadcast-transaction": { "post": { "summary": "广播交易", "description": "通过 Binance Web3 API 中继将客户端已签名的交易广播到链上。返回 `txHash` 以及内部 `orderId`， 可用于通过 post-transaction 服务跟踪链上状态。\n可选的 MEV 保护（仅 EVM 链）会通过私有 mempool 转发交易，缓解抢跑与三明治攻击。 Tron 和 Solana 不支持 MEV 保护，该参数在这两条链上会被忽略。", "tags": ["Transaction API"], "operationId": "broadcastTransactions", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/transaction-api#broadcast-transactions" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TransactionApi/broadcastTransactions.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Transaction/broadcast_transactions.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/transaction/BroadcastTransactionsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["binanceChainId", "signedTransaction", "address"], "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识（如 \"1\"=Ethereum，\"56\"=BSC，\"CT_501\"=Solana，\"CT_195\"=Tron）。" }, "signedTransaction": { "type": "string", "example": "0xf86c808504a817c80082520894d8da6bf26964af9d7eed9e03e53415d37aa96045880de0b6b3a76400008025a0...", "description": "客户端签名后的原始交易。格式取决于 `binanceChainId`：\n\n- **EVM 链**：十六进制 RLP 交易（如 `0xf86c...`）。\n- **Solana（`CT_501`）**：base64 编码的已签名交易。\n- **Tron（`CT_195`）**：由 Tron 签名器返回的已签名交易 JSON\n 字符串，包含 `raw_data`（其中\n `contract[].parameter.value.owner_address`）与 `signature`\n 数组。示例：\n `{\"raw_data\":{\"contract\":[{\"type\":\"TriggerSmartContract\",\"parameter\":{\"value\":{\"owner_address\":\"T...\",\"contract_address\":\"T...\",\"data\":\"\",\"call_value\":0}}}]},\"signature\":[\"...\"]}`。\n\n\nTron 注意事项：`signedTransaction` **不是** `simulate` / `getGasLimit` 接口里 `tronTx.triggerSmartContractParams.data` 所传的 calldata hex。后端会从 `raw_data.contract[0].parameter.value.owner_address` 提取签名者 并与 `address` 校验一致；若误传 calldata hex 将被拒绝，返回 `code=40001, invalid signedTransaction: failed to parse Tron signedTransaction: syntax error`。" }, "address": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发起方钱包地址，用于状态归属和签名校验。Tron 和 Solana 上为大小写敏感的 base58check 地址。" }, "enableMevProtection": { "type": "boolean", "example": false, "description": "为 true 时通过私有 mempool 转发以启用 MEV 保护。" } } } } } }, "responses": { "200": { "description": "交易广播成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "orderId": { "type": "string", "example": "1812345678901234567", "description": "内部订单 ID。可通过 post-transaction 服务查询链上状态。" }, "txHash": { "type": "string", "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890", "description": "链上交易哈希。EVM 链返回十六进制哈希；Tron 返回 base58check 哈希；Solana 返回 base58 哈希。" } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/post-transaction/orders": { "get": { "summary": "查询广播订单", "description": "查询通过 `/pre-transaction/broadcast-transaction` 提交的广播订单。 支持按 `txStatus` 或 `orderId` 过滤，并通过 `cursor` 分页。", "tags": ["Transaction API"], "operationId": "getBroadcastOrders", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/transaction-api#get-broadcast-orders" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/TransactionApi/getBroadcastOrders.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Transaction/get_broadcast_orders.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/transaction/GetBroadcastOrdersExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "address", "in": "query", "required": true, "schema": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "description": "待查询的发起方钱包地址。" }, { "name": "binanceChainId", "in": "query", "required": true, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识。" }, { "name": "txStatus", "in": "query", "required": false, "schema": { "type": "string", "example": "success" }, "description": "可选的交易状态筛选（服务端定义字符串，如 \"pending\"、\"success\"、\"fail\"）。" }, { "name": "orderId", "in": "query", "required": false, "schema": { "type": "string", "example": "1812345678901234567" }, "description": "可选的内部订单 ID 筛选。" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "example": "eyJ0aW1lIjoxNzQ4NjAwMDAwMDAwLCJpZCI6MTIzfQ==" }, "description": "上次响应返回的分页游标。首次请求不传。" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 20, "default": 20 }, "description": "每页返回数量，默认 20。" } ], "responses": { "200": { "description": "成功返回订单列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "object", "properties": { "cursor": { "type": "string", "example": "eyJ0aW1lIjoxNzQ4NTk5MDAwMDAwLCJpZCI6Nzh9", "description": "下一页游标。无更多数据时为空字符串。" }, "orders": { "type": "array", "description": "订单列表。", "items": { "type": "object", "properties": { "orderId": { "type": "string", "example": "1812345678901234567", "description": "内部订单 ID。" }, "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "address": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发起方钱包地址。" }, "txHash": { "type": "string", "nullable": true, "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890", "description": "链上交易 Hash。订单 pending 时可能为 null。" }, "txStatus": { "type": "string", "example": "success", "description": "交易状态（服务端定义字符串）。" }, "failReason": { "type": "string", "nullable": true, "example": "execution reverted: insufficient liquidity", "description": "失败原因。交易失败时有值，否则为 null。" } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/balance/supported/chain": { "get": { "summary": "获取钱包支持的链", "description": "返回 Wallet 服务能够查询余额的区块链列表。支持链由服务端动态配置，可能随时变更。 传入 `binanceChainId` 仅返回该链信息；不传则返回全量列表。", "tags": ["Wallet API"], "operationId": "getWalletSupportedChains", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/wallet-api#get-wallet-supported-chains" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/WalletApi/getWalletSupportedChains.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Wallet/get_wallet_supported_chains.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/wallet/GetWalletSupportedChainsExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": false, "schema": { "type": "string", "example": "1" }, "description": "可选的链唯一标识。指定时仅返回对应链；不传则返回全量列表。" } ], "responses": { "200": { "description": "成功返回支持的链列表。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0, "description": "业务状态码，0 表示成功。" }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "支持的区块链网络列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "name": { "type": "string", "example": "Ethereum", "description": "链全称。" }, "shortName": { "type": "string", "example": "ETH", "description": "链简称。" }, "logoUrl": { "type": "string", "example": "https://onchainos.bnbstatic.com/image/admin_mgs_image_upload/20250228/b549e557-76ca-4873-88ef-3a107cf2c9fe.png", "description": "链 Logo 图片 URL。" } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/balance/all-token-balances-by-address": { "get": { "summary": "查询地址全部代币余额", "description": "返回地址在一个或多个链上的全部代币余额，支持分页。 将 `excludeRiskToken=true` 可过滤空投风险币与蜜罐币（蜜罐检测当前仅支持 ETH / BSC / SOL / BASE）。", "tags": ["Wallet API"], "operationId": "getAllTokenBalancesByAddress", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/wallet-api#get-all-token-balances-by-address" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/WalletApi/getAllTokenBalancesByAddress.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Wallet/get_all_token_balances_by_address.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/wallet/GetAllTokenBalancesByAddressExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "address", "in": "query", "required": false, "schema": { "type": "string", "example": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, "description": "待查询的钱包地址。" }, { "name": "chains", "in": "query", "required": false, "schema": { "type": "string", "example": "1,56" }, "description": "链 ID 列表，英文逗号分隔。" }, { "name": "excludeRiskToken", "in": "query", "required": false, "schema": { "type": "boolean", "example": true }, "description": "是否排除风险代币。" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1, "default": 1 }, "description": "页码，默认 1。" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 20, "default": 20, "minimum": 1, "maximum": 100 }, "description": "每页条数，范围 1–100，默认 20。" } ], "responses": { "200": { "description": "成功返回代币余额。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "每个查询链对应一条记录，包含该链上分页后的代币余额列表。", "items": { "type": "object", "properties": { "page": { "type": "integer", "format": "int64", "example": 1, "description": "当前页码。" }, "pageSize": { "type": "integer", "format": "int32", "example": 20, "description": "每页条数。" }, "tokenAssets": { "type": "array", "description": "该链上的代币余额列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599", "description": "代币合约地址。原生币为空字符串。" }, "address": { "type": "string", "example": "0xed0c6079229e2d407672a117c22b62064f4a4312", "description": "钱包地址，回显请求值。" }, "symbol": { "type": "string", "example": "WBTC", "description": "代币简称（ticker）。" }, "balance": { "type": "string", "example": "329.10055205", "description": "已按精度换算的代币数量。" }, "rawBalance": { "type": "string", "example": "32910055205", "description": "未换算精度的原始数量。部分链不支持时返回空字符串。" }, "tokenPrice": { "type": "string", "example": "98847.8", "description": "代币美元单价。" }, "isRiskToken": { "type": "boolean", "example": false, "description": "是否为风险代币。" } } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/balance/token-balances-by-address": { "post": { "summary": "查询地址特定代币余额", "description": "查询指定 (链, 合约) 列表的代币余额，单次请求最多 20 条。 `excludeRiskToken=\"0\"` 过滤风险代币（默认），`\"1\"` 不过滤。", "tags": ["Wallet API"], "operationId": "getTokenBalancesByAddress", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/wallet-api#get-token-balances-by-address" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/WalletApi/getTokenBalancesByAddress.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Wallet/get_token_balances_by_address.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/wallet/GetTokenBalancesByAddressExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } } ], "requestBody": { "required": true, "description": "代币余额查询请求体。", "content": { "application/json": { "schema": { "type": "object", "required": ["address", "tokenContractAddresses"], "properties": { "address": { "type": "string", "example": "0x50c476a139aab23fdaf9bca12614cdd54a4244e3", "description": "钱包地址。" }, "tokenContractAddresses": { "type": "array", "maxItems": 20, "description": "要查询的代币列表，最多 20 条。", "items": { "type": "object", "required": ["binanceChainId", "tokenContractAddress"], "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599", "description": "代币合约地址。原生币传空字符串 \"\"。" } } } }, "excludeRiskToken": { "type": "string", "example": "0", "default": "0", "enum": ["0", "1"], "description": "风险代币筛选。\"0\"=过滤（默认），\"1\"=不过滤。蜜罐检测当前仅支持 ETH / BSC / SOL / BASE。" } } } } } }, "responses": { "200": { "description": "成功返回代币余额。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "每条对应请求中出现过的一个链，包含匹配到的代币余额。", "items": { "type": "object", "properties": { "tokenAssets": { "type": "array", "description": "该链上匹配到的代币余额列表。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "tokenContractAddress": { "type": "string", "example": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599", "description": "代币合约地址。原生币为空字符串。" }, "address": { "type": "string", "example": "0x50c476a139aab23fdaf9bca12614cdd54a4244e3", "description": "钱包地址，回显请求值。" }, "symbol": { "type": "string", "example": "WBTC", "description": "代币简称（ticker）。" }, "balance": { "type": "string", "example": "329.10055205", "description": "已按精度换算的代币数量。" }, "rawBalance": { "type": "string", "example": "32910055205", "description": "未换算精度的原始数量。部分链不支持时返回空字符串。" }, "tokenPrice": { "type": "string", "example": "98847.8", "description": "代币美元单价。" }, "isRiskToken": { "type": "boolean", "example": false, "description": "是否为风险代币。" } } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "201": { "description": "已创建。" }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/post-transaction/transactions-by-address": { "get": { "summary": "查询地址链上交易历史", "description": "返回钱包地址在指定链上的交易历史。仅返回最近 6 个月的记录，按时间倒序排列。 支持游标分页、时间范围筛选和代币合约筛选。", "tags": ["Wallet API"], "operationId": "getTransactionsByAddress", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/wallet-api#get-transactions-by-address" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/WalletApi/getTransactionsByAddress.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Wallet/get_transactions_by_address.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/wallet/GetTransactionsByAddressExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "address", "in": "query", "required": true, "schema": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "description": "待查询的钱包地址。" }, { "name": "chains", "in": "query", "required": true, "schema": { "type": "string", "example": "1,56" }, "description": "链 ID 列表，英文逗号分隔。" }, { "name": "tokenContractAddress", "in": "query", "required": false, "schema": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7" }, "description": "可选的代币合约地址筛选。" }, { "name": "begin", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1746000000000 }, "description": "起始时间戳（Unix 毫秒，包含）。" }, { "name": "end", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1748601600000 }, "description": "截止时间戳（Unix 毫秒，包含）。" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "example": "eyJ0aW1lIjoxNzQ4NjAwMDAwMDAwLCJpZCI6MTIzfQ==" }, "description": "上次响应返回的分页游标。" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "example": 20, "default": 20, "minimum": 1, "maximum": 100 }, "description": "每页返回数量，范围 1–100，默认 20。" } ], "responses": { "200": { "description": "成功返回交易历史。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "每条对应一个链。每条包含该链的交易列表与独立分页游标。", "items": { "type": "object", "properties": { "cursor": { "type": "string", "example": "eyJ0aW1lIjoxNzQ4NTk5MDAwMDAwLCJpZCI6Nzh9", "description": "该链下一页游标。无更多数据时为空字符串。" }, "transactionList": { "type": "array", "description": "交易历史列表，按时间倒序排列。", "items": { "type": "object", "properties": { "binanceChainId": { "type": "string", "example": "1", "description": "链唯一标识。" }, "txHash": { "type": "string", "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890", "description": "交易 Hash。" }, "itype": { "type": "string", "example": "0", "enum": ["0", "1", "2"], "description": "交易层级类型。\"0\"=外层原生币转账，\"1\"=内部合约原生币转账，\"2\"=Token 转账。" }, "methodId": { "type": "string", "nullable": true, "example": "0xa9059cbb", "description": "合约调用函数方法 ID。原生币转账时为 null。" }, "nonce": { "type": "string", "example": "42", "description": "发送方地址的 nonce。" }, "txTime": { "type": "string", "example": "1748601600000", "description": "交易时间（Unix 毫秒，字符串形式）。" }, "from": { "type": "array", "description": "交易输入（发送方地址与金额）。", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发送方地址；多签交易以英文逗号分隔。" }, "amount": { "type": "string", "example": "1500000", "description": "输入金额（最小单位，十进制字符串）。" } } } }, "to": { "type": "array", "description": "交易输出（接收方地址与金额）。", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "接收方地址；多签交易以英文逗号分隔。" }, "amount": { "type": "string", "example": "1500000", "description": "输出金额。" } } } }, "tokenContractAddress": { "type": "string", "nullable": true, "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "Token 合约地址。原生币转账时为 null。" }, "amount": { "type": "string", "example": "1500000", "description": "交易金额（最小单位）。" }, "symbol": { "type": "string", "example": "USDT", "description": "交易金额对应的币种符号。" }, "txFee": { "type": "string", "example": "0.000125", "description": "交易手续费（原生代币数量，十进制字符串）。" }, "txStatus": { "type": "string", "example": "success", "enum": ["success", "fail", "pending"], "description": "交易状态。" }, "hitBlacklist": { "type": "boolean", "nullable": true, "example": false, "description": "是否命中黑名单。" } } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } }, "/api/v1/dex/post-transaction/transaction-detail-by-txhash": { "get": { "summary": "根据 Hash 查询交易详情", "description": "根据 `binanceChainId` 与 `txHash` 查询链上交易详情，返回交易的输入、输出、内部调用与代币转账明细。", "tags": ["Wallet API"], "operationId": "getTransactionDetailByHash", "externalDocs": { "url": "https://web3.binance.com/en/dev-docs/catalog/web3-wallet/api/rest-api/wallet-api#get-transaction-detail-by-hash" }, "x-connectors-examples": { "ts": "https://raw.githubusercontent.com/binance/binance-web3-connector-js/master/clients/web3-wallet/examples/rest-api/WalletApi/getTransactionDetailByHash.ts", "python": "https://raw.githubusercontent.com/binance/binance-web3-connector-python/master/clients/web3-wallet/examples/rest_api/Wallet/get_transaction_detail_by_hash.py", "java": "https://raw.githubusercontent.com/binance/binance-web3-connector-java/master/examples/web3-wallet/src/main/java/com/binance/connector/client/web3_wallet/rest/wallet/GetTransactionDetailByHashExample.java" }, "x-signed": true, "parameters": [ { "name": "X-OC-APIKEY", "in": "header", "required": true, "description": "Binance Web3 API 颁发的用于鉴权的 API Key。", "schema": { "type": "string", "example": "your-api-key-here" } }, { "name": "X-OC-TIMESTAMP", "in": "header", "required": true, "description": "当前 UTC 时间，ISO 8601 格式，精确到毫秒，例如 2026-05-11T10:08:57.715Z。", "schema": { "type": "string", "example": "2026-05-11T10:08:57.715Z" } }, { "name": "X-OC-SIGN", "in": "header", "required": true, "description": "请求签名（Base64 编码）。", "schema": { "type": "string", "example": "Base64EncodedSignature==" } }, { "name": "X-OC-RECV-WINDOW", "in": "header", "required": false, "description": "允许的时间偏差（毫秒），默认值 5000，最大值 60000。", "schema": { "type": "integer", "format": "int64", "example": 5000 } }, { "name": "X-OC-NONCE", "in": "header", "required": false, "description": "唯一请求标识符，用于防重放攻击；省略时使用 X-OC-SIGN 代替。", "schema": { "type": "string", "example": "unique-nonce-string" } }, { "name": "binanceChainId", "in": "query", "required": false, "schema": { "type": "string", "example": "1" }, "description": "链唯一标识。" }, { "name": "txHash", "in": "query", "required": false, "schema": { "type": "string", "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890" }, "description": "链上交易 Hash。" }, { "name": "itype", "in": "query", "required": false, "schema": { "type": "string", "example": "0" }, "description": "交易类型筛选（部分 UTXO 链）。保留参数，当前暂不生效。取值：\"0\"=外层原生币，\"1\"=内部合约原生币，\"2\"=Token 转账。" } ], "responses": { "200": { "description": "成功返回交易详情。", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 0 }, "msg": { "type": "string", "example": "success" }, "data": { "type": "array", "description": "交易详情列表。未找到时为空列表。", "items": { "type": "object", "properties": { "chainIndex": { "type": "string", "example": "1", "description": "链唯一标识。" }, "height": { "type": "string", "example": "39812345", "description": "交易所在的区块高度。" }, "txTime": { "type": "string", "example": "1748601600000", "description": "交易时间（Unix 毫秒，字符串形式）。" }, "txhash": { "type": "string", "example": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890", "description": "交易 Hash。" }, "txStatus": { "type": "string", "example": "success", "enum": ["success", "fail", "pending"], "description": "交易状态，取值为 \"success\"、\"fail\"、\"pending\" 之一。" }, "gasLimit": { "type": "string", "nullable": true, "example": "200000", "description": "Gas 上限（十进制字符串）。" }, "gasUsed": { "type": "string", "nullable": true, "example": "150000", "description": "已消耗 Gas。" }, "gasPrice": { "type": "string", "nullable": true, "example": "5000000000", "description": "Gas 价格（wei，十进制字符串）。" }, "txFee": { "type": "string", "example": "0.000750", "description": "交易手续费。" }, "nonce": { "type": "string", "example": "42", "description": "Nonce。" }, "amount": { "type": "string", "example": "1500000", "description": "交易金额。" }, "symbol": { "type": "string", "example": "USDT", "description": "交易金额对应的币种符号。" }, "methodId": { "type": "string", "nullable": true, "example": "0xa9059cbb", "description": "合约调用函数方法 ID。原生币转账时为 null。" }, "l1OriginHash": { "type": "string", "nullable": true, "example": "0xdef456...", "description": "L1 执行交易哈希（Rollup / L2 场景）。其他情况下为 null。" }, "fromDetails": { "type": "array", "description": "交易输入详情。", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发送方 / 输入地址。" }, "vinIndex": { "type": "string", "nullable": true, "example": "0", "description": "当前交易输入索引（UTXO 链）。" }, "preVoutIndex": { "type": "string", "nullable": true, "example": "1", "description": "关联的前一笔输出索引（UTXO 链）。" }, "txHash": { "type": "string", "nullable": true, "example": "0xpreabc...", "description": "前一笔交易哈希（UTXO 链与 `preVoutIndex` 共同定位输入 UTXO）。" }, "isContract": { "type": "boolean", "nullable": true, "example": false, "description": "发送方地址是否为合约地址。" }, "amount": { "type": "string", "example": "1500000", "description": "交易金额。" } } } }, "toDetails": { "type": "array", "description": "交易输出详情。", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "接收方 / 输出地址。" }, "voutIndex": { "type": "string", "nullable": true, "example": "0", "description": "输出索引（UTXO 链）。" }, "isContract": { "type": "boolean", "nullable": true, "example": true, "description": "接收方地址是否为合约地址。" }, "amount": { "type": "string", "example": "1500000", "description": "交易金额。" } } } }, "internalTransactionDetails": { "type": "array", "description": "内部交易详情。", "items": { "type": "object", "properties": { "from": { "type": "string", "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "发送方地址。" }, "to": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "接收方地址。" }, "isFromContract": { "type": "boolean", "nullable": true, "example": true, "description": "发送方是否为合约地址。" }, "isToContract": { "type": "boolean", "nullable": true, "example": false, "description": "接收方是否为合约地址。" }, "amount": { "type": "string", "example": "100000", "description": "交易金额。" }, "txStatus": { "type": "string", "example": "success", "description": "内部调用状态。" } } } }, "tokenTransferDetails": { "type": "array", "description": "Token 转账详情。", "items": { "type": "object", "properties": { "from": { "type": "string", "example": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "description": "发送方地址。" }, "to": { "type": "string", "example": "0x1111111254EEB25477B68fb85Ed929f73A960582", "description": "接收方地址。" }, "isFromContract": { "type": "boolean", "nullable": true, "example": false, "description": "发送方是否为合约地址。" }, "isToContract": { "type": "boolean", "nullable": true, "example": true, "description": "接收方是否为合约地址。" }, "tokenContractAddress": { "type": "string", "example": "0xdAC17F958D2ee523a2206206994597C13D831ec7", "description": "Token 合约地址。" }, "symbol": { "type": "string", "example": "USDT", "description": "Token 符号。" }, "amount": { "type": "string", "example": "1500000", "description": "转账金额（最小单位，十进制字符串）。" } } } } } } }, "timestamp": { "type": "integer", "format": "int64", "example": 1748601600000 }, "success": { "type": "boolean", "example": true } } } } } }, "401": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "403": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "404": { "description": "未找到。请求的资源或接口不存在。" } } } } }, "components": { "responses": { "Created": { "description": "已创建。" }, "Unauthorized": { "description": "未授权。请求缺少 API Key 或包含无效的 API Key。" }, "Forbidden": { "description": "禁止访问。该 API Key 没有访问此接口的权限。" }, "NotFound": { "description": "未找到。请求的资源或接口不存在。" } } }, "x-tagGroups": [ { "name": "行情 API", "x-displayName-cn": "行情 API", "tags": ["General Data", "Address Portfolio", "RWA Data"] } ] }