Skip to main content
GET
Get User Transactions Summary V2

Authorizations

Authorization
string
header
required

Bearer authentication with a personal access token (prefix pat_). Generate tokens in the Truv web app under Settings → API keys.

Query Parameters

transacted_at_from
string
required

Start date for the transaction window (inclusive, YYYY-MM-DD).

Example:

"2025-01-01"

transacted_at_to
string

End date for the transaction window (inclusive, YYYY-MM-DD). Defaults to today.

Example:

"2025-12-31"

categories
string | null

Comma-separated category slugs to include (e.g. 'income,transfer'). Omit to include all categories.

Maximum string length: 1000
Example:

"income,transfer"

transaction_type
enum<string> | null

Filter by transaction type. Omit to include both debits and credits.

Available options:
DEBIT,
CREDIT
Example:

"DEBIT"

account_ids
string | null

Comma-separated account IDs to include. Omit to include all accounts.

Example:

"acc_001,acc_002"

min_amount

Minimum transaction amount (absolute value). Inclusive.

Example:

"10.00"

max_amount

Maximum transaction amount (absolute value). Inclusive.

Example:

"500.00"

merchant
string | null

Case-insensitive substring match on merchant name or description.

Example:

"starbucks"

exclude_categories
string | null

Comma-separated category slugs to exclude (e.g. 'transfer,uncategorized').

Maximum string length: 1000
include_hidden
boolean
default:false

Include user-hidden transactions in the aggregates. Hidden transactions can be unhidden; permanently deleted transactions are never counted regardless.

Example:

true

Response

Aggregate statistics for transactions matching filters.

Aggregate statistics for a set of transactions matching the given filters.

total_count
integer
required

Total number of transactions.

Example:

142

total_income
string
required

Sum of all CREDIT amounts.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"3000.00"

total_spending
string
required

Sum of all DEBIT amounts.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"1245.50"

net_total
string
required

total_income minus total_spending.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"1754.50"

average_amount
string
required

Average transaction amount (absolute value).

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"87.72"

largest_transaction
LargestTransactionDetail · object | null

Transaction with the highest absolute amount.

largest_expense
LargestTransactionDetail · object | null

DEBIT transaction with the highest amount.

largest_income
LargestTransactionDetail · object | null

CREDIT transaction with the highest amount.