Account

Get account information

Changed on

Respond with requester's account information

get/account

Request

  • Base URL
    https://api.prod.paradex.trade/v1
  • URL
    https://api.prod.paradex.trade/v1/account
  • Auth
    API key in header Authorization

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

last_seen_notificationinteger

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

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",
  "last_seen_notification": 1713400000000,
  "maintenance_margin_requirement": "31597.25239676",
  "margin_cushion": "104687.8167956",
  "seq_no": 1681471234972000000,
  "settlement_asset": "USDC",
  "status": "ACTIVE",
  "total_collateral": "123003.62047353",
  "updated_at": 1681471234972,
  "withdrawal_lock": {
    "amount": "1000",
    "expires_at": 1681471534,
    "request_id": "1681471234972000001",
    "status": "ACTIVE"
  },
  "withdrawal_lock_rejection": {
    "amount": "1000",
    "reason": "insufficient free collateral",
    "rejected_at": 1681471234,
    "request_id": "1681471234972000001"
  }
}

Changes

  • f33feb7333eaRevision changes
    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

  • 72c125c93c2bRevision changes
    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status