What is an API request? How many API requests do I need?

What is an API request? How many API requests do I need?

What you need to know when requesting data through the Solcast API

What does 'request' mean? How many requests does it take to get the data you need.

What is an API request?

If you've checked out our pricing page, or the Solcast API Toolkit, you'll have likely noticed we talk about 'requests' in reference to our historical data products.

For TMY data products, one request is equivalent to one file for one location.

How many requests do you need?

In order to determine how many requests you'll need, you may need to consider more than just the number of locations you need data for.

This is because each response formats (API speak for 'file format' or 'file type') count as their own request.

As a practical example - if you need both a CSV and a JSON file for one location, you will need two requests (1x location and 2x file formats) to get access to the data you require.

To figure out how many API requests you need for a month, you can use the computation below:

icon
Locations * File formats per location = API requests required

Read more about our response format options in the API Toolkit or in the docs.

image
💡
Helpful Tip You can use our 'unmetered' locations while you practice using the Solcast data APIs. This means you can run as many tests as you need, without using up requests from your included plan. This is useful for testing your code, or implementing the Solcast API in a development environment.

What happens if I’ve run out of request?

In most instances the user’s API request limits are set to reset per Coordinated Universal Time (UTC) day.

This means that the quota of API requests available to the user will refresh at the beginning of each UTC day, providing a standardised and globally recognised time reference. It's crucial for users to be mindful of this reset timing to effectively manage their API usage and ensure uninterrupted access to the desired services. By aligning with the UTC day, this approach ensures a consistent and fair allocation of API resources for users across different time zones, promoting a streamlined and equitable experience for all.