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
1785.0805 33.8 2025-02-07T02:30:00+00:00 PT30M
1679.5271 31.8 2025-02-07T02:00:00+00:00 PT30M
... ... ... ...
3421.1418 64.9 2025-01-31T03:30:00+00:00 PT30M
3465.654 65.8 2025-01-31T03:00: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
35.9 1896.3589 2025-02-07T03:00:00+00:00 PT30M
38.8 2048.4861 2025-02-07T03:30:00+00:00 PT30M
... ... ... ...
32.6 1724.9165 2025-02-14T02:00:00+00:00 PT30M
33.7 1780.3326 2025-02-14T02:30:00+00:00 PT30M