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 accounts that counted in the month (PartnerUsageAccountsResponse)

PartnerUsageAccountsResponse. The accounts behind the usage number — always sums to activeAccounts for the same month.

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 — same meaning as on /api/partner/usage. unattributable comes with an empty list.

Available options:
rithmic-system,
unattributable
accounts
object[]
required

One entry per account that counted, ordered by account number.