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);
PvEstimate | Percentage | PeriodEnd | Period |
---|---|---|---|
2987.8278 | 56.4 | 2025-02-18T01:00:00+00:00 | PT30M |
2883.786 | 54.5 | 2025-02-18T00:30:00+00:00 | PT30M |
... | ... | ... | ... |
3211.218 | 60.8 | 2025-02-11T02:00:00+00:00 | PT30M |
3129.7392 | 59.2 | 2025-02-11T01: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);
Percentage | PvEstimate | PeriodEnd | Period |
---|---|---|---|
58.0 | 3071.5268 | 2025-02-18T01:30:00+00:00 | PT30M |
58.2 | 3080.0550 | 2025-02-18T02:00:00+00:00 | PT30M |
... | ... | ... | ... |
50.5 | 2679.3282 | 2025-02-25T00:30:00+00:00 | PT30M |
54.7 | 2900.5330 | 2025-02-25T01:00:00+00:00 | PT30M |