List instruments
Build your request
Change the values and the command follows. The token is never typed here: the command reads it from the SPECTRE_LOCAL_API_TOKEN environment variable. Run it in your own terminal.
curl 'http://127.0.0.1:48180/v1/instruments?exchange=binance&market=futures&q=btc&limit=50' \ -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
The instrument catalogue of one exchange and market, in pages ordered by symbol. Pass either connection_id or both exchange and market. Steps and minimums are null when the exchange did not report them.
bearerToken market:readAuthorizationBearer <token>The Local API token: spt_ and 64 hex characters. Copy it from Settings App → General → Local API. It is accepted only in the Authorization header. The names listed with an operation are the scopes it requires. The token of the terminal carries all of them.
Scope: market:read
connection_id?integerThe connection whose exchange and market to list.
int64exchange?stringExchange name. Used together with market.
market?stringMarket type. Used together with exchange.
q?stringPart of the symbol or of the base coin. Case does not matter.
limit?integerPage size. A value outside the range is moved into it.
1 <= value <= 2000500cursor?stringnext_cursor of the previous page.
One page of the catalogue.
application/json- response
exchange*stringmarket*stringdata*array<>next_cursor*|Pass it as cursor for the next page. null on the last page.
curl 'http://127.0.0.1:48180/v1/instruments?exchange=binance&market=futures&q=btc&limit=50' \ -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"{ "exchange": "binance", "market": "futures", "data": [ { "instrument": "binance:futures:BTCUSDT", "exchange": "binance", "market": "futures", "symbol": "BTCUSDT", "base": "BTC", "quote": "USDT", "status": "active", "tick_size": "0.1", "lot_size": "0.001", "min_size": "0.001", "contract_value": "1" } ], "next_cursor": null}