Skip to main content
GET
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.

Path Parameters

venueId
string<uuid>
required
accountId
string
required

Response

The request is malformed: invalid JSON or input, a bad cursor, or a missing Idempotency-Key or If-Match header. When one value is refused, field names it where the check can say which.

The body of every error response. It always carries error, an English sentence you can show. A refused trading request also carries code, one of the refusal codes, and params, the details of that refusal. Translate by code and params, and show a generic message for a code you don't recognize. Other errors may carry a code of their own.

error
string
required

What went wrong, as an English sentence.

code
string

A stable machine code. On a refused trading request, it is one of the refusal codes.

params
object

The details of the refusal named by code, on a refused trading request.