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. A retry with the same key returns the original job, even a failed one, so send a new key to check again.

Required string length: 1 - 128

Path Parameters

venueId
string<uuid>
required
connectionId
string<uuid>
required

Body

application/json

The body is of type object.

Response

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

validation
object
required

One check of a connection. It fails if the key that started it is revoked, or its creator stops being an owner, before the check reads the provider or records its result. tradingReady is always false: a pass doesn't make the connection ready to trade.