Once you've created your Utility Scale solar farm site in the API Toolkit you'll be able to instantly live and forecast power output data from the site. There are two ways to do this: 1) via the API Toolkit (easy) or 2) directly via the API.
Method 1: API Toolkit
On your newly created Site Card in the API Toolkit, click on the "Get the data" button
From there, you'll see an expanded menu with several buttons to help you create the correct API request. Next, select "Forecast", then the time resolution and download file type you want:
Method 2: Direct API GET request
First, you need to know your API key. Each email address that has registered with the Solcast API service has a unique API key. You'll need this API key to perform GET (retrieve data) or POST (e.g. send measurement data) requests to/from the Solcast API. If you forget your API key you can get it from the 'Account' page of the API Toolkit. Remember to treat your API key as confidential information (Solcast will never ask you for your API key)!
Second, you'll need to know the 'resource_id' for each site. Each site create in the Solcast API is assigned a unique identifier (‘resource_id’) which in most cases will be provided to you directly by a Solcast staff member (our more tech savvy users will find they can get this information directly from the API). The resource ID will be a combination of letters and numbers in the format: xxxx-xxxx-xxxx-xxxx
Accessing your solar farm forecast data
Solcast will connect the site(s) you created to your API account(s) based on their resource IDs and the email address you used to register for the Solcast API. Only you and your team will be able to access these forecasts. They are confidential and secure, as long as you keep your API key private.
Formats, time resolution, forecast horizon
From here, the easiest way to access your forecasting information is through a web browser, where you can download your data in a variety of formats. Simply place the following URLs (with your RESOURCE_ID and API KEY) into the URL field, using one of the example forecast calls (cut & paste):
30 minute resolution forecasts, out through 160 hours ahead:
15 minute resolution forecasts, out through 33 hours ahead in json format:
5 minute resolution forecasts, out through 12 hours ahead in XML format:
5 minute resolution forecasts, out through 12 hours ahead in csv format:
GET the forecast of your choice
If you pay attention to the above examples, you'll see patterns emerge and will be able to modify the URL strings to retrieve the data you require in the format of your choice.
You can set the resolution of your forecasts to 30, 15, 10 or 5 minutes using the 'period' field (e.g. 'period=PT30M' gets you 30 minute resolution).
You can set the forecast horizon of your forecasts to your desired # of hours using the 'hours' field (e.g. 'hours=36' gets you 36 hours ahead), as far as 168 hours ahead.
You can also set the return format of your forecasts as XML, csv, jsv or json using the 'format' field (e.g. 'format=csv' gets you a csv file). Options include 'xml', 'csv', 'jsv' or 'json'. If the 'format' field is omitted you can still view the data in a web browser:
Above: an example of utility scale solar farm forecasting data returned from the API via web browser.
Need more help?
If the above information hasn't answer your question, please contact us via email or using the chat bubble at right & we'll reply as soon as we can! --->
You can also consult our documentation. API documentation specific to the utility scale solar forecasting product is available upon request.