SOsolcast
Grid Aggregations

Get Live Aggregation

Changed on

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

get/data/live/aggregations

Request

  • Base URL
    https://api.solcast.com.au (the document declares no server; this is the origin it was published from)
  • URL
    https://api.solcast.com.au/data/live/aggregations
  • Auth
    none declared

Query parameters

output_parametersstring[]

The output parameters to include in the response.

collection_idstring nullable required

Unique identifier for your collection.

aggregation_idstring nullable

Unique identifier that belongs to the requested collection.

hoursinteger nullable

The number of hours to return in the response.

period'PT5M' | 'PT10M' | 'PT15M' | 'PT20M' | 'PT30M' | 'PT60M' nullable

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

format'csv' | 'json' nullable

Response format

Response

OK

estimated_actualsobject[] nullable

Changes

  • ec8e5425d984Revision changes
    • breaking

      the query request parameter format was restricted to a list of enum values

    • info

      added the new enum value csv to the query request parameter format

    • info

      added the new enum value json to the query request parameter format

    • info

      added the enum value percentage to the property items/ of the query request parameter output_parameters

    • info

      added the enum value pv_estimate to the property items/ of the query request parameter output_parameters

  • d5799520aefeRevision changes
    • breaking

      the query request parameter collection_id became required