Rooftop Solar Forecasts

API Documentation for our Rooftop Solar Forecasting product

Quick Start: Simple PV Power Requests

Solcast will be soon moving to a new sites-based API framework (Read more down below). In the meantime, we are continuing to offer access to our Simple PV Power API tool for evaluation purposes.

What is the Simple PV Power Request?

The Simple PV Power request returns a first-guess PV power output forecast, based on your specified latitude and longitude plus some basic PV system characteristics. The past 7 days of estimated actuals for PV power output is also available. All of the data are generated using our Rapid Update forecasting systems, and offer Global Coverage.

What data is provided by the API?

The data in each row are 30-minute period end averages and are in UTC. The data are updated every 10-15 minutes

simple-pv-power-parameters.png

GET Request (Forecast)

Please note you’ll need to place your API Key in the below GET request at >YOUR_KEY<.

GET https://api.solcast.com.au/pv_power/forecasts?longitude=149.117&latitude=-35.277&capacity=1000&api_key=>YOUR_KEY<&format=json

GET Request Return (Forecast)

{
  "forecasts": [{
      "period_end": "2017-01-30T04:00:00.0000000Z",
      "period": "PT30M",
      "pv_estimate": 420.767208900235
    }, {
      "period_end": "2017-01-30T04:30:00.0000000Z",
      "period": "PT30M",
      "pv_estimate": 311.890641831329
    }
  ]
}

GET Request (Estimated Actuals)

Please note you’ll need to place your API Key in the below GET request at >YOUR_KEY<.

GET https://api.solcast.com.au/pv_power/estimated_actuals?longitude=149.117&latitude=-35.277&capacity=1000&api_key=>YOUR_KEY<&format=json

GET Request Return (Estimated Actuals)

{
  "estimated_actuals": [{
      "period_end": "2017-01-29T22:00:00.0000000Z",
      "period": "PT30M",
      "pv_estimate": 723.640155693826
    }, {
      "period_end": "2017-01-29T21:30:00.0000000Z",
      "period": "PT30M",
      "pv_estimate": 618.347032902544
    }
  ]
}

Coming Soon the Sites-based API

Soon, Solcast will be launching a new API framework, which is a site-based model. Each PV power API request will be linked to a resource ID, defined by a latitude and longitude and the basic characteristics of the PV system of interest.

Rooftop Sites API Example

Create a Rooftop Site

To create a Rooftop Site, the user will have to complete a POST request in the following JSON format (with >YOUR_KEY< replaced by your API Key):

POST https://api.solcast.com.au/rooftop_sites?format=json&api_key=>YOUR_KEY<

create-rooftop-site.png

Using the following properties (noting that only a selection of these are mandatory):

rooftop-site-create-properties.png

Retrieve a forecast for a Rooftop Site

Please note you’ll need to place your API Key and resource ID in the below GET request at >YOUR_RESOURCE_ID< and >YOUR_KEY<.

GET https://api.solcast.com.au/rooftop_sites/>YOUR_RESOURCE_ID</forecasts?api_key=>YOUR_KEY<&format=json

GET Request Return (Forecast)

rooftop-sites-response-structures.png

More Information Coming Soon

We’ll be publishing finalised documentation for this new sites based API framework in early 2019. If you’d like to test out the new system now, please Contact Us.

Finally, please note that the new sites based framework is required for testing PV Tuning for rooftop sites.