---
title: "Get EndUser forecasts"
method: GET
path: "/api/end_users/forecast"
tags: ["EndUserCalculations"]
---

# Get EndUser forecasts

`GET /api/end_users/forecast`

Get forecast amounts for a given EndUser and category

## Query parameters

- `end_user_id` string, nullable
- `end_user_heron_id` string, nullable
- `to_currency` 'GBP' | 'USD' | 'EUR' | 'CAD' | 'AUD' | 'null', nullable
- `date_granularity` 'week' | 'month'
- `category_heron_id` string
- `category_label` string
- `from_date` string, date, nullable
- `to_date` string, date, nullable

## Response `200`

OK

- EndUserForecastOutputSchema[]
  - `currency` string, nullable — ISO 4217 currency code
  - `date` string — Forecast date at specified date granularity
  - `predicted` number — Predicted amount
  - `predicted_lower` number — Predict amount lower bound
  - `predicted_upper` number — Predicted amount upper bound

---

[API](https://skmtc.dev/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)