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
accountId
string
required
stageId
string
required

The stage the account passed, 1 to 80 letters, digits, hyphens or underscores.

Body

application/json
startingAllocation
object | null
required

The successor's opening balance as an exact fraction. It is required, and null is a real value meaning a successor with a zero balance.

Response

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

advance
object
required

The successor account. reserved means it was named and created but its opening balance isn't confirmed yet; advanced means it is. They stay distinct because a successor may one day be created at a provider, where asking for an account and having one are different facts.