Account

Get account information

Respond with requester's account information

get/account

Query parameters

subaccount_addressstring

Subaccount address

Response

OK

accountstring

User's starknet account

account_valuestring

Current account value [with unrealized P&Ls]

free_collateralstring

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

initial_margin_requirementstring

Amount required to open trade for the existing positions

maintenance_margin_requirementstring

Amount required to maintain exisiting positions

margin_cushionstring

Acc value in excess of maintenance margin required

seq_nointeger

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

settlement_assetstring

Settlement asset for the account

statusstring

Status of the acc - like ACTIVE, LIQUIDATION

total_collateralstring

User's total collateral

updated_atinteger

Account last updated time

Example response

{
  "account": "0x495d2eb5236a12b8b4ad7d3849ce6a203ce21c43f473c248dfd5ce70d9454fa",
  "account_value": "136285.06918911",
  "free_collateral": "73276.47229774",
  "initial_margin_requirement": "63008.59689218",
  "maintenance_margin_requirement": "31597.25239676",
  "margin_cushion": "104687.8167956",
  "seq_no": 1681471234972000000,
  "settlement_asset": "USDC",
  "status": "ACTIVE",
  "total_collateral": "123003.62047353",
  "updated_at": 1681471234972
}

Changes

Changed in 1 of the 50 revisions of this API.3

    • added the media type application/json for the response with the status 200

      response-media-type-added

    • added the media type application/json for the response with the status 400

      response-media-type-added

    • added the media type application/json for the response with the status 401

      response-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog