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.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Response

The venue.
venueIdstring
The venue's id. Ids are opaque strings.
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.

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