Skip to main content
GET
Show spending per category against normal

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Scopes

read

Read access

read_write

Read and write access

Query Parameters

start_date
string<date>

Inclusive ISO date. Requires end_date; both omitted means the current month to date.

end_date
string<date>

Inclusive ISO date at or after start_date.

Response

comparison returned

currency
string
required
period
object
required
in_progress
boolean
required

The period has not ended: it is cut to today, and normal is the average of same-length windows starting on the corresponding date in each of up to 12 earlier months.

baseline_period
object | null
required

Up to a year before the period, starting no earlier than the first non-pending, non-excluded transaction in eligible accounts after transaction-kind exclusions. Null with under 28 days of eligible history before the period.

comparable
boolean
required

False when there is not enough history to compute a normal.

total
string
required

Net spending total across all categories in the period.

normal_total
string | null
required

Sum of each category's normal. Null when not comparable.

categories
object[]
required

Parent categories, largest total first.