Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

Private-preview venue operator key (trdrs_vk_sandbox_… or trdrs_vk_production_…). Bound to one venue/environment and explicit scopes. Issued by a verified owner session; accepted only on documented /api/partner/venues/{venueId} routes. Existing trdrs_sk keys are not interchangeable. Never grants trader, login or key-management authority.

Headers

Idempotency-Key
string
required
Required string length: 1 - 128

Path Parameters

venueId
string<uuid>
required

Body

application/json
routeId
string
required
name
string
required
mode
enum<string>
required
Available options:
internal,
external
connectionId
string<uuid> | null
required
externalAccountId
string | null
required
state
enum<string>
required
Available options:
offered,
retired
collar
object
required

How far past a fresh executable quote a fill may still be accepted. A tick count means the same thing at every price level and is the only shape permitted where prices can print negative; a proportional allowance against a negative base widens as the price falls and inverts through zero.

feeReservePerUnit
string
required

Exact base-ten decimal string, at most 18 fractional digits. No exponent notation or binary floating-point conversion.

uncappedMarketAllowed
boolean
required
expectedRevision
integer | null
required
Required range: x >= 1

Response

Scoped result. Cache-Control: no-store.

route
object
required

Where a group's orders go, and what protects an order sent there. An external route names both its connection and the dedicated account at it; an internal one names neither. version is what a command pins, so a fill can be attributed to the exact policy it was dispatched under.