/coinglass/coins/search

POST /api/coinglass/coins/search

Price: 5 credits

List crypto coins with derivatives market data, ranked and filtered

How to use it

List cryptocurrencies with their derivatives market data. Returns each coin's price, market cap, open interest (value, amount, OI/market-cap and OI/volume ratios), trading volume, average funding rate, long/short ratios, price and open-interest change percentages over multiple windows, liquidation totals, and RSI across timeframes. Filter by ticker keyword or a single exchange, and rank by open interest, volume, price change, OI change, liquidations, funding rate or RSI.

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 coins to return (min: 1)
• keyword string — Filter coins by ticker symbol (default: "")
• exchange string nullable — Restrict figures to a single exchange; omit for the aggregated market (one of: "Binance", "OKX", "Bybit", "Crypto.com", "Gate", "Bitget", "BingX", "MEXC", "Bitunix", "Hyperliquid", "dYdX", "Deribit", "Bitfinex", "Bitmex", "CoinEx", "Kraken", "Coinbase", "HTX")
• sort string — Field to rank coins by (default: "openInterest"; one of: "openInterest", "h24VolUsd", "h24PriceChangePercent", "d7PriceChangePercent", "h1OiChangePercent", "h4OiChangePercent", "h24OiChangePercent", "h24LiquidationUsd", "avgFundingRateByOi", "h1Ls", "marketCap", "rsi4h")
• order string — Sort direction (default: "desc"; one of: "asc", "desc")

Response

• @type string (default: "CoinglassMarketCoin")
• symbol string required
• image string nullable
• price number nullable
• market_cap number nullable
• open_interest number nullable
• open_interest_amount number nullable
• oi_market_cap_ratio number nullable
• oi_volume_ratio number nullable
• volume_usd number nullable
• avg_funding_rate_by_oi number nullable
• avg_funding_rate_by_volume number nullable
• long_short_ratio_1h number nullable
• long_short_ratio_4h number nullable
• long_short_ratio_24h number nullable
• price_change_percentage_1h number nullable
• price_change_percentage_4h number nullable
• price_change_percentage_24h number nullable
• price_change_percentage_7d number nullable
• oi_change_percentage_1h number nullable
• oi_change_percentage_4h number nullable
• oi_change_percentage_24h number nullable
• volume_change_percentage_1h number nullable
• volume_change_percentage_4h number nullable
• volume_change_percentage_24h number nullable
• liquidation_usd_1h number nullable
• liquidation_usd_4h number nullable
• liquidation_usd_24h number nullable
• long_liquidation_usd_24h number nullable
• short_liquidation_usd_24h number nullable
• rsi_15m number nullable
• rsi_1h number nullable
• rsi_4h number nullable
• rsi_12h number nullable
• rsi_1d number nullable
• rsi_1w 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.