GET /v1/symbols
Updated
What does GET /v1/symbols do?
Every trading pair a venue lists, as the venue’s own symbols. Returns the list of pairs a venue currently lists, written as that venue’s own symbol strings. Use it to discover what you can query on a venue before calling latest or series.
The list tracks listings and delistings, so it is the honest current universe for that venue rather than a static file.
Authentication
API key required. Set $BF to the API base and pass your key in $BLACKFORGE_API_KEY.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
exchange | string | Yes | Venue whose traded symbols to list, e.g. "binance". |
Parameter shapes from the live OpenAPI document.
Example request
curl -H "x-api-key: $BLACKFORGE_API_KEY" \
"$BF/v1/symbols?exchange=binance"Example response
[
"0GTRY",
"0GUSDC",
"0GUSDT",
"1000CATTRY",
"1000CATUSDC",
"1000CATUSDT",
"1000CHEEMSUSDC",
"1000CHEEMSUSDT",
"1000SATSTRY",
"1000SATSUSDC",
"1000SATSUSDT",
"1INCHUSDC",
"…"
]Returns
A JSON array of the venue’s symbol strings.
Responses and errors
| Status | When |
|---|---|
400 | The exchange parameter is missing or names a venue that is not covered. |
401 | The x-api-key header is missing or not a valid key. |
NoteA venue on your plan is required: Free reaches Binance, MEXC and Gate; the paid plans reach all nine.