Skip to main content
GET
Retrieve a capacity forecast

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

group_id
string
required

Flatpeak Group ID.

Query Parameters

start_time
string<date-time>
required

Start of the forecast window, in UTC.

Example:

"2026-08-13T17:00:00Z"

end_time
string<date-time>
required

End of the forecast window, in UTC.

Example:

"2026-08-13T19:00:00Z"

direction
enum<string>
required

Dispatch direction to forecast capacity for.

Available options:
IMPORT,
EXPORT
Example:

"EXPORT"

Response

Capacity forecast response.

Dispatchable capacity for a group over a future window, from each member's forecast, state, limits, settings and consents, derated by its fulfillment history.

object
enum<string>
required

Object type, capacity_forecast.

Available options:
capacity_forecast
Example:

"capacity_forecast"

group_id
string
required

Flatpeak Group ID the forecast covers.

Example:

"grp_2f6a9c1d8e3b5a7c4d0e9f1a"

direction
enum<string>
required

Dispatch direction the capacity applies to.

Available options:
IMPORT,
EXPORT
Example:

"EXPORT"

data
object[]
required

Dispatchable capacity, one entry per window.