Walletguide
DevelopersAPIReferencedata

CategoryBreakdown

Whole-wallet figures need the permissions listed without assets:read; scoping the request with assetIds makes it a per-asset breakdown, which needs…

POST
/wallets/{walletId}/data/categoryBreakdown

Authorization

bearerAuth
headerAuthorization<token>

A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.

Path Parameters

walletId*string

The wallet id (row uuid)

Formatuuid

Request Body

application/json
  1. body
period*|

Window the income/expense KPIs are computed for.

assetIds?array<string>

Scope to these asset uuids; omit for whole-wallet.

categoryIds?array<string>

Scope to these category uuids; omit for all categories.

Response Body

categoryBreakdown result

application/json
  1. response
income*number

The sum of all income within the given period

incomePreviousPeriod*number

The sum of all income within the previous period

incomeChange*number

The change in income between the given period and the previous period

expenses*number

The sum of all expenses within the given period

expensesPreviousPeriod*number

The sum of all expenses within the previous period

expensesChange*number

The change in expenses between the given period and the previous period

gainsLosses*number

The sum of all gains/losses within the given period

gainsLossesPreviousPeriod*number

The sum of all gains/losses within the previous period

gainsLossesChange*number

The change in gains/losses between the given period and the previous period

uncategorized*number

The sum of all uncategorized income/expenses within the given period

uncategorizedPreviousPeriod*number

The sum of all uncategorized income/expenses within the previous period

uncategorizedChange*number

The change in uncategorized income/expenses between the given period and the previous period

profit*number

The profit within the given period

profitPreviousPeriod*number

The profit within the previous period

profitChange*number

The change in profit between the given period and the previous period

plainProfit*number

The plain profit (without gains/losses and uncategorized) within the given period

plainProfitPreviousPeriod*number

The plain profit (without gains/losses and uncategorized) within the previous period

plainProfitChange*number

The change in plain profit (without gains/losses and uncategorized) between the given period and the previous period

Example Request
curl -X POST 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/categoryBreakdown' \  -H 'Content-Type: application/json' \  -d '{  "period": "today"}'
Example Response
{  "income": 0,  "incomePreviousPeriod": 0,  "incomeChange": 0,  "expenses": 0,  "expensesPreviousPeriod": 0,  "expensesChange": 0,  "gainsLosses": 0,  "gainsLossesPreviousPeriod": 0,  "gainsLossesChange": 0,  "uncategorized": 0,  "uncategorizedPreviousPeriod": 0,  "uncategorizedChange": 0,  "profit": 0,  "profitPreviousPeriod": 0,  "profitChange": 0,  "plainProfit": 0,  "plainProfitPreviousPeriod": 0,  "plainProfitChange": 0}

CashFlowTimeSeries

Whole-wallet figures need the permissions listed without assets:read; scoping the request with assetIds makes it a per-asset breakdown, which needs…

AssetPerformance

AssetPerformance (data endpoint) in the Walletguide REST API. Parameters, response fields, and a playground you can run.