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

month
string

The month to report, YYYY-MM. Defaults to the previous complete month.

Pattern: ^\d{4}-\d{2}$

Response

The firm’s usage for the month (PartnerUsageResponse)

PartnerUsageResponse. Money is in cents and integral; a null price or amount means unpriced, never a zero bill.

firm
string
required

Your firm’s name, as trdrs holds it.

month
string
required

The month reported, YYYY-MM (UTC).

basis
enum<string>
required

How accounts were attributed. unattributable means this connector cannot attribute per firm here, so the count is 0 by construction.

Available options:
rithmic-system,
unattributable
activeAccounts
integer
required

Distinct accounts with at least one real fill in the month. Connected-but-idle does not count; simulated fills never count.

priceCentsPerActiveAccount
integer | null
required

Your agreed per-active-account price in cents. Null when no price is set.

amountCents
integer | null
required

activeAccounts × price, in cents. Null when unpriced or unattributable, never coerced to 0.