Get wallet by ID

Returns active wallet metadata, exact Config or Connection ownership, runtime execution admission, Provider, public key, and by default the current SOL balance.

GET/v1/wallets/{walletId}Run in dashboard

If the balance read fails, returns 503 instead of a zero balance. Set includeBalance=false for a metadata-only read.

Requires an API key with the wallets.read action.

Path parameters

  • walletId · string · required · min length 1 · example privy_wallet_123

    Provider wallet ID — the walletId field returned by GET /v1/wallets.

Query parameters

  • includeBalance · string · one of true, false · example false

    Whether to resolve the current SOL balance. Defaults to true; false returns metadata without balance RPC or pricing calls.

Headers

  • x-project-id · string · min length 1 · example prj_example

    Required for dashboard sessions. API keys use their assigned project.

Responses

  • 200 Wallet details

    • data · object · required

      Wallet details by ID response payload.

      • wallet · object · required

        Wallet details with provider and optional SOL balance.

        • id · string · required · example cwlt_example

          Wallet record ID.

        • custodyConfigId · string · example cfg_example

          Owning custody configuration ID.

        • custodyConnectionId · string · example cconn_example

          Owning Custody Connection ID.

        • provider · string · required · example privy

          Wallet custody provider.

        • isRuntimeExecutionAllowed · boolean · required · example true

          Whether SDP currently permits attempting runtime execution through this wallet's owner. This is request-time admission, not Provider health or a success guarantee.

        • walletId · string · required · min length 1 · example privy_wallet_123

          Provider wallet ID.

        • publicKey · string · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

          Base58-encoded Solana address.

        • label · string | null · required · example Treasury wallet

          Optional wallet label.

        • purpose · string | null · required · example transfer

          Optional wallet purpose.

        • status · string · required · one of active, inactive · example active

          Wallet status.

        • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

          ISO 8601 timestamp.

        • balance · object

          Current SOL balance for the wallet public key. Omitted when includeBalance=false.

          • token · string · required · always SOL · example SOL

            Balance token symbol.

          • mint · string · required · example So11111111111111111111111111111111111111112

            Native SOL mint address.

          • amount · string · required · example 123456789

            Raw lamports balance as a string.

          • uiAmount · string · required · example 0.123456789

            Human-readable SOL balance.

          • decimals · number · required · always 9 · example 9

            Token decimals for SOL.

        One of:

        • Owned by a Managed config. · must include custodyConfigId · must not include custodyConnectionId

        • Owned by a Custody Connection. · must include custodyConnectionId · must not include custodyConfigId

    • meta · object · required

      Response metadata.

      • requestId · string · required · min length 1 · example req_example

        Request identifier for tracing.

      • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

  • 401 Unauthorized

    • error · object · required

      Standard error payload.

      • code · string · required

        Machine-readable error code.

      • message · string · required

        Human-readable error message.

      • details · object

        Optional error details for debugging.

        • * · any

    • meta · object

      • requestId · string · min length 1 · example req_example

        Request identifier for tracing.

  • 403 Forbidden. Requires the wallets.read action: an API key must hold it (a module's manage or execute also covers its read), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and error.details.action names the action. Any other 403 names its own reason.

    Same fields as 401.

  • 404 Not Found

    Same fields as 401.

  • 409 Conflict

    Same fields as 401.

  • 500 Internal Server Error

    Same fields as 401.

  • 503 Service Unavailable

    Same fields as 401.

Example request

curl 'https://api-beta.solana.com/v1/wallets/privy_wallet_123' \
  -H "Authorization: Bearer $SDP_API_KEY"
const res = await fetch("https://api-beta.solana.com/v1/wallets/privy_wallet_123", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SDP_API_KEY}`
  }
});
import os, requests

r = requests.get("https://api-beta.solana.com/v1/wallets/privy_wallet_123",
  headers={"Authorization": f"Bearer {os.environ['SDP_API_KEY']}"})

Example responses

JSON
{
  "data": {
    "wallet": {
      "id": "cwlt_example",
      "custodyConfigId": "cfg_example",
      "provider": "privy",
      "isRuntimeExecutionAllowed": true,
      "walletId": "privy_wallet_123",
      "publicKey": "So11111111111111111111111111111111111111112",
      "label": "Treasury wallet",
      "purpose": "transfer",
      "status": "active",
      "createdAt": "2025-01-01T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}
JSON
{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Missing action: wallets.read",
    "details": {
      "action": "wallets.read"
    }
  },
  "meta": {
    "requestId": "req_example"
  }
}

Error responses use the standard error shape.