In this document
You will learn about the Solargis WS API which provides API access to Solargis Monitor, Solargis Forecast, and the Long-Term Averages API. This includes understanding their endpoints, request, response, data capabilities, and how they can be used to integrate Solargis products into your applications.
What is Solargis WS API?
The WS API is the technical name for the Solargis product publicly offered as the Solargis Monitor API, Solargis Forecast API, and the Long-Term Averages API. Previously, it also provided historical time-series data products under the Solargis Evaluate - now migrating into the Historical Time Series API. The WS acronym stands for “web services,” which is part of the product URL: https://solargis.info/ws.
Technically, the WS API operates synchronously, meaning the response is returned immediately after the request within the same transaction. It is also stateless, as the API accepts self-contained requests that do not rely on previously created data.
Solargis WS API endpoints
Currently, Solargis offers two different endpoints in the WS API:
Time Series endpoint
Long-term averages endpoint
The following characteristics are common to both endpoints:
Request and Response Format: Both requests and responses are XML documents, structured and validated according to XML Schema Definition (XSD) documents. This allows you to programmatically validate your requests and responses.
Authentication and Authorization: Access is secured and granted via an API token linked to your account.
Rate Limiting: Usage is subject to rate limits based on your subscription plan.
Time series endpoint
This is the primary endpoint for retrieving time series datasets for Solargis Monitor and Solargis Forecast solutions. Here's what you need to know:
Endpoint URL: https://solargis.info/ws/rest/datadelivery/request
Data Availability: This endpoint offers a broad range of datasets, including PV, solar, and meteorological data. These datasets span from recent historical and operational data to real-time and nowcasting, as well as short and mid-term forecasting. The data is updated at various rates, with some datasets providing rapid updates every few minutes. Availability of data is based on your subscription plan.
Use Case: Ideal for automating solar and PV monitoring or forecasting workflows.
Getting Started: Contact us to set up a trial or request a quotation.
Long-term averages endpoint
This endpoint serves the Long-Term Averages API and provides long-term averages datasets of solar, PV, and meteorological data. Key details include:
Endpoint URL: https://solargis.info/ws/rest/pvplanner/calculate
Data Availability: The datasets provided by this endpoint include 12 monthly and 1 yearly averaged values across multiple sections: climate reference, plane-of-array irradiance with comparisons of different scenarios, PV energy calculations with performance ratio, and a breakdown of energy losses.
Use Case: Focused on prospection and pre-feasibility analysis for PV projects (part of Solargis Prospect).