Accounts

Get account balance

Get the balance of an account, aggregated across all wallets and supported chains.

get/v1/accounts/{account_id}/balance

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/accounts/{account_id}/balance
  • Auth
    HTTP basic

Path parameters

account_idstring required

ID of the account.

Query parameters

testnet_mode'true' | 'false'

When set to true, returns balances from testnet chains instead of mainnets.

Headers

privy-app-idstring required

ID of your Privy app.

Response

The account balance.

Example response

{
  "total": {
    "value": "100.00",
    "currency": "usd"
  },
  "assets": [
    {
      "price": {
        "value": "100.00",
        "currency": "usd"
      }
    }
  ],
  "assets_by_chain": [
    {
      "price": {
        "value": "100.00",
        "currency": "usd"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 60 revisions of this API.