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

symbol
string
required

A registered contract identifier or dated futures code. Continuous futures symbols and unregistered feed symbols refuse.

Required string length: 1 - 300
contractVersion
string

An exact registered version. Read older facts explicitly without changing a listing bound to them.

Required string length: 1 - 200

Response

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

contract
object
required