Skip to main content
POST

Authorizations

Authorization
string
header
required

A Hyperprop session token, the partner session token returned by POST /trade/partner/session, or the personal API key session token returned by POST /trade/api-keys/session.

Body

application/json

Request to flatten account(s)

account_ids
string<uuid>[] | null

Optional: List of account UUIDs to flatten. If omitted, flattens ALL accounts. Can be a single account or multiple accounts.

Example:
reason
string | null
write-only

Reserved for Hyperprop; leave unset.

symbols
string[] | null

Optional: List of contract symbols to flatten. If omitted, flattens ALL symbols. Examples: ["ESH6"], ["ESH6", "NQH6"], or omit for all symbols.

Example:

Response

Flatten command accepted

accepted
boolean
required
command_id
string<uuid>
required
command_type
string
required
status
string
required