Get private key

Get details about a private key.

POST

/

public

/

v1

/

query

/

get_private_key

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.

privateKeyId · string · required

Unique identifier for a given private key.

Response

A successful response returns the following fields:

privateKey · object · required

privateKey field

Show privateKey details

privateKey.privateKeyId

string

required

Unique identifier for a given Private Key.

privateKey.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

privateKey.privateKeyName

string

required

Human-readable name for a Private Key.

privateKey.curve

enum

required

curve field

Enum options: CURVE_SECP256K1, CURVE_ED25519, CURVE_P256

privateKey.addresses

array

required

Derived cryptocurrency addresses for a given Private Key.

Show addresses details

privateKey.addresses.format

enum

format 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

privateKey.addresses.address

string

address field

privateKey.privateKeyTags

array

required

A list of Private Key Tag IDs.

Show privateKeyTags details

privateKey.privateKeyTags.item

string

required

item field

privateKey.createdAt

object

required

createdAt field

Show createdAt details

privateKey.createdAt.seconds

string

required

seconds field

privateKey.createdAt.nanos

string

required

nanos field

privateKey.updatedAt

object

required

updatedAt field

Show updatedAt details

privateKey.updatedAt.seconds

string

required

seconds field

privateKey.updatedAt.nanos

string

required

nanos field

privateKey.exported

boolean

required

True when a given Private Key is exported, false otherwise.

privateKey.imported

boolean

required

True when a given Private Key is imported, false otherwise.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_private_key \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "privateKeyId": "<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().getPrivateKey({
  organizationId: "<string> (Unique identifier for a given organization.)",
  privateKeyId: "<string> (Unique identifier for a given private key.)"
});

200

{
  "privateKey": {
    "privateKeyId": "<string>",
    "publicKey": "<string>",
    "privateKeyName": "<string>",
    "curve": "<CURVE_SECP256K1>",
    "addresses": [
      {
        "format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
        "address": "<string>"
      }
    ],
    "privateKeyTags": [
      "<string>"
    ],
    "createdAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    },
    "updatedAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    },
    "exported": "<boolean>",
    "imported": "<boolean>"
  }
}