Skip to main content
POST
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.

Body

application/json

PartnerAccountRefRequest. Names one firm-issued account by its number.

accountNumber
string
required

A firm-issued account number.

Response

Trading is halted (PartnerHaltStateResponse)

PartnerHaltStateResponse. Whether the account is halted after the call — true from halt, false from resume.

accountNumber
string
required
halted
boolean
required