What is an API key? How do I use my API key?

What is an API key? How do I use my API key?

Methodology

Resolution and Accuracy
Solar and Weather
Power and Tuning
Data Sources and FAQ

Commercial Products

Commercial User GuideCommercial User Guide
Live and Forecast
Historic
Typical Meteorological Year (TMY)
Grid Aggregations
Geographic Horizon Angles

Hobbyist and Research Products

Home Hobbyist Accounts
Researchers and Academic Accounts

Help & Support

Changes and Announcements
Plans And Subscriptions
Evaluation and Testing
Authentication
Developer Guides
Third Party Applications
Troubleshooting and FAQs

Access helpful information about Solcast APIs

Before you can access our servers, an API key is required. Here's what you need to know about our API, where to find it, and how to use it. Register for a Solcast API toolkit to help you better understand.

API stands for “Application Programming Interface”. These are widely used for two-way communication of information. You use APIs all of the time on your smartphone, as your favourite apps upload and download information from 'the cloud'.

Solcast offers a number of APIs so that you can access our live and forecast data in an automated fashion. This makes it ready for inclusion in your own application.

We also offer an easy to use API Toolkit for newcomers who aren't familiar with them, where you can download sample files from our API in their standard format for desktop analysis.

In order to access our servers, you will need an API key, which is unique to your account.  You can find this in the 'Account' page once logged into the API Toolkit. You won't need the API Key while using the API Toolkit directly, but you will need it if you want to download our data from outside the API Toolkit (e.g. in your own software code).

If you are logged into the API Toolkit, you can find your API key when you click ‘Your API Key’ from the dropdown list shown below.

image

You can find detailed instructions in our API documentation.