/binance/symbols/search

POST /api/binance/symbols/search

Price: 5 credits

List and filter the catalog of trading pairs and their trading rules

How to use it

Browse the Binance spot trading-pair catalog. Returns trading pairs with their status, base and quote assets and precisions, allowed order types, permissions, and the full set of trading filters. Narrow the catalog with optional filters: base_asset (e.g. 'BTC'), quote_asset (e.g. 'USDT'), trading status, and supported permission (e.g. 'SPOT', 'MARGIN', 'LEVERAGED'). Use this to discover which pairs exist and how each one trades.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Number of trading pairs to return (min: 1)
• base_asset string nullable — Filter by base asset, e.g. 'BTC', 'ETH' (examples: "BTC", "ETH")
• quote_asset string nullable — Filter by quote asset, e.g. 'USDT', 'BTC' (examples: "USDT", "BTC")
• status string nullable — Filter by trading status (one of: "PRE_TRADING", "TRADING", "POST_TRADING", "END_OF_DAY", "HALT", "AUCTION_MATCH", "BREAK")
• permission string nullable — Filter by a supported permission, e.g. 'SPOT', 'MARGIN', 'LEVERAGED' (examples: "SPOT", "MARGIN")

Response

• @type string (default: "BinanceSymbol")
• symbol string required
• status string nullable
• base_asset string nullable
• base_asset_precision integer nullable
• quote_asset string nullable
• quote_asset_precision integer nullable
• base_commission_precision integer nullable
• quote_commission_precision integer nullable
• order_types array (default: [])
• iceberg_allowed boolean nullable
• oco_allowed boolean nullable
• oto_allowed boolean nullable
• opo_allowed boolean nullable
• quote_order_qty_market_allowed boolean nullable
• allow_trailing_stop boolean nullable
• cancel_replace_allowed boolean nullable
• amend_allowed boolean nullable
• peg_instructions_allowed boolean nullable
• spot_trading_allowed boolean nullable
• margin_trading_allowed boolean nullable
• default_self_trade_prevention_mode string nullable
• allowed_self_trade_prevention_modes array (default: [])
• permissions array (default: [])
• permission_sets array (default: [])
• filters array (default: [])
  • @type string (default: "BinanceSymbolFilter")
  • filter_type string required
  • min_price number nullable
  • max_price number nullable
  • tick_size number nullable
  • min_qty number nullable
  • max_qty number nullable
  • step_size number nullable
  • min_notional number nullable
  • max_notional number nullable
  • apply_min_to_market boolean nullable
  • apply_max_to_market boolean nullable
  • apply_to_market boolean nullable
  • avg_price_mins integer nullable
  • limit integer nullable
  • bid_multiplier_up number nullable
  • bid_multiplier_down number nullable
  • ask_multiplier_up number nullable
  • ask_multiplier_down number nullable
  • min_trailing_above_delta integer nullable
  • max_trailing_above_delta integer nullable
  • min_trailing_below_delta integer nullable
  • max_trailing_below_delta integer nullable
  • max_num_orders integer nullable
  • max_num_algo_orders integer nullable
  • max_num_order_lists integer nullable
  • max_num_order_amends integer nullable
  • max_position number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.