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 the link.

Required string length: 1 - 128

Path Parameters

venueId
string<uuid>
required

Body

application/json
email
string
required

The trader's email, at most 254 characters. Send only an address you have checked the trader holds.

accountId
string

One of the accounts you issued this trader, which the trading platform opens on. Without it, the platform opens where the trader left it.

Response

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

url
string<uri>
required

The link. Its token is in the fragment, which no server receives.

expiresAt
string<date-time>
required