Skip to content
Trakli Docs

Get financial statistics

GET
/stats
 
curl --request GET \
  --url 'http://localhost:8000/api/v1/stats?period=day&preset=all_time&section=overview' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
start_date
string format: date
end_date
string format: date
wallet_ids

Comma-separated wallet IDs

string
period
string
default: month
Allowed values: day week month year
preset

Preset date range (overrides start_date/end_date)

string
Allowed values: all_time current_week current_month last_3_months
section

Compute only one section of the response for progressive loading. Omit for the full payload.

string
Allowed values: overview activity comparisons categories parties cashflow position

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Statistics retrieved successfully

Media type application/json
object
data
object
currency

Currency used for all amounts

string
overview
object
total_balance
number format: float
net_worth
number format: float
total_income
number format: float
total_expenses
number format: float
net_cash_flow
number format: float
avg_monthly_income
number format: float
avg_monthly_expenses
number format: float
savings_rate
number format: float
Example generated
{
  "data": {
    "currency": "example",
    "overview": {
      "total_balance": 1,
      "net_worth": 1,
      "total_income": 1,
      "total_expenses": 1,
      "net_cash_flow": 1,
      "avg_monthly_income": 1,
      "avg_monthly_expenses": 1,
      "savings_rate": 1
    }
  }
}