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, 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

Body

application/json

Either { profileId } for a published profile, or { groupId, override } for a proposed group override.

Response

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

preview
object
required

What the proposed change would do, without doing it. economicChange says whether it changes what accounts are charged, and blockers lists each account that isn't flat yet and why. It is a snapshot: an account can open a position before you apply the change, so applying it checks again.