Sign in
Wallets

Get wallet

Get a wallet by wallet ID.

get/v1/wallets/{wallet_id}

Path parameters

wallet_idstring required

ID of the wallet.

Query parameters

include_archivedboolean

Include archived wallets in lookup. Defaults to false.

Headers

privy-app-idstring required

ID of your Privy app.

Response

Requested wallet object.

addressstring required

Address of the wallet.

archived_atnumber nullable

Unix timestamp of when the wallet was archived in milliseconds, or null if the wallet is active.

authorization_thresholdnumber

The number of keys that must sign for an action to be valid.

chain_type'ethereum' | 'solana' | 'cosmos' | 'stellar' | 'sui' | 'aptos' | 'movement' | 'tron' | 'bitcoin-segwit' | 'bitcoin-taproot' | 'pearl' | 'near' | 'ton' | 'starknet' | 'spark' required

The wallet chain types.

created_atnumber required

Unix timestamp of when the wallet was created in milliseconds.

display_namestring

A human-readable label for the wallet.

exported_atnumber nullable required

Unix timestamp of when the wallet was exported in milliseconds, if the wallet was exported.

external_idstring

A customer-provided identifier for mapping to external systems. Write-once, set only at creation.

idstring required

Unique ID of the wallet. This will be the primary identifier when using the wallet in the future.

imported_atnumber nullable required

Unix timestamp of when the wallet was imported in milliseconds, if the wallet was imported.

owner_idstring cuid2 nullable required

The key quorum ID of the owner of the wallet.

policy_idsstring[] required

List of policy IDs for policies that are enforced on the wallet.

public_keystring

The compressed, raw public key for the wallet along the chain cryptographic curve.

Example response

{
  "additional_signers": [],
  "address": "0xF1DBff66C993EE895C8cb176c30b07A559d76496",
  "archived_at": null,
  "chain_type": "ethereum",
  "created_at": 1741834854578,
  "display_name": "Treasury",
  "exported_at": null,
  "external_id": "my-order-123",
  "id": "id2tptkqrxd39qo9j423etij",
  "imported_at": null,
  "owner_id": "rkiz0ivz254drv1xw982v3jq",
  "policy_ids": []
}

Changes

Changed in 1 of the 46 revisions of this API.2

  • 41cbc1e43b722See the full diff
    • ○

      added the new optional query request parameter include_archived

      new-optional-request-parameter

    • ○

      added the optional property archived_at to the response with the 200 status

      response-optional-property-added

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