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

Body

application/json
policy
object
required

One version of an account risk policy, as the risk policy contract states it: the policy id and version, the authority (a firm, naming this venue), the account currency, the terms of each product class it offers, the settlement term and the posting term. A product class carries its futures margin by dated contract or its crypto derivative collateral, its thresholds and its valuation age, each term with its own version, authority, source and effective dates. Anything else is refused, with field naming what.

Response

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

version
object
required