List active instruments
Search the instrument catalog across stocks, crypto, DEX, forex and commodities. Only active entries are listed. Results are ordered by asset class, symbol and a stable internal tie-breaker. Catalog access has no market entitlement gate, but normal API-key authentication, usage accounting and rate limits still apply. A catalog entry does not guarantee live or historical data availability. Gzip is supported but not required.
Request
- Base URLhttps://api.sifting.io
- Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Case-insensitive asset-class filter: stocks, crypto, dex, forex or commodities. Unknown values return an empty list.
Case-insensitive exact match on the catalog row's venue. Use a venue returned by the catalog; unknown values return an empty list.
Case-insensitive substring search over symbol or name.
Opaque pagination cursor from a previous response's meta.next_cursor.
Page size. Omitted, non-numeric or non-positive values use 50; values above 200 are clamped to 200.
Response
Active catalog entries. An empty result is a successful response. A malformed cursor returns 400.
Example response
{
"data": [
{
"slug": "stocks/AAPL",
"symbol": "AAPL"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.