All Collections
World API
Accessing The World API Outside of the API Toolkit
Accessing The World API Outside of the API Toolkit

Where is my API key? How do I use my API key? How do I make a GET request form The World API? What is my API request?

Ben King avatar
Written by Ben King
Updated over a week ago

If you've had success in with:

You may be moving onto wondering - what's next?

The purpose of The World API feature in the API Toolkit is to walk you through the above basics, for this very reason. It is meant to guide you towards being able to make GET requests from The World API directly, outside of the API Toolkit.

First step - Get your API Key

We've written in detail about how to find your API key in this help article. The simple answer: find it in your 'account' page within the API Toolkit. Direct link to You API Key.

Store your API key in a secure fashion and don't share it with anyone else.

Second step - Create your API request

The API Toolkit will provide you with the exact request you need. Use the 'Recent Requests' table at the bottom of The World API feature page, select 'Download Data' and 'Copy API Url':

The request provided to you will look something like this:

Working our way through the above URL:

We can see this request is for 'world_radiation', meaning is the "Solar Radiation" data option.

It is for the Live data ('estimated_actuals')

And it is for the location of Sydney ('latitude=-33.86882&longitude=151.209295')

It is requesting 7 days worth of data ('hours=168')

And a CSV file format ('format=csv')

You can find all of the details on the various URL parameters and how to formulate API GET requests in our API documentation.

Third step - combine your API request and key

To make your API request, you'll need to combine the API request URL with your API key. Where you'll enter your API key in place of "INSERT_YOUR_API_KEY_HERE".

With the above actions, your API URL is ready to submit, using your software method of choice. For beginners, Solcast recommends you download the free tier version of Postman to get started.

Did this answer your question?