Skip to content

Aggregation Data API

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


The module AggregationClient has the following available methods:

Endpoint Purpose API Docs
GetLiveAggregations Get live aggregation data for up to 7 days of data at a time for a requested collection or aggregation. details
GetForecastAggregations Get forecast aggregation data for up to 7 days of data at a time for a requested collection or aggregation. details

GetLiveAggregations

Parameters: outputParameters, collectionId, aggregationId, hours, period, format

Example Usage:

using Solcast.Clients;

var aggregationClient = new AggregationClient();
var response = await aggregationClient.GetLiveAggregations(
    outputParameters: ["percentage", "pv_estimate"],
    collectionId: "aust_state_total",
    aggregationId: "vic",
    format: "csv"
);
Console.WriteLine(response.RawResponse);
Sample Output:

PvEstimate Percentage PeriodEnd Period
0.0 0.0 2025-07-14T08:00:00+00:00 PT30M
1.1104 0.0 2025-07-14T07:30:00+00:00 PT30M
... ... ... ...
0.0 0.0 2025-07-07T09:00:00+00:00 PT30M
0.0 0.0 2025-07-07T08:30:00+00:00 PT30M

GetForecastAggregations

Parameters: outputParameters, collectionId, aggregationId, hours, period, format

Example Usage:

using Solcast.Clients;

var aggregationClient = new AggregationClient();
var response = await aggregationClient.GetForecastAggregations(
    outputParameters: ["percentage", "pv_estimate"],
    collectionId: "aust_state_total",
    aggregationId: "vic",
    format: "csv"
);
Console.WriteLine(response.RawResponse);
Sample Output:

Percentage PvEstimate PeriodEnd Period
0.0 0.0000 2025-07-14T08:30:00+00:00 PT30M
0.0 0.0000 2025-07-14T09:00:00+00:00 PT30M
... ... ... ...
0.2 12.5833 2025-07-21T07:30:00+00:00 PT30M
0.0 0.0000 2025-07-21T08:00:00+00:00 PT30M