Vaults

Get vault account summary

Changed on

Get current user summary metrics for all vaults or for the single vault specified by address. User metrics are only returned if the current user is a depositor for the vault.

get/vaults/account-summary

Request

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

Query parameters

addressstring

Vault Address

Response

OK

Example response

{
  "results": [
    {
      "address": "0x1234567890abcdef",
      "created_at": 1717171717,
      "deposited_amount": "123.45",
      "estimated_accrued_fee": "1.23",
      "estimated_fee_breakdown": [
        {
          "estimated_accrued_fee": "0.45",
          "strategy": "0x29464b79b02543ed8746bba6e71c8a15401dd27b7279a5fa2f2fe8e8cdfabb"
        }
      ],
      "hwm_price": "1.0512",
      "total_pnl": "149.12",
      "total_roi": "0.724",
      "vtoken_amount": "123.45"
    }
  ]
}

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_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

  • 72c125c93c2bRevision changes
    • 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