Wallets

Get balance

Changed on

Get the balance of a wallet by wallet ID.

get/v1/wallets/{wallet_id}/balance

Request

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

Path parameters

wallet_idstring required

ID of the wallet.

Query parameters

'usdc' | 'usdc.e' | 'eth' | 'avax' | 'pol' | 'bnb' | 'mon' | 'usdt' | 'eurc' | 'usdb' | 'ousd' | 'pathusd'

A named asset on Ethereum-compatible chains.

OR
'sol' | 'usdc' | 'eurc' | 'usdb' | 'ousd'

A named asset on Solana.

OR
'trx' | 'usdt' | 'usdc'

A named asset on Tron.

OR
'ethereum' | 'arbitrum' | 'avalanche' | 'base' | 'tempo' | 'linea' | 'optimism' | 'polygon' | 'bsc' | 'solana' | 'tron' | 'zksync_era' | 'robinhood' | 'unichain' | 'worldchain' | 'ink' | 'soneium' | 'megaeth' | 'hyperevm' | 'hypercore' | 'arc' | 'monad' | 'tempo_testnet' | 'hoodi' | 'sepolia' | 'arbitrum_sepolia' | 'avalanche_fuji' | 'base_sepolia' | 'linea_testnet' | 'optimism_sepolia' | 'polygon_amoy' | 'bsc_testnet' | 'solana_devnet' | 'solana_testnet' | 'tron_nile' | 'robinhood_testnet' | 'ink_sepolia'
OR
string
OR
include_currency'usd' | 'eur'

If set, balances are converted to the specified fiat currency. Not supported when token is provided.

string
OR
string[]
include_archivedboolean

Include archived wallets in lookup. Defaults to false.

Headers

privy-app-idstring required

ID of your Privy app.

Response

Latest wallet balance.

Changes

  • 4facbfa7f9d4Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • warning

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

    • warning

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

    • warning

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

    • info

      added the enum value mon to the property anyOf[subschema #1: WalletEthereumAsset]/ of the query request parameter asset

    • info

      added the enum value mon to the property anyOf[subschema #4]/items/anyOf[subschema #1: WalletEthereumAsset]/ of the query request parameter asset

    • info

      added the enum value ousd to the property anyOf[subschema #1: WalletEthereumAsset]/ of the query request parameter asset

    • info

      added the enum value ousd to the property anyOf[subschema #2: WalletSolanaAsset]/ of the query request parameter asset

    • info

      added the enum value ousd to the property anyOf[subschema #4]/items/anyOf[subschema #1: WalletEthereumAsset]/ of the query request parameter asset

    • info

      added the enum value ousd to the property anyOf[subschema #4]/items/anyOf[subschema #2: WalletSolanaAsset]/ of the query request parameter asset

    • info

      added subschema #1 subschema #2 to the // response property anyOf list for the response status

    • info

      removed the arbitrum enum value from the // response property for the response status

    • info

      removed the arbitrum_sepolia enum value from the // response property for the response status

    • info

      removed the avalanche enum value from the // response property for the response status

    • info

      removed the avalanche_fuji enum value from the // response property for the response status

    • info

      removed the base enum value from the // response property for the response status

    • info

      removed the base_sepolia enum value from the // response property for the response status

    • info

      removed the bsc enum value from the // response property for the response status

    • info

      removed the ethereum enum value from the // response property for the response status

    • info

      removed the linea enum value from the // response property for the response status

    • info

      removed the linea_testnet enum value from the // response property for the response status

    • info

      removed the optimism enum value from the // response property for the response status

    • info

      removed the optimism_sepolia enum value from the // response property for the response status

    • info

      removed the polygon enum value from the // response property for the response status

    • info

      removed the polygon_amoy enum value from the // response property for the response status

    • info

      removed the sepolia enum value from the // response property for the response status

    • info

      removed the solana enum value from the // response property for the response status

    • info

      removed the solana_devnet enum value from the // response property for the response status

    • info

      removed the solana_testnet enum value from the // response property for the response status

    • info

      removed the tempo enum value from the // response property for the response status

    • info

      removed the tron enum value from the // response property for the response status

    • info

      removed the tron_nile enum value from the // response property for the response status

    • info

      removed the zksync_era enum value from the // response property for the response status

  • e0d0022c2e2cRevision changes
    • warning

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

    • info

      added the enum value pathusd to the property anyOf[subschema #1: WalletEthereumAsset]/ of the query request parameter asset

    • info

      added the enum value pathusd to the property anyOf[subschema #4]/items/anyOf[subschema #1: WalletEthereumAsset]/ of the query request parameter asset