Skip to main content
POST
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.

Headers

Idempotency-Key
string
required

A key you choose, 1 to 128 characters. A retry with the same key and body adds nothing again and answers each market as it stands.

Required string length: 1 - 128

Path Parameters

venueId
string<uuid>
required
connectionId
string<uuid>
required

Body

application/json
readingId
string<uuid>
required
markets
required

all, or 1 to 500 markets by the provider's own symbol.

activate
boolean
required
orderTypes
enum<string>[]
Available options:
market,
limit,
stop,
stop_limit
timeInForce
enum<string>[]
Available options:
day,
gtc,
ioc,
fok,
post_only
maxAgeMs
integer
Required range: 1 <= x <= 2000
quantityMax
string

An exact decimal string, such as "12.5", with at most 18 digits after the point and no exponent.

Response

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

connectionId
string<uuid>
required
reading
object
required
items
object[]
required
conversions
object[]
required