← Back to the docs
LootX

Screener

Generated: 2026-11-21 docs.lootx.trade
Справочник

1Screener

Metrics for hundreds of instruments in a single request — price, change, volume, funding rate, OI, and their changes over windows; plus a reference of all metrics.

Screener snapshot

GET/v1/screener

An “instrument × metric” table for the market: last price, 24h change, volume, funding rate, OI, and dozens of others. Rate-limit group is screener.

Parameter What it does
venue exchanges separated by commas, case-insensitive; same set as the market subscription: Upbit is not in the screener. Defaults to all. Unknown exchange → 400 bad_request with param: "venue", not “all exchanges”
market spot, perp separated by commas, case-insensitive. Any other value → 400 bad_request
instruments exact instrument list separated by commas, rules below. When provided, venue and market are ignored. top_n still applies: for a list larger than 100 instruments, pass top_n at least as large, otherwise the response is silently truncated
top_n top N by 24h volume, 1–2000, default 100. 0 and values above 2000 are clamped to the boundary
names column names: long (default: volume_24h_usd, oi_change_usd_5m, …) or short — short keys (v24, odu5, …). Any other value → 400 bad_request
Shell
curl -s "https://market-api.lootx.trade/v1/screener?venue=binance&market=perp&top_n=2" \
  -H "Authorization: Bearer $LOOTX_API_KEY"
JSON
{
  "ts": 1793750400000,
  "columns": ["instrument", "ts", "last_price", "change_24h_pct", "volume_24h_usd", "funding_rate", "open_interest"],
  "rows": [
    ["binance:perp:BTCUSDT", 1793750399870, 104250.5, 1.84, 18234455120.4, 0.0001, 8423311987.2],
    ["binance:perp:ETHUSDT", 1793750399912, 3712.44, -0.62, 9122870411.7, 0.000085, 4120098211.6]
  ],
  "next_cursor": null
}

The example is shortened: the real response includes every metric the source knows for the instrument. Metrics the instrument does not have arrive as null.

Instrument list

  • The symbol is not checked against the registry. If the name passes the checks below but the screener has no such instrument, including due to a typo, there is no row for it and the response is 200. If none are found, 200 with empty rows — check against /v1/instruments.
  • Malformed name → 400 bad_instrument, the whole request.
  • 400 unsupported_instrument with param: "instrument", the whole request: market is neither spot nor perp; the symbol’s quote cannot be parsed, as in okx:perp:BTC-USDT-SWAP; a perp with a quote other than USDT, USDC, or USD, as in binance:perp:ETHBTC. Hyperliquid perps are exempt from the last two checks.
  • The exchange in the name is not validated: an unknown exchange does not cause an error, just a missing row.
  • The screener has no deck: one row for all decks of a coin, and the response names it without the deck. hyperliquid:perp:AAPLUSDC.XYZ and hyperliquid:perp:AAPLUSDC are one row, hyperliquid:perp:AAPLUSDC.
  • Empty instruments= is the same as omitting the parameter: the whole market considering venue and market.

Metrics reference

GET/v1/screener/metrics

Which columns the screener can have: short key, long name, unit, window, group, and description. Static — safe to cache on your side. Same screener rate-limit group.

JSON
{
  "columns": ["key", "name", "unit", "window", "group", "description"],
  "rows": [
    ["odu5", "oi_change_usd_5m", "usd", "5m", "oi", "Change in open interest over 5 minutes in dollars: current OI minus OI 5 minutes ago (pivot found by time)."]
  ]
}

If the source introduces a new metric before it is added to the reference, it arrives under its short key as-is — do not silently discard columns with unfamiliar names.

For live screener data, use the screener channel in WebSocket: updates arrive only for metrics that changed. To monitor the entire market at once, subscribe to the whole market with filters by exchanges, markets, and metrics.

https://docs.lootx.trade/en/market-api/screener