Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

A partner-scoped API key (trdrs_sk_…), issued to a trdrs Connect partner firm and accepted only under /api/partner/. Same format as the firm (tenant) key, different scope: a firm API key is refused here, and this key is refused everywhere else.

Query Parameters

account
string
required

Account issued by your firm.

equityBefore
string<date-time>

For analytics history pagination, use equityHistory.nextBefore to retrieve the next older page. Verify cycle.id has not changed.

timeZone
string
default:America/Chicago

IANA timezone for qualifying fill days. Keep fixed throughout a stage.

rolloverHour
integer
default:17

Local session roll hour. Midnight uses calendar dates; other rolls label the session by its ending date. DST-aware.

Required range: 0 <= x <= 23
stageId
string
required

Your stable stage identifier, 1–80 letters, digits, underscores or hyphens.

profitTarget
number
required

Net trading profit required, in account currency, at most two decimals.

Required range: x <= 100000000
minimumTradingDays
integer
required

Distinct sessions with at least one fill.

Required range: 0 <= x <= 3650

Response

Snapshot; eligible=false is a successful check with unmet conditions.

accountNumber
string
required
asOf
string<date-time>
required
snapshotId
string
required
cycleId
string
required
stage
object
required
policyId
string
required
eligible
boolean
required
reasons
string[]
required
netTradingPnl
number
required
tradingDays
integer
required
transitionReference
string
required
evaluatedRules
string[]
required