Skip to content

Search instruments

GET
/instruments
curl --request GET \
--url http://localhost:3001/instruments \
--header 'Authorization: Bearer <token>'
search
required
string
nullable
limit
required
integer format: int64
nullable

Matching active instruments

Media typeapplication/json
Array<object>
object
asset_class
required
string
has_options
required

Whether any instrument_derivative row names this instrument as its underlying — lets a search UI offer “view option chain” without a second round trip.

boolean
id
required
integer format: int64
instrument_class
required
string
name
required
string
status
required
string
symbol
required
string
venue
required
string

Example generated

[
{
"asset_class": "example",
"has_options": true,
"id": 1,
"instrument_class": "example",
"name": "example",
"status": "example",
"symbol": "example",
"venue": "example"
}
]

No credential