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
stageId
string
required

The stage to check against, 1 to 80 letters, digits, hyphens or underscores.

Response

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

eligibility
object
required

Two versions of the stage rules decide an advance, and the advance records both. policyId, activationRevision and economicHash name the version that judges the running cycle, the one in force when it opened, so a later change of rules applies from the next cycle. routingPolicyId and routingActivationRevision name the version in force now, whose nextGroupId is where a passing account lands, since a change of destination applies at once.