Skip to navigation
REST APIReference dataVenues

Get a venue

One venue by id. A removed venue, or one another environment serves, is 404.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

venueIdstringRequired
The venue id.

Response

The venue.
codestring

The venue code. Instrument symbols carry it upper-cased as their venue prefix: okx is the OKX@ in OKX@BTC/USDT.

displayNamestring
The name to show people.
updatedAtNsstring or nullformat: "^[0-9]+$"
When the venue record last changed, as a sequencer timestamp in epoch nanoseconds. Null when unknown.
venueIdstring
The venue's id. Ids are opaque strings.

Errors

400
Get Venues Request Bad Request Error
401
Get Venues Request Unauthorized Error
404
Get Venues Request Not Found Error
503
Get Venues Request Service Unavailable Error