Binance Proxy API 3.1.38 ------------------------ This server provides unified access to Binance market data. To request data, you must build the URL correctly. ============================================================ 1. REQUEST BUILDER (GENERAL RULES) ============================================================ FULL TEMPLATE https://binance2.api-proxy.ai/v1/{FUNCTION}?instrument={INSTRUMENT}&timeFrame={TIMEFRAME}&contractType={CONTRACT_TYPE}&expiration={EXPIRATION}&startTime={START_TIME}&endTime={END_TIME}&limit={LIMIT}&page={PAGE}&page_size={PAGE_SIZE}&format={FORMAT}&mode={MODE}&x={X} CONVENTION * All parameter names are written in CAPS and shown in braces (e.g., {TIMEFRAME}, {LIMIT}). BEST PRACTICE * Always include {MODE} and {FORMAT} explicitly to avoid environment-specific quirks. ------------------------------------------------------------ REQUIRED ------------------------------------------------------------ {FUNCTION} * Endpoint name (e.g., KLINES, USDM_KLINES, COINM_MARK_PRICE_KLINES, EAPI_OPEN_INTEREST). * See Part 2 (Function Reference) for per-endpoint specifics. {INSTRUMENT} * IMPORTANT: Only instruments listed at /instrument are supported. * Format: BASE-QUOTE (e.g., BTC-USDT). Use ASCII hyphen “-”. * Always check /instrument before sending a request. * If the instrument is not listed, the server returns: “Binance API does not support this instrument (pair/symbol)”. * Some endpoints may accept a single asset or a symbol list — see Part 2. ------------------------------------------------------------ OPTIONAL (UNIVERSAL) ------------------------------------------------------------ {TIMEFRAME} * Universal time parameter for all time-based endpoints. * Brief note: Spot supports 1s; derivatives/options support 1m–1M. Full mapping and details in §4 (SERVER DEFAULTS & BEHAVIOR). {LIMIT} * Number of records (defaults and maximums are endpoint-specific; e.g., KLINES default=500 on spot). {PAGE} * Page number (default usually 1). {PAGE_SIZE} * Records per page (default usually 250; max usually 1000). {FORMAT} * txt, json, html, pre, csv. {MODE} * agent or direct. {X} * Access parameter. If ACCESS file says NO CODE — omit {X}. If {X} is present, the entire query string must be percent-encoded (see §2, STEP 3). ------------------------------------------------------------ OPTIONAL (ENDPOINT-SPECIFIC) ------------------------------------------------------------ {CONTRACT_TYPE} — PERPETUAL, CURRENT_QUARTER, NEXT_QUARTER (derivatives only). {EXPIRATION} — YYYYMMDD (options only). {START_TIME}, {END_TIME} — timestamps in ms (historical range). ============================================================ SUPPORTED INSTRUMENTS For a dynamic list of all supported instruments (trading pairs) by market type, visit the /instrument page. 2. REQUEST ALGORITHM (STEP-BY-STEP) ============================================================ STEP 0 — PICK ENDPOINT * In Part 2, find the endpoint and check its required/optional params, valid TIMEFRAMEs, and LIMITs. STEP 1 — BUILD PLAIN QUERY STRING * Start with /v1/{FUNCTION}. Add required params (usually {INSTRUMENT}; add {TIMEFRAME} only if required by that endpoint). * Add optional params as needed ({LIMIT}, {PAGE}, {PAGE_SIZE}, {START_TIME}, {END_TIME}, {CONTRACT_TYPE}, {EXPIRATION}, {FORMAT}, {MODE}). * This string is NOT encoded yet. STEP 2 — ADD {X} (IF AVAILABLE) * Append {X}=YOUR_CODE to the same plain query string (skip if the access file says NO CODE). STEP 3 — ENCODE WHEN NEEDED * Percent-encode the ENTIRE query string only if {X} is present or if you must use the encoded form: ? → %3F, & → %26, = → %3D, - → %2D (hyphen inside {INSTRUMENT}) * Attach the encoded string directly after /v1/{FUNCTION} (no literal “?”). STEP 4 — SEND THE REQUEST * Use the final URL. Control pagination via {PAGE} and {PAGE_SIZE} if supported. ============================================================ 3. EXAMPLES (ONE FUNCTION: {FUNCTION}=KLINES) ============================================================ A) AGENT defaults (FORMAT=TXT), no {X}: /v1/klines?INSTRUMENT=BTC-USDT&TIMEFRAME=1m B) AGENT with {FORMAT}=JSON, no {X}: /v1/klines?INSTRUMENT=BTC-USDT&TIMEFRAME=1m&FORMAT=JSON C) DIRECT defaults (FORMAT=PRE), no {X}: /v1/klines?INSTRUMENT=BTC-USDT&TIMEFRAME=1m&MODE=DIRECT D) AGENT with {X} (encoded): /v1/klines%3FINSTRUMENT%3DBTC%2DUSDT%26TIMEFRAME%3D1m%26X%3DYOUR_CODE E) DIRECT with {X} (encoded): /v1/klines%3FINSTRUMENT%3DBTC%2DUSDT%26TIMEFRAME%3D1m%26MODE%3DDIRECT%26X%3DYOUR_CODE F) DIRECT with {FORMAT}=CSV and pagination, no {X}: /v1/klines?INSTRUMENT=BTC-USDT&TIMEFRAME=1m&MODE=DIRECT&FORMAT=CSV&LIMIT=500&PAGE=2&PAGE_SIZE=250 ============================================================ 4. SERVER DEFAULTS & BEHAVIOR ============================================================ UNIFIED PARAMETERS (Canonical & Synonyms) * instrument — canonical trading pair in BASE-QUOTE (e.g., BTC-USDT). Synonyms: symbol, pair. Hyphen “-” must be ASCII; single-hyphen pairs (BTC-USDT) are converted upstream to “BTCUSDT”; multi-hyphen options (e.g., BTC-240927-50000-C) pass through unchanged. * timeFrame — canonical universal time parameter; internally mapped as: – interval for candlesticks (klines, continuousKlines, indexPriceKlines, etc.) – period for statistical endpoints (openInterestHist, longShortRatio, basis, etc.) – windowSize for rolling tickers. Synonyms: timeframe, time_frame, interval, period, windowSize. Allowed (candles, spot): 1s, 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M. Allowed (candles, derivatives/options): 1m–1M. * expiration — canonical (YYYYMMDD). Synonyms: expiry, exp. * startTime, endTime — canonical in ms. Synonyms: start_time, end_time. * limit — case-insensitive; accepts “limit”/“LIMIT”. SUMMARY (quick mapping) Function type | Accepts (unified) -> Upstream | Examples --------------------------+------------------------------------+---------------+----------------------- Candlesticks (klines) | timeFrame / interval / tf -> interval | 1s (spot), 1m–1M Statistics (ratios, OI) | timeFrame / period / window -> period | 5m, 15m, 30m, 1h, 1d Rolling ticker | timeFrame / windowSize / window -> windowSize | 1m–7d (default 1d) INSTRUMENT VERIFICATION * Every request validates instrument against /instrument. * If not listed → “unsupported instrument” error. * If listed but data unavailable (e.g., outage/no history) → return data error (not “unsupported”). FORMATS & MODES (defaults and rules) * agent mode → default format=txt; response wrapped in {ok, function, data, paging, meta}. * direct mode → default format=pre; returns raw upstream payload. * Allowed formats: txt, json, html, pre, csv. * CSV is pure only in direct; in agent it’s wrapped into JSON. ENCODING * If {X} is present → percent-encode the entire query string. * On some endpoints (e.g., klines, rolling tickers), using synonym params may require encoding to avoid “missing parameter” errors; solution: use canonical params or percent-encode the query. PAGINATION * page ≥ 1; page_size ≤ 1000 (endpoint defaults apply). * JSON responses include navigation in META; txt/html/pre/csv include pagination notes in the body. RATE LIMITS * The proxy adheres to Binance rate limits. Excessive request weight may result in HTTP 418 (temporary ban). DEPRECATED/UNAVAILABLE * Certain legacy names (e.g., usdm_mark_price) are not implemented; use /test to see the current list of supported functions. MARKET SPECIFICS * COIN-M futures use USD as quote (e.g., BTC-USD). * USDⓈ-M futures use USDT (e.g., BTC-USDT). * Mixing formats leads to “unsupported instrument”. Part 2 – Function Reference (Full Parameter Lists + Minimal Examples) All examples below are plain (NOT percent-encoded) and include ONLY REQUIRED parameters for each endpoint. For access/encoding rules, see Part 1 (Request Algorithm). --- Function: klines Description: Spot klines (OHLCV) Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1s, 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/klines?instrument=BTC-USDT&timeFrame=1m --- Function: spot_ui_klines Description: Spot UI klines Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1s, 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_ui_klines?instrument=BTC-USDT&timeFrame=1m --- Function: spot_avg_price Description: Spot current average price (5m rolling) Parameters: * INSTRUMENT; type=str; required * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_avg_price?instrument=BTC-USDT --- Function: spot_ticker_price Description: Spot latest price (single or multiple symbols) Parameters: * INSTRUMENT; type=str; optional * SYMBOLS; type=list[str]; optional; comma-separated list of instruments * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_ticker_price --- Function: spot_ticker_24h Description: Spot 24-hour ticker statistics (single or multiple symbols) Parameters: * INSTRUMENT; type=str; optional * SYMBOLS; type=list[str]; optional * TYPE; type=str; optional; allowed=MINI, FULL; default=FULL * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_ticker_24h --- Function: spot_book_ticker Description: Spot order-book best bid/ask (single or multiple symbols) Parameters: * INSTRUMENT; type=str; optional * SYMBOLS; type=list[str]; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_book_ticker --- Function: spot_depth Description: Spot order book depth Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; default=100; min=1; max=5000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_depth?instrument=BTC-USDT --- Function: spot_agg_trades Description: Spot aggregated (compressed) trades Parameters: * INSTRUMENT; type=str; required * FROMID; type=int; optional; min=0 * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_agg_trades?instrument=BTC-USDT --- Function: spot_trades Description: Spot recent trades list Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_trades?instrument=BTC-USDT --- Function: spot_historical_trades Description: Spot historical trades list Parameters: * INSTRUMENT; type=str; required * FROMID; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/spot_historical_trades?instrument=BTC-USDT --- Function: spot_ticker_rolling Description: Spot rolling-window price change statistics Parameters: * INSTRUMENT; type=str; optional * SYMBOLS; type=list[str]; optional * TIMEFRAME; type=str; optional; allowed=1m–7d; default=1d * TYPE; type=str; optional; allowed=MINI, FULL; default=FULL * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Note: either INSTRUMENT or SYMBOLS must be provided. Minimal example: /v1/spot_ticker_rolling?instrument=BTC-USDT --- Function: usdm_klines Description: USDⓈ-M klines (OHLCV) Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_klines?instrument=BTC-USDT&timeFrame=1m --- Function: usdm_continuous_klines Description: USDⓈ-M continuous contract klines Parameters: * INSTRUMENT; type=str; required * CONTRACT_TYPE; type=str; required; allowed=PERPETUAL, CURRENT_QUARTER, NEXT_QUARTER * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_continuous_klines?instrument=BTC-USDT&contractType=PERPETUAL&timeFrame=1m --- Function: usdm_index_price_klines Description: USDⓈ-M index price klines Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_index_price_klines?instrument=BTC-USDT&timeFrame=1m --- Function: usdm_mark_price_klines Description: USDⓈ-M mark price klines Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_mark_price_klines?instrument=BTC-USDT&timeFrame=1m --- Function: usdm_premium_index_klines Description: USDⓈ-M premium index klines Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_premium_index_klines?instrument=BTC-USDT&timeFrame=1m --- Function: usdm_premium_index Description: USDⓈ-M premium index (mark, index price & funding snapshot) Parameters: * INSTRUMENT; type=str; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_premium_index --- Function: usdm_funding_rate Description: USDⓈ-M funding rate history Parameters: * INSTRUMENT; type=str; optional * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=100; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_funding_rate --- Function: usdm_funding_info Description: USDⓈ-M funding info (cap/floor/interval) Parameters: * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_funding_info --- Function: usdm_ticker_price Description: USDⓈ-M latest price (single or multiple symbols) Parameters: * INSTRUMENT; type=str; optional * SYMBOLS; type=list[str]; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_ticker_price --- Function: usdm_book_ticker Description: USDⓈ-M order-book best bid/ask (single or multiple symbols) Parameters: * INSTRUMENT; type=str; optional * SYMBOLS; type=list[str]; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_book_ticker --- Function: usdm_open_interest Description: USDⓈ-M current open interest Parameters: * INSTRUMENT; type=str; required * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_open_interest?instrument=BTC-USDT --- Function: usdm_trades Description: USDⓈ-M recent trades list Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_trades?instrument=BTC-USDT --- Function: usdm_historical_trades Description: USDⓈ-M historical trades list Parameters: * INSTRUMENT; type=str; required * FROMID; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_historical_trades?instrument=BTC-USDT --- Function: usdm_open_interest_hist Description: USDⓈ-M open interest history (last 30 days) Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_open_interest_hist?instrument=BTC-USDT&timeFrame=5m --- Function: usdm_top_long_short_position_ratio Description: USDⓈ-M top trader long/short position ratio Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_top_long_short_position_ratio?instrument=BTC-USDT&timeFrame=5m --- Function: usdm_top_long_short_account_ratio Description: USDⓈ-M top trader long/short account ratio Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_top_long_short_account_ratio?instrument=BTC-USDT&timeFrame=5m --- Function: usdm_global_long_short_account_ratio Description: USDⓈ-M global long/short account ratio (taker ratio) Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_global_long_short_account_ratio?instrument=BTC-USDT&timeFrame=5m --- Function: usdm_taker_long_short_ratio Description: USDⓈ-M taker buy/sell volume ratio Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_taker_long_short_ratio?instrument=BTC-USDT&timeFrame=5m --- Function: usdm_basis Description: USDⓈ-M basis (spread) and annualised basis Parameters: * INSTRUMENT; type=str; required * CONTRACT_TYPE; type=str; required; allowed=PERPETUAL, CURRENT_QUARTER, NEXT_QUARTER * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_basis?instrument=BTC-USDT&contractType=PERPETUAL&timeFrame=5m --- Function: usdm_index_info Description: USDⓈ-M composite index symbol information Parameters: * INSTRUMENT; type=str; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_index_info --- Function: usdm_asset_index Description: USDⓈ-M multi-asset mode index constituents Parameters: * INSTRUMENT; type=str; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_asset_index --- Function: usdm_depth Description: USDⓈ-M futures order book depth Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; allowed=5, 10, 20, 50, 100, 500, 1000; default=100 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/usdm_depth?instrument=BTC-USDT --- Function: coinm_klines Description: COIN-M klines (OHLCV) Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_klines?instrument=BTC-USDT&timeFrame=1m --- Function: coinm_continuous_klines Description: COIN-M continuous contract klines Parameters: * INSTRUMENT; type=str; required * CONTRACT_TYPE; type=str; required; allowed=PERPETUAL, CURRENT_QUARTER, NEXT_QUARTER * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_continuous_klines?instrument=BTC-USDT&contractType=PERPETUAL&timeFrame=1m --- Function: coinm_index_price_klines Description: COIN-M index price klines Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_index_price_klines?instrument=BTC-USDT&timeFrame=1m --- Function: coinm_mark_price_klines Description: COIN-M mark price klines Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_mark_price_klines?instrument=BTC-USDT&timeFrame=1m --- Function: coinm_open_interest_hist Description: COIN-M open interest history (last 30 days) Parameters: * INSTRUMENT; type=str; required * CONTRACT_TYPE; type=str; required; allowed=PERPETUAL, CURRENT_QUARTER, NEXT_QUARTER * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_open_interest_hist?instrument=BTC-USDT&contractType=PERPETUAL&timeFrame=5m --- Function: coinm_top_long_short_position_ratio Description: COIN-M top trader long/short position ratio Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_top_long_short_position_ratio?instrument=BTC-USDT&timeFrame=5m --- Function: coinm_top_long_short_account_ratio Description: COIN-M top trader long/short account ratio Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_top_long_short_account_ratio?instrument=BTC-USDT&timeFrame=5m --- Function: coinm_global_long_short_account_ratio Description: COIN-M global long/short account ratio Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_global_long_short_account_ratio?instrument=BTC-USDT&timeFrame=5m --- Function: coinm_basis Description: COIN-M basis (spread) and annualised basis Parameters: * INSTRUMENT; type=str; required * CONTRACT_TYPE; type=str; required; allowed=PERPETUAL, CURRENT_QUARTER, NEXT_QUARTER * TIMEFRAME; type=str; required; allowed=5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=30; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_basis?instrument=BTC-USDT&contractType=PERPETUAL&timeFrame=5m --- Function: coinm_trades Description: COIN-M recent trades list Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_trades?instrument=BTC-USDT --- Function: coinm_historical_trades Description: COIN-M historical trades list Parameters: * INSTRUMENT; type=str; required * FROMID; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1000 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_historical_trades?instrument=BTC-USDT --- Function: coinm_depth Description: COIN-M futures order book depth Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; allowed=5, 10, 20, 50, 100, 500, 1000; default=100 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/coinm_depth?instrument=BTC-USDT --- Function: eapi_klines Description: Options (EAPI) klines (OHLCV) Parameters: * INSTRUMENT; type=str; required * TIMEFRAME; type=str; required; allowed=1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M * START_TIME; type=int; optional; min=0 * END_TIME; type=int; optional; min=0 * LIMIT; type=int; optional; default=500; min=1; max=1500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/eapi_klines?instrument=BTC-USDT&timeFrame=1m --- Function: eapi_mark Description: Options mark price, implied volatility and Greeks Parameters: * INSTRUMENT; type=str; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/eapi_mark --- Function: eapi_ticker Description: Options 24h ticker Parameters: * INSTRUMENT; type=str; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/eapi_ticker --- Function: eapi_index Description: Options underlying spot index price Parameters: * INSTRUMENT; type=str; required * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/eapi_index?instrument=BTC-USDT --- Function: eapi_depth Description: Options order book depth Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; allowed=10, 20, 50, 100, 500, 1000; default=100 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/eapi_depth?instrument=BTC-USDT --- Function: eapi_trades Description: Options recent trades Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; default=100; min=1; max=500 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/eapi_trades?instrument=BTC-USDT --- Function: eapi_historical_trades Description: Options historical trades Parameters: * INSTRUMENT; type=str; required * LIMIT; type=int; optional; default=100; min=1; max=500 * FROMID; type=int; optional; min=0 * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/eapi_historical_trades?instrument=BTC-USDT --- Function: eapi_open_interest Description: Options open interest for underlying on a specific expiration Parameters: * INSTRUMENT; type=str; required * EXPIRATION; type=str; required; format=YYYYMMDD * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/eapi_open_interest?instrument=BTC-USDT&expiration=20250101 --- Function: exchange_info_spot Description: Spot exchangeInfo (symbols, filters, rateLimits) Parameters: * INSTRUMENT; type=str; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/exchange_info_spot --- Function: exchange_info_usdm Description: USDⓈ-M exchangeInfo (symbols, filters, rateLimits) Parameters: * INSTRUMENT; type=str; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/exchange_info_usdm --- Function: exchange_info_coinm Description: COIN-M exchangeInfo (symbols, filters, rateLimits) Parameters: * INSTRUMENT; type=str; optional * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/exchange_info_coinm --- Function: exchange_info_eapi Description: EAPI exchangeInfo (symbols, filters, rateLimits) Parameters: * PAGE; type=int; optional; default=1; min=1 * PAGE_SIZE; type=int; optional; default=250; min=1; max=1000 * FORMAT; type=str; optional; allowed=txt, pre, json, html, csv; default=txt * MODE; type=str; optional; allowed=agent, direct; default=agent * X; type=str; optional Minimal example: /v1/exchange_info_eapi