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

Query Parameters

equityBefore
string<date-time>

To page back through equity samples, send the equityHistory.nextBefore of the previous response. Check the cycle id hasn't changed between pages.

Response

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

accountId
string
required
analytics
object
required

One account's current cycle. An account trdrs measures from its own risk decisions states in pnl.imported and tradingDays.imported what a cycle carried over when it moved from the older paper records. For an account held at a provider (book: provider), the current balance, equity, positions and orders are available where covered, while pnl.grossRealized, pnl.fees, pnl.netTrading, tradingDays.count and tradingDays.days stay null until the cycle's real start and full history are verified: the first provider snapshot is only a starting observation, completeness.trading is false with economic_cycle_unverified, equityHistory is null and risk.observedRules is empty. Never show a null as zero or use it for a stage.