Aggregate wallet balances

Aggregates tracked balances for active wallets under the same owner-aware inclusion rules as the wallet list, without exposing one aggregate-level owner or runtime-admission value.

GET/v1/wallets/aggregateRun in dashboard

Returns 503 if any included wallet balance cannot be read, rather than returning an incomplete total.

Requires an API key with the wallets.read action.

Query parameters

  • provider · string · one of local, fireblocks, privy, coinbase_cdp, para, turnkey, dfns, ibm_haven, anchorage, utila · example privy

    Wallet signing provider.

Headers

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

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

Responses

  • 200 Aggregated wallet balances

    • data · object · required

      Aggregated wallet balance response payload.

      • aggregate · object · required

        Aggregated wallet balance summary.

        • walletCount · integer · required · min 0 · example 3

          Number of wallets included in the aggregate.

        • balances · object[] · required

          Aggregated tracked token balances across the included wallets.

          • token · string · required · example USDC

            Tracked token symbol.

          • mint · string · required · min length 32 · max length 44 · example 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU

            Tracked token mint address.

          • amount · string · required · example 1250000

            Raw token amount as a string.

          • uiAmount · string · required · example 1.25

            Human-readable token balance.

          • decimals · integer · required · min 0 · example 6

            Token decimals.

          • usdPrice · number · example 1

            Resolved USD price per token when available.

          • usdValue · number · example 125.5

            Resolved USD value of this balance when pricing is available.

    • 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.

  • 400 Bad Request

    • 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.

  • 401 Unauthorized

    Same fields as 400.

  • 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 400.

  • 409 Conflict

    Same fields as 400.

  • 500 Internal Server Error

    Same fields as 400.

  • 503 Service Unavailable

    Same fields as 400.

Example request

curl 'https://api.solana.com/v1/wallets/aggregate' \
  -H "Authorization: Bearer $SDP_API_KEY"

Example responses

{
  "data": {
    "aggregate": {
      "walletCount": 3,
      "balances": [
        {
          "token": "USDC",
          "mint": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
          "amount": "1250000",
          "uiAmount": "1.25",
          "decimals": 6,
          "usdPrice": 1,
          "usdValue": 125.5
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Error responses use the standard error shape.

Is this page helpful?