The SolarAnywhere® API (Application Programming Interface) allows users to automate the retrieval of SolarAnywhere data and PV simulations. The API makes it possible to connect SolarAnywhere services to customer-built tools and third-party party software applications. The API is beneficial for customers that would like to:
- Access SolarAnywhere energy modeling services
- Automate fleet performance benchmarking with real-time data and energy simulations
- Continuously ingest the latest solar forecasts from SolarAnywhere
- Streamline access to SolarAnywhere data in third-party PV simulation tools such as PlantPredict
- Retrieve SolarAnywhere data for a large area or fleet
Use of the SolarAnywhere API is included with the purchase of any Sites license or with the purchase of a Typical Year Unlimited license. Additionally, the API is the primary means of data retrieval for SolarAnywhere SystemCheck customers and also can be used to access SolarAnywhere Forecast data.
In addition, Public Sites, which include full historical time-series data through real time, are made available for testing the API—no purchase required!
The information below explains how to get started with the SolarAnywhere API.
Create and Manage API Clients
Please note that you’ll need to be a designated License Manager on a SolarAnywhere account in order to create and manage API clients. Learn more about SolarAnywhere user roles here.
API clients are entities in your SolarAnywhere account that can be used to access your licensed data via the API. They are not tied to specific users on your account, which helps prevent interruptions to automations due to personnel changes. Each API client consists of a user-designated client name and a SolarAnywhere generated API key. The API key is a 64-character unique string that should be treated like a password.
If you’re a license manager on your SolarAnywhere account, you can create an API client by navigating to the License page after signing in and following these steps:
- Scroll down to the section marked “API Client Management”
- Type a name into the text box (the name doesn’t do anything; it’s just a useful identifier)
- Click the “New API Client” button and wait for the pop-up
- Securely store the ApiKey given to you in the pop-up
To keep customer API keys protected, we do not store them. This means we cannot recover a key once the popup is closed. However, keys can be easily re-generated using the method discussed in the instructions and video below.
The “API Client Management” section of the License page in your SolarAnywhere account contains a table displaying all the API clients on your SolarAnywhere license. It displays the names, key prefixes, statuses (active/deactivated) and usage information such as creation time, last used time and several categories of aggregated usage statistics for each client. License managers can rename clients, reset client keys, and suspend or delete clients using the menu that appears upon selecting the three dots in the far right of the table. Resetting a client key will replace the existing key with a newly generated key.
You’ll need to submit a valid SolarAnywhere API key with every SolarAnywhere API request.1 The key should be included as a request header in the following format:
‘X-Api-Key’: “[64-character API key]”
1 API requests made using basic authentication credentials (username and password) previously assigned to your company by the SolarAnywhere team are still valid.