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
2155.3592 41.9 2024-11-13T05:30:00+00:00 PT30M
2305.7508 44.8 2024-11-13T05:00:00+00:00 PT30M
... ... ... ...
1116.2304 21.7 2024-11-06T06:30:00+00:00 PT30M
1132.1694 22.0 2024-11-06T06: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:

PvEstimate Percentage PeriodEnd Period
1836.6181 35.7 2024-11-13T06:00:00+00:00 PT30M
1499.0824 29.1 2024-11-13T06:30:00+00:00 PT30M
... ... ... ...
2678.5532 51.9 2024-11-20T05:00:00+00:00 PT30M
2395.597 46.4 2024-11-20T05:30:00+00:00 PT30M