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, recorded as the audit reference of this write. The referenceId in the body is what makes the issue safe to retry.

Required string length: 1 - 128

Path Parameters

venueId
string<uuid>
required

Body

application/json
groupId
string
required

The group the account joins. It must have a route.

email
string
required

The trader's sign-in email, at most 254 characters. Send only an address you have checked the trader holds. Send this or trader, not both.

startingBalance
integer
required

The opening balance in currency, a whole number from 1,000 to 10,000,000.

Required range: 1000 <= x <= 10000000
currency
string
required

The account currency: USD, the only currency issued, posted in cents.

riskPolicy
object
required

Your published risk policy the account is held to, by policyId alone: the account trades every product class the policy offers. The policy must be yours, published and in the account currency. Any other field is refused.

referenceId
string
required

Your own reference for this issue, at most 80 characters. The same referenceId with the same request returns the account it already issued; with a different request it's refused.

Maximum string length: 80
trader
string

Your own id for one of your traders, the id your Connect links use: letters, digits, dot, underscore, colon and hyphen, up to 128 characters, starting with a letter or a digit. Never an email or another personal detail. Send this or email, not both.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$
positionMode
enum<string>
default:net

How the account holds its positions. net, the default, keeps one signed position per instrument. independent_tickets makes each opening order its own position, closed by naming it and never netted against an opposite one, and needs a policy that states ticket hedging for every product class it offers.

Available options:
net,
independent_tickets

Response

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

account
object
required

The account you issued, on the paper book (book is canonical): its trader, its currency, its balance, and your risk policy it is held to, with the version in force. created: false means the referenceId already issued this account for the same request, and nothing new was issued.