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

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

ledger
object
required

The balance, the collateral held and the open positions of an account whose balance trdrs keeps. An account whose provider keeps its balance has none of this.

route
object | null
required

Where a group's orders go, and what protects an order sent there. An external route names both its provider connection and the dedicated account there; an internal route, on the paper book, names neither. version is recorded with each order, so every fill traces back to the exact route it was sent under.