List wallets accounts

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_wallet_accounts \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "walletId": "<string>",
    "includeWalletDetails": "<boolean>",
    "paginationOptions": {
        "limit": "<string>",
        "before": "<string>",
        "after": "<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().getWalletAccounts({
  organizationId: "<string> (Unique identifier for a given organization.)",
  walletId: "<string> (Unique identifier for a given wallet. If not provided, all accounts for the organization will be returned.)",
  includeWalletDetails: true // Optional flag to specify if the wallet details should be included in the response. Default = false.,
  paginationOptions: { // paginationOptions field,
    limit: "<string> (A limit of the number of object to be returned, between 1 and 100. Defaults to 10.)",
    before: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects before this ID.)",
    after: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects after this ID.)",
  }
});

{
  "accounts": [
    {
      "walletAccountId": "<string>",
      "organizationId": "<string>",
      "walletId": "<string>",
      "curve": "<CURVE_SECP256K1>",
      "pathFormat": "<PATH_FORMAT_BIP32>",
      "path": "<string>",
      "addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>",
      "address": "<string>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "publicKey": "<string>",
      "walletDetails": {
        "walletId": "<string>",
        "walletName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "exported": "<boolean>",
        "imported": "<boolean>"
      }
    }
  ]
}

POST

public

query

list_wallet_accounts

Authorizations

API Key
WebAuthn (Passkey)

X-Stamp

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.

walletId

string

Unique identifier for a given wallet. If not provided, all accounts for the organization will be returned.

includeWalletDetails

boolean

Optional flag to specify if the wallet details should be included in the response. Default = false.

paginationOptions

object

paginationOptions field

Show details

paginationOptions.limit

string

A limit of the number of object to be returned, between 1 and 100. Defaults to 10.

paginationOptions.before

string

A pagination cursor. This is an object ID that enables you to fetch all objects before this ID.

paginationOptions.after

string

A pagination cursor. This is an object ID that enables you to fetch all objects after this ID.

Response

A successful response returns the following fields:

accounts

array

required

A list of accounts generated from a wallet that share a common seed.

Show accounts details

accounts.walletAccountId

string

required

Unique identifier for a given Wallet Account.

accounts.organizationId

string

required

The Organization the Account belongs to.

accounts.walletId

string

required

The Wallet the Account was derived from.

accounts.curve

enum

required

curve fieldEnum options: CURVE_SECP256K1, CURVE_ED25519

accounts.pathFormat

enum

required

pathFormat fieldEnum options: PATH_FORMAT_BIP32

accounts.path

string

required

Path used to generate the Account.

accounts.addressFormat

enum

required

addressFormat fieldEnum options: ADDRESS_FORMAT_UNCOMPRESSED, ADDRESS_FORMAT_COMPRESSED, ADDRESS_FORMAT_ETHEREUM, ADDRESS_FORMAT_SOLANA, ADDRESS_FORMAT_COSMOS, ADDRESS_FORMAT_TRON, ADDRESS_FORMAT_SUI, ADDRESS_FORMAT_APTOS, ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR, ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR, ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR, ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR, ADDRESS_FORMAT_SEI, ADDRESS_FORMAT_XLM, ADDRESS_FORMAT_DOGE_MAINNET, ADDRESS_FORMAT_DOGE_TESTNET, ADDRESS_FORMAT_TON_V3R2, ADDRESS_FORMAT_TON_V4R2, ADDRESS_FORMAT_TON_V5R1, ADDRESS_FORMAT_XRP

accounts.address

string

required

Address generated using the Wallet seed and Account parameters.

accounts.createdAt

object

required

createdAt field

Show createdAt details

accounts.createdAt.seconds

string

required

seconds field

accounts.createdAt.nanos

string

required

nanos field

accounts.updatedAt

object

required

updatedAt field

Show updatedAt details

accounts.updatedAt.seconds

string

required

seconds field

accounts.updatedAt.nanos

string

required

nanos field

accounts.publicKey

string

The public component of this wallet account’s underlying cryptographic key pair.

accounts.walletDetails

object

walletDetails field

Show walletDetails details

accounts.walletDetails.walletId

string

required

Unique identifier for a given Wallet.

accounts.walletDetails.walletName

string

required

Human-readable name for a Wallet.

accounts.walletDetails.createdAt

object

required

createdAt field

Show createdAt details

accounts.walletDetails.createdAt.seconds

string

required

seconds field

accounts.walletDetails.createdAt.nanos

string

required

nanos field

accounts.walletDetails.updatedAt

object

required

updatedAt field

Show updatedAt details

accounts.walletDetails.updatedAt.seconds

string

required

seconds field

accounts.walletDetails.updatedAt.nanos

string

required

nanos field

accounts.walletDetails.exported

boolean

required

True when a given Wallet is exported, false otherwise.

accounts.walletDetails.imported

boolean

required

True when a given Wallet is imported, false otherwise.

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_wallet_accounts \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "walletId": "<string>",
    "includeWalletDetails": "<boolean>",
    "paginationOptions": {
        "limit": "<string>",
        "before": "<string>",
        "after": "<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().getWalletAccounts({
  organizationId: "<string> (Unique identifier for a given organization.)",
  walletId: "<string> (Unique identifier for a given wallet. If not provided, all accounts for the organization will be returned.)",
  includeWalletDetails: true // Optional flag to specify if the wallet details should be included in the response. Default = false.,
  paginationOptions: { // paginationOptions field,
    limit: "<string> (A limit of the number of object to be returned, between 1 and 100. Defaults to 10.)",
    before: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects before this ID.)",
    after: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects after this ID.)",
  }
});

{
  "accounts": [
    {
      "walletAccountId": "<string>",
      "organizationId": "<string>",
      "walletId": "<string>",
      "curve": "<CURVE_SECP256K1>",
      "pathFormat": "<PATH_FORMAT_BIP32>",
      "path": "<string>",
      "addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>",
      "address": "<string>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "publicKey": "<string>",
      "walletDetails": {
        "walletId": "<string>",
        "walletName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "exported": "<boolean>",
        "imported": "<boolean>"
      }
    }
  ]
}

List wallets Who am I?

⌘I

Activities

Queries

List wallets accounts

Authorizations

Body

Response