Get Live Aggregation

View as Markdown
GET/data/live/aggregations

Get live aggregation data for up to 7 days of data at a time for a requested collection or aggregation.

Query Parameters

6 fields
hours
integer (int32)

The number of hours to return in the response.

period
string

Length of the averaging period in ISO 8601 duration format. Default is PT30M.

Accepted values
PT5M PT10M PT15M PT20M PT30M PT60M
output_parameters
string[]

The output parameters to include in the response.

collection_id
string

Unique identifier for your collection.

aggregation_id
string

Unique identifier that belongs to the requested collection.

format
string

Response format

Responses

200

OK

LiveAggregationResponse
estimated_actuals
object[]optional

GET/data/live/aggregations

Request
curl -X GET "https://api.solcast.com.au/data/live/aggregations?output_parameters=pv_estimate&collection_id=aust_state_total&aggregation_id=nsw" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "estimated_actuals": [
    {
      "pv_estimate": 3640.6402,
      "period_end": "2026-07-30T00:00:00+00:00",
      "period": "PT60M"
    },
    {
      "pv_estimate": 2483.8188,
      "period_end": "2026-07-29T23:00:00+00:00",
      "period": "PT60M"
    },
    {
      "pv_estimate": 939.6851,
      "period_end": "2026-07-29T22:00:00+00:00",
      "period": "PT60M"
    }
  ]
}

Get Forecast Aggregation

View as Markdown
GET/data/forecast/aggregations

Get forecast aggregation data for up to 14 days of data at a time for a requested collection or aggregation.

Query Parameters

6 fields
hours
integer (int32)

The number of hours to return in the response.

period
string

Length of the averaging period in ISO 8601 duration format. Default is PT30M.

Accepted values
PT5M PT10M PT15M PT20M PT30M PT60M
output_parameters
string[]

The output parameters to include in the response.

collection_id
string

Unique identifier for your collection.

aggregation_id
string

Unique identifier that belongs to the requested collection.

format
string

Response format

Responses

200

OK

ForecastAggregationResponse
forecasts
object[]optional

GET/data/forecast/aggregations

Request
curl -X GET "https://api.solcast.com.au/data/forecast/aggregations?output_parameters=pv_estimate&collection_id=aust_state_total&aggregation_id=nsw" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "forecasts": [
    {
      "pv_estimate": 4445.5105,
      "period_end": "2026-07-30T01:00:00+00:00",
      "period": "PT60M"
    },
    {
      "pv_estimate": 4861.0085,
      "period_end": "2026-07-30T02:00:00+00:00",
      "period": "PT60M"
    },
    {
      "pv_estimate": 4882.349,
      "period_end": "2026-07-30T03:00:00+00:00",
      "period": "PT60M"
    }
  ]
}