Wallets

Get balance

Get the balance of a wallet by wallet ID.

get/v1/wallets/{wallet_id}/balance

Path parameters

wallet_idstring required

ID of the wallet.

Query parameters

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

A named asset on Ethereum-compatible chains.

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

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' | 'sepolia' | 'arbitrum_sepolia' | 'avalanche_fuji' | 'base_sepolia' | 'linea_testnet' | 'optimism_sepolia' | 'polygon_amoy' | 'solana_devnet' | 'solana_testnet' | 'tron_nile'

Supported blockchain network names for wallet balance and transaction queries.

OR
WalletAssetChainNameInput[]
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

Changed in 3 of the 46 revisions of this API.712

    • added the new bnb enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new bsc enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new tron enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new tron_nile enum value to the // response property for the response status

      response-property-enum-value-added

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

      request-parameter-property-enum-value-added

    • added the enum value bnb to the property anyOf[subschema #3 -> subschema #4]/items/anyOf[subschema #1: WalletEthereumAsset]/ of the query request parameter asset

      request-parameter-property-enum-value-added

    • added the enum value bsc to the property anyOf[subschema #1: WalletAssetChainNameInput]/ of the query request parameter chain

      request-parameter-property-enum-value-added

    • added the enum value bsc to the property anyOf[subschema #2]/items/ of the query request parameter chain

      request-parameter-property-enum-value-added

    • added the enum value tron to the property anyOf[subschema #1: WalletAssetChainNameInput]/ of the query request parameter chain

      request-parameter-property-enum-value-added

    • added the enum value tron to the property anyOf[subschema #2]/items/ of the query request parameter chain

      request-parameter-property-enum-value-added

    • added the enum value tron_nile to the property anyOf[subschema #1: WalletAssetChainNameInput]/ of the query request parameter chain

      request-parameter-property-enum-value-added

    • added the enum value tron_nile to the property anyOf[subschema #2]/items/ of the query request parameter chain

      request-parameter-property-enum-value-added

    • added to the // response property anyOf list for the response status

      response-property-any-of-added

    • added the new optional query request parameter include_archived

      new-optional-request-parameter

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

    • added the new avalanche enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new avalanche_fuji enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new avax enum value to the /// response property for the response status

      response-property-enum-value-added

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

      request-parameter-property-enum-value-added

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

      request-parameter-property-enum-value-added