Skip to main content
POST
/
platform
/
admin
/
tenant
/
wallets
/
grouped
Get grouped wallets report
curl --request POST \
  --url https://api.example.com/platform/admin/tenant/wallets/grouped \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Fetches wallet data grouped and aggregated by selected breakdown categories. This enables analysis of wallet distribution across blockchains, wallet types, or other dimensions.

​
Input

Expects a JSON body containing:
  • groupBy (array of strings, optional) - Categories to group wallets by (e.g., “Blockchain”, “WalletType”, “IsActive”)
  • filters (object, optional) - Additional filters to apply before grouping

​
Output

Returns a containing:
  • groups (array) - Collection of grouped wallet data with aggregations
  • totalWallets (int) - Total number of wallets across all groups
  • groupCount (int) - Number of distinct groups

​
Examples

Request 
{
  "groupBy": ["Blockchain", "WalletType"]
}
Response (200 OK) 
{
  "groups": [
    {
      "groupKey": {
        "blockchain": "Ethereum",
        "walletType": "EOA"
      },
      "walletCount": 5,
      "totalBalance": "12500.00",
      "activeCount": 4,
      "inactiveCount": 1
    },
    {
      "groupKey": {
        "blockchain": "Polygon",
        "walletType": "MultiSignature"
      },
      "walletCount": 3,
      "totalBalance": "75000.00",
      "activeCount": 3,
      "inactiveCount": 0
    }
  ],
  "totalWallets": 8,
  "groupCount": 2
}

​
Errors

  • 400 Bad Request: Invalid grouping criteria or malformed request.
  • 401 Unauthorized: Authentication token is missing or invalid.
  • 403 Forbidden: User does not have permission to view wallet reports.
  • 500 Internal Server Error: An unexpected error occurred while generating the grouped report.

​
Notes

Grouping is performed server-side for optimal performance. Multiple grouping dimensions can be combined to create hierarchical breakdowns. Balance totals are calculated from real-time blockchain data.

Query Parameters

​
api-version
string | null

Body

application/json

Request containing grouping criteria for the wallet report.

Base class for all API request models.

​
breakdowns
enum<string>[]
Available options:
Network,
Address,
NativeToken,
DefaultCustodian,
RefuelEnabled,
RefuelSource,
RefuelSourceAddress,
GasStation

Response

Grouped wallets report retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.