Skip to main content
POST
/
tenant
/
{tenantId}
/
wallets
/
grouped
Retrieves a grouped wallets report with breakdowns by various dimensions.
curl --request POST \
  --url https://api.example.com/tenant/{tenantId}/wallets/grouped \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.numium.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant.

Body

application/json

Request containing grouping configuration.

Base class for all API request models.

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

Response

200 - application/json

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.