Get balances

Get non-zero balances of supported assets for a single wallet account address on the specified network.

POST

/

public

/

v1

/

query

/

get_wallet_address_balances

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

organizationId · string · required

Unique identifier for a given organization.

address · string · required

Address corresponding to a wallet account.

caip2 · string · required

The network identifier in CAIP-2 format (e.g., ‘eip155:1’ for Ethereum mainnet).

Response

A successful response returns the following fields:

balances · array

List of asset balances

Show balances details

balances.caip19

string

The caip-19 asset identifier

balances.symbol

string

The asset symbol

balances.balance

string

The balance in atomic units

balances.decimals

number

The number of decimals this asset uses

balances.display

object

display field

Show display details

balances.display.usd

string

USD value for display purposes only. Do not do any arithmetic or calculations with these, as the results could be imprecise.

balances.display.crypto

string

Normalized crypto value for display purposes only. Do not do any arithmetic or calculations with these, as the results could be imprecise.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_wallet_address_balances \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "address": "<string>",
    "caip2": "<string>"
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getWalletAddressBalances({
  organizationId: "<string> (Unique identifier for a given organization.)",
  address: "<string> (Address corresponding to a wallet account.)",
  caip2: "<string> (The network identifier in CAIP-2 format (e.g., 'eip155:1' for Ethereum mainnet).)"
});

200

{
  "balances": [
    {
      "caip19": "<string>",
      "symbol": "<string>",
      "balance": "<string>",
      "decimals": "<number>",
      "display": {
        "usd": "<string>",
        "crypto": "<string>"
      }
    }
  ]
}