Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

The Venue key (trdrs_vk_sandbox_… or trdrs_vk_production_…), in preview. It belongs to one venue in one environment and carries the scopes it was created with. The venue's verified owner creates it while signed in. It works on the /api/venues/{venueId} routes and, with trader:read or trader:trade, on the account, market and trading routes, reading the venue's own traders' accounts and routing their orders, each request naming its trader in x-trdrs-trader. A trdrs_sk_… key can't be used in its place. It reaches its venue's routes and its venue's own traders, and the owner manages keys from a signed-in session. Keep it on your server.

Path Parameters

venueId
string<uuid>
required

Query Parameters

q
string

The text to search for, at most 32 characters. Empty lists everything, a page at a time.

Maximum string length: 32
class
string

Only return markets of this asset class: future for futures, or crypto for crypto perpetuals. Any other class lists nothing.

offset
integer
default:0

How many results to skip, for the next page. hasMore is exact, so paging until it is false always ends.

Required range: x >= 0
limit
integer
default:50

How many results to return, 50 by default. Anything above 100 is lowered to 100, not refused.

Required range: x >= 1

Response

Success. The response is sent with Cache-Control: no-store, so don't cache it.

One page of symbol search results.

symbols
object[]
required

The matching symbols on this page.

hasMore
boolean
required

True when more results follow. It is exact, so paging with offset until it is false always ends.