Get wallet account

Get a single wallet account.

POST

/

public

/

v1

/

query

/

get_wallet_account

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.

walletId · string · required

Unique identifier for a given wallet.

address · string

Address corresponding to a wallet account.

path · string

Path corresponding to a wallet account.

Response

A successful response returns the following fields:

account · object · required

account field

Show account details

account.walletAccountId

string

required

Unique identifier for a given Wallet Account.

account.organizationId

string

required

The Organization the Account belongs to.

account.walletId

string

required

The Wallet the Account was derived from.

account.curve

enum

required

curve field

Enum options: CURVE_SECP256K1, CURVE_ED25519

account.pathFormat

enum

required

pathFormat field

Enum options: PATH_FORMAT_BIP32

account.path

string

required

Path used to generate the Account.

account.addressFormat

enum

required

addressFormat field

Enum 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

account.address

string

required

Address generated using the Wallet seed and Account parameters.

account.createdAt

object

required

createdAt field

Show createdAt details

account.createdAt.seconds

string

required

seconds field

account.createdAt.nanos

string

required

nanos field

account.updatedAt

object

required

updatedAt field

Show updatedAt details

account.updatedAt.seconds

string

required

seconds field

account.updatedAt.nanos

string

required

nanos field

account.publicKey

string

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

account.walletDetails

object

walletDetails field

Show walletDetails details

account.walletDetails.walletId

string

required

Unique identifier for a given Wallet.

account.walletDetails.walletName

string

required

Human-readable name for a Wallet.

account.walletDetails.createdAt

object

required

createdAt field

Show createdAt details

account.walletDetails.createdAt.seconds

string

required

seconds field

account.walletDetails.createdAt.nanos

string

required

nanos field

account.walletDetails.updatedAt

object

required

updatedAt field

Show updatedAt details

account.walletDetails.updatedAt.seconds

string

required

seconds field

account.walletDetails.updatedAt.nanos

string

required

nanos field

account.walletDetails.exported

boolean

required

True when a given Wallet is exported, false otherwise.

account.walletDetails.imported

boolean

required

True when a given Wallet is imported, false otherwise.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_wallet_account \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "walletId": "<string>",
    "address": "<string>",
    "path": "<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().getWalletAccount({
  organizationId: "<string> (Unique identifier for a given organization.)",
  walletId: "<string> (Unique identifier for a given wallet.)",
  address: "<string> (Address corresponding to a wallet account.)",
  path: "<string> (Path corresponding to a wallet account.)"
});

200

{
  "account": {
    "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>"
    }
  }
}