Child pages
  • Solargis API User Guide

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Solargis API endpoint
Available dataTechnical information
Historic historic dataOperational dataForecast operational / nowcast dataLongNWP forecast datalong-term average dataWeb protocolCommunicationContent type
FTP APIImage Removed(tick)Image Added(tick)(tick)(error)FTP

asynchronous

CSV (request and response)
WS API Time SeriesImage Removed(tick)Image Added(tick)(tick)(error)HTTP (SOAP or REST-like)synchronousXML (request and response)
WS API Long-term Averages(error)(error)(error)(tick)HTTP (SOAP or REST-like)synchronousXML (request and response)

Solargis API consists of three endpoints with slightly different capabilities:

  • Solargis FTP API - The service can deliver regularly updated PV simulation, solar radiation and meteorological data to remote FTP directories. This service provides the most comprehensive set of input parameters. Request processing is asynchronous (client registers a request, server handles the request later, client then checks for the response) and can be done regularly (e.g. once per day, per month) or occasionally. Both request and response are CSV delimited text files, thus they can easily be automated and processed in batch mode. In case of FTP API for operational data, every single day the user is updated by operational data for yesterday. After the calendar month is fully completed, user is shipped with the same data again, because not all inputs are fully ready at the time of the daily update. This process is called re-analysis. There can be a minor difference between operational and re-analysed (archive or final) data. Available amount of requested data is related to available period of the particular data source. Please refer to the map of coverage. For pricing and setting up FTP user account, please contact us. FTP API can be also used for forecasting.
  • Solargis WS API Time Series - This standard Web service is aimed for quickly serving operational and forecast data (PV simulation, solar radiation and meteorological data) in synchronous manner (client waits for server to finish response). Typical usage for the service is performance monitoring, forecasting, comparisons of recorded vs. simulated PV data. Due to performance reason the amount of data within one request is currently limited to period of max. 31 days regardless to time resolution (the same rule applies for daily, hourly or 15-minute time step). Both request and response are XML documents.  WS API request parameters (represented as XML elements and attributes) are formally described by XML Schema Definition documents (XSD). By using  XML schema document, each piece of XML document can be verified programmatically. For this service we provide two endpoint variants, standard SOAP or more light REST-like access. Look for more technical information hereForecast / nowcast data is also available. Authentication and billing is based on API key registered with the user. Please contact us to discuss your specific requirements, and we will prepare a customized quotation for you.
  • Solargis WS API Long-term Averages - Standard XML-based Web service provides long-term averaged PV simulation, solar radiation and meteorological data with global coverage. Suitable for site prospection and feasibility. The service imitates the click on Calculate button in interactive Solargis pvPlanner application. The request and response for the service is not covered in this user guide. Technical information can be found here.

Image Removed Historical archived data is available in ranges according to regions showed in orange color on the coverage map below. For other regions use climData online shop. 

Spatial and Temporal Coverage of Solargis API

Historical and Operational PV and Solar Radiation Data

Image Removed

...

Spatial and temporal coverage of data available through Solargis API

Solargis historical, operational and nowcasting data is seamlessly integrated with forecasting data coming from post-processed Numerical Weather Prediction model outputs. The response can be complied from different data, see example bellow:

Solargis historical, operational and nowcasting data

Image Added

We regularly update light orange regions with Solargis operational data. In the dark orange areas Solargis nowcasting data is available. Solargis historical records are also available.

regiondata available since

operational data update

monthly re-analysis of operational datanowcasting
GOES-EAST1999-01-01every day at 10:00 UTC (USA), 13:00 UTC (whole region)

on 3-rd day of the current month,

previous month is re-calculated

no
MSG2005-01-01every day at 03:45 UTCEurope, Kenya
MTSAT / HIMAWARI2006-07-01every day at 22:40 UTCeast China, Japan

We gradually expands these zones. These regions are available for FTP API and  WS API Time Series. For the gray areas on the map, please use use Solargis climData online shop. Meteorological data from numerical weather model are available globally within its temporal range models is available globally (for more information go here). 

Forecast of PV, Solar Radiation and Meteorological Data

Image Removed

 

...

Numerical Weather Prediction (NWP) forecast data

Solargis forecast is based on post-processing of outputs from NWP models. The forecast time series include the following data parameters in hourly step:

  • Global horizontal irradiance, GHI [W/m2]
  • Global tilted irradiance, GTI [W/m2]
  • Air temperature at 2 m, TEMP [°C]
  • PV electricity output, PVOUT [kWh] (if re)

Map of NWP forecast coverage:

Image Added

  • yellow regions: GFS model from NOAA, USA is available globally with forecasting up to 7 days ahead (today + 7 days = 8 days affected in total). Frequency of the update is once in 12 hours.
  • Violet violet regions: more advanced IFS model from ECMWF, UK. Frequency of the update is once in 12 hours, forecasting today + 3 days ahead (4 days in total). The rest of days (up to 7 days ahead) is covered by GFS model. 

Forecast is based on Solargis post-processing of outputs from numerical weather models. The forecast time series include the following data parameters in hourly step:

  • Global horizontal irradiance, GHI [W/m2]
  • Global tilted irradiance, GTI [W/m2]
  • Air temperature at 2 m, TEMP [°C]
  • PV electricity output, PVOUT [kWh]

Find more information about forecast here.

...