Skip to main content
GET
/
stats
/
time_series
List Time Series
curl --request GET \
  --url https://{defaultHost}/stats/time_series \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "period": "<string>",
      "currency": "<string>",
      "amount": "<string>",
      "line_count": 123
    }
  ],
  "metadata": {
    "from": "<string>",
    "to": "<string>",
    "timezone": "<string>",
    "currency": "<string>",
    "convert_currency": "<string>",
    "wallet_id": "<string>",
    "account_id": "<string>",
    "reporting_category": "<string>",
    "base_reporting_scope": "<string>",
    "grouping": [
      "<string>"
    ],
    "line_category": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token.

Headers

​
Api-Version-Date
string<date>

Pins the request to a dated API version. When omitted, the request uses the original (2025-01-01) request/response shapes, so existing unversioned callers are never broken. Generated SDKs always send the latest version they were built against. An unrecognized value is rejected with a 400. The schemas documented here always describe the latest version.

Example:

"2026-06-09"

Query Parameters

​
resource_type
enum<string>
required

The stats resource to query. Currently only wallet is supported.

Available options:
wallet
​
from
string<date>
required

Start of the date range (ISO 8601, e.g. 2025-01-01).

​
to
string<date>
required

End of the date range (ISO 8601, e.g. 2025-12-31).

​
group_by
enum<string>

Period size for each data point. Defaults to month.

Available options:
day,
week,
month
​
account_id
string

The business or user account ID whose wallet should be queried. Defaults to the authenticated account.

​
reporting_category
string

Restricts the series to one reporting category. See the stats schema endpoint for valid values.

​
grouping
string[]

Filters to one or more groupings. See the stats schema endpoint for valid values.

​
line_category
string[]

Filters to one or more line categories. See the stats schema endpoint for valid values.

​
currency
string

Filters to ledger lines denominated in this currency.

​
convert_currency
string

Converts amounts into this currency.

​
timezone
string

IANA timezone used for period boundaries (e.g. America/New_York). Defaults to UTC.

Response

time series listed

​
data
object[]
required
​
metadata
object
required