Get wallet pact statistics

Retrieve aggregate pact metrics for a wallet, such as total pact count, active pacts, and cumulative spend. Data is derived from persisted transaction records.

GET /api/v1/wallets/{wallet_id}/pacts/stats

Get wallet pact statistics

Python

import requests

url = "https://api.example.com/api/v1/wallets/{wallet_id}/pacts/stats"

response = requests.get(url)

print(response.text)

200

{
  "result": {
    "wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total_pacts": 123,
    "total_active_pacts": 123,
    "total_tx_count": 123,
    "total_volume_usd": "<string>",
    "currency": "USD",
    "since": "2023-11-07T05:31:56Z",
    "as_of": "2023-11-07T05:31:56Z"
  },
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Headers

X-API-Key · string | null

Path Parameters

wallet_id · string<uuid> · required

The UUID of the wallet to retrieve pact statistics for.

Query Parameters

include_default · boolean · default: false

Include default pacts (is_default=true) in the statistics. Excluded by default.

lang · enum<string> · default: en

Language for localized display fields. Possible values: en, zh.

Available options: zh, en

Response

200

application/json

Successful Response

result · WalletPactStatsRead · object · required

Wallet-level pact statistics for the banner.

Show child attributes

success · boolean · default: true

suggestion · string · default: ""

message · string · default: ""

meta · PaginationMeta · object

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.

Show child attributes