Wallets

Get all wallets

Changed on

Get all wallets in your app.

get/v1/wallets

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/wallets
  • Auth
    HTTP basic

Query parameters

cursorstring

Cursor returned by the previous page.

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

The wallet chain types.

string
OR
string
OR
string
user_idstring

Filter wallets by user ID. Cannot be used together with authorization_key.

entity_idstring

Filter wallets by the entity ID the wallet is attributed to.

authorization_keystring

Filter wallets by authorization public key. Returns wallets owned by key quorums that include the specified P-256 public key (base64-encoded DER format). Cannot be used together with user_id.

external_idstring

Filter wallets by external ID.

include_archivedboolean

Include archived wallets in lookup. Defaults to false.

Headers

privy-app-idstring required

ID of your Privy app.

Response

Object with wallet data.

next_cursorstring

Example response

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

Changes

  • 9b687835ed44Revision changes
    • breaking

      for the query request parameter limit, the type changed from number null to integer

    • warning

      for the query request parameter limit, the min was set to 1.00

  • 4facbfa7f9d4Revision changes
    • warning

      for the query request parameter cursor, the maxLength was set to 512

    • warning

      added the new xrpl enum value to the // response property for the response status

    • info

      added the new optional query request parameter entity_id

    • info

      added the new enum value xrpl to the query request parameter chain_type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the // response's property pattern ^[a-zA-Z0-9_-]+$ was added for the status