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, and it works only on the /api/partner/venues/{venueId} routes. A trdrs_sk_… key can't be used in its place. It never lets you act as a trader, sign in or manage keys. Keep it on your server.

Headers

Idempotency-Key
string
required

A key you choose, 1 to 128 characters, that identifies this write. Send the same key when you retry it, so the write is never applied twice.

Required string length: 1 - 128

Path Parameters

venueId
string<uuid>
required
companyId
string<uuid>
required

Body

application/json
manifest
object
required

A public provider's declaration of what it supports, checked against the provider contract. A provider must offer accounts, market data or both. One that offers execution must also offer accounts, generation fencing, a complete order book and execution history, keep at least seven days of replay, and list at least one order type, time in force and position model; one that doesn't can't declare any execution feature, and account provisioning and position models need accounts. Lists hold no duplicates, and registering a manifest doesn't certify its claims.

evidence
object
required
expectedVersion
integer
required
Required range: x >= 1

Response

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

release
object
required