Production API ReferenceAccount

Get account information

Respond with requester's account information

Authentication

Authorizationstring
API Key authentication via header

Query parameters

subaccount_addressstringOptional
Subaccount address

Response

OK
accountstringOptional
User's starknet account
account_valuestringOptional

Current account value [with unrealized P&Ls]

free_collateralstringOptional

Free collateral available (Account value in excess of Initial Margin required)

initial_margin_requirementstringOptional
Amount required to open trade for the existing positions
last_seen_notificationintegerOptional

Latest notification event timestamp (ms) the user has seen — used for cross-device dedup

maintenance_margin_requirementstringOptional
Amount required to maintain exisiting positions
margin_cushionstringOptional
Acc value in excess of maintenance margin required
seq_nointegerOptional

Unique increasing number (non-sequential) that is assigned to this account update. Can be used to deduplicate multiple feeds

settlement_assetstringOptional
Settlement asset for the account
statusstringOptional

Status of the acc - like ACTIVE, LIQUIDATION

total_collateralstringOptional
User's total collateral
updated_atintegerOptional
Account last updated time

Errors

400
Bad Request Error
401
Unauthorized Error