Child pages
  • Solargis API User Guide

Versions Compared

Key

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

...

The purpose of the Solargis API is to provide automated access to Solargis data and services for computers over the web. API is a "user interface" for developers. Developers can automate getting Solargis products by using standard internet protocols (HTTP,  FTP) and integrate Solargis data into their customized solutions ( for evaluation. , monitoring, forecasting, validation, calibration, etc.)


Solargis API
Availability of PV, solar and meteorological dataTechnical features
historicaloperationalreal-time & nowcastand nowcastingNWP forecastlong-term averageprotocoltype of communicationcontent type
Data Delivery Web Service

YES

YESYESYESNOHTTPsynchronousXML
pvPlanner Web ServiceNONONONOYESHTTPsynchronousXML
FTP data deliveryYESYESYESYESNOFTPasynchronousCSV

...

  • Data Delivery Web Service - the main service for accessing Solargis time series data. Both request and response is an XML document. The request parameters (XML elements and attributes) are formally described by XML Schema Definition documents (XSD). By using the schema, request or response can be verified programmatically. For this service, we provide two architectural styles, the REST-like endpoint, and SOAP endpoint. Look for more technical information here.  Authentication and billing is based on API key registered with the user. Please contact us to discuss details, set up trial or ask for a quotation.
  • pvPlanner Web Service - this simple web service provides monthly long-term averaged data (including yearly value) of PV, solar and meteorological data with global coverage. The service is targeted aimed for prospection and pre-feasibility.  Sending By sending an XML request the user mimics the click on the Calculate button in the interactive Solargis pvPlanner application. Request and response for the service is not described in this user guide. More information can be found here.

Additionally, we provide an FTP data delivery service where the request (a CSV file) is stored in the user's FTP directory. The service is then scheduled to deliver CSV response files regularly. Request processing is asynchronous - the client creates the CSV request, the server processes the request according to a schedule (e.g., 4x per day, every hour), the client then checks for the response files. The CSV request allows for multiple locations in one file. For pricing and setting up a trial FTP user account, please contact us.

In the case of the solar and PV time series, we use satellite data since available history up to the present moment plus forecasting additional 4- 5 hours ahead (in the regions where the real-time & nowcasting satellite data is available). Satellite data includes historical (archived) . The range of the satellite data includes historical / archived data, operational data, real-time data and nowcasting dataCloud Motion Vector model (CMV, also called the nowcasting). Historical data ranges up to the last completed calendar month and can be considered as "definitive". Data in the current calendar month up to DAY-1 is so-called "operational", and will be re-analyzed in the beginning of the next month using the final versions version of required data inputs (e.g. atmospheric data parametersmostly aerosol data). Important is to note is that differences introduced with the re-analysis are typically small. Solar data in the current day is comes from the "real-time" satellite model data and will be updated when the current day is finished. Then, based on the latest satellite images, we predict cloud motion vectors (CMV) irradiation by using the CMV model in the range of next 4-5 hours ("nowcasting"). The present moment and a short period before is covered by the nowcasting model data as the very recent satellite scene is still in progress. This delay can take up to 30 minutes (depends depending on the satellite scanning frequency). Later on, after the nowcasting time range, we use post-processed outputs from Numerical Weather Prediction models (NWP). Satellite-based data is seamlessly integrated with NWP forecasting data within one response. In the case of locations where real-time & nowcasting data is not yet available, the NWP data is used for the course of the current day. Also, not every location on the globe is supplied by more accurate high resolution NWP data (ECMWF IFS datamodel). In such case, NOAA GFS model data is used for all forecasted values. Meteorological data (TEMP, WS, AP, RH...) is comprised of NWP (NOAA GFS) modeled comes from the NWP data.

Schema The schema below shows how the data sources are integrated on an example of into the response. The example depicts the Data Delivery Web Service response having total of 9 days of data mixing all data sources (generated at 12:00 of a given day).

Satellite based solar and PV data - from history up to the real-time and nowcasting

Current spatial coverage of satellite data available through the API. Click image to enlarge:

Image RemovedImage Added

Orange regions on the map are accessible via the API and data is updated every day (DAY-1 is available). In the subset of these regions, the real-time /and the nowcasting data is available (within the current day DAY+0, updated every 30 minutes). Main data parameters include GHI, DNI, DIF, GTI, PVOUT.

...

The following table will help users to schedule a time for sending requests to Data Delivery Web Service:

E 1000 UTC (USA), 13:00 UTC (whole region)15-min MFG/MSG 2006-07 UTC10- ahead- (usable via WS)MSG IODC (Middle East, Central and South Asia)30 15 since Feb 2017) 
satellite region (from left to right as on the map)data sincelocal DAY-1 is available at

real-time /and nowcasting

original satellite scanning frequency

GOES-W (America and Pacific)1999-01-0113:30 UTCplanned10 min. (30 min. old GOES-W)
GOES-E (America)1999-01-0110:00 UTC15 min. resolution, 0-5 hours aheadaffected, data updated every 30 - min (usable via WS)., shipping by FTP every 1 hour30 minutes15 min. (30 min. old GOES-E)
MSG/MFG PRIME (Europe and Africa)20051994-01-0103:45 UTC15 - min. resolution, 0-5 hours ahead affected, data updated every 30 - min (usable via WS)., shipping by FTP every 1 hour
15 minutesMTSAT/HIMAWARI (Asia and Pacific)min. (30 min. old MFG PRIME before 2005)
MSG/MFG IODC (Middle East, Central and South Asia)1999-01-0122:40 UTC 15 min. resolution, 0-5 hours affected, data updated every 30 min., shipping by FTP every 1 hour30 15 min. (10 30 min. since Jan 2016old MFG IODC before Feb 2017)MFG
HIMAWARI/1999-01MTSAT (Asia and Pacific)2006-07-0122:40 UTC 15-

10 min. resolution, 0-5 hours

ahead

affected, data updated every 30

-

min

(usable via WS)

., shipping by FTP every 1 hour

10 min. (30 min.
GOES-W (America and Pacific)1999-01-0113:00 UTC (Hawaii)planned30 minutes
old MTSAT before 2016)


Info

Each daily update of the data re-calculates values for two days backward (DAY-1 and DAY-2). Monthly update (on the 3rd day of each calendar month) re-calculates the whole previous month as soon as it's completed. The purpose of these updates is described in this article. We gradually expand spatial coverage of satellite data accessible via API. To request operational and historical data in the grey areas on the map, please use Solargis climData online shop.

The data from orange zones in the map is also available by using interactive application pvSpot (daily operational data) and the data is accessible within minutes after purchase via purchasing in the climData online shop (historical multi-year time series).

Meteorological data from numerical weather models - from history up to the current day

Main data parameters include air temperature (TEMP), wind speed (WS), wind direction (WD), relative humidity (RH) and many others. Historical meteorological data comes from post-processed numerical weather models and it is available globally. The DAY-1 and DAY-2 values are taken from NWP models - NOAA GFS (resp. ECMWF IFS) data sources (they are forecasted values). The preliminary meteorological data from the GFS model is later updated with data from the NOAA CFS v2 data source (re-analyzed archive data). Meteorological data for period DAY-3 and older can be considered as definitive.

Solar, PV and meteorological data from Numerical Weather Prediction (NWP) models - from the current day onward

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

...

Map of NWP forecast coverage (last update 4 Feb 2020):

IFS_forecast_regions_feb2020.pngImage RemovedImage Added

  • violet regions: high resolution, higher reliability forecast data is available in the violet regions marked on the map. Upon request, we can start this kind of forecasting service for any other area. Source: IFS The source is the IFS model from ECMWF, UK. The frequency of the update is at UTC hours 00, 06, 12 and 18 (4 forecasts runs per day, every 6 hours). The forecast range is from DAY+0 up to DAY+32 (three days in a row). Original temporal resolution for the first 48 hours is 1 hour,  hours 4849 - 84 are received in 3-hourly original resolution, however, in the final response, this can be is interpolated into higher desired resolution.
  • the rest of the map (in white color) is covered by lower resolution global forecasting data from the GFS model (NOAA, USA). The forecast range is from DAY+0 up to DAY+9 (the DAY+0 means the current day, so we can deliver 10 full days in total). The frequency of the update is once in 6 hours.

...

parameter

description

GHI

Global Horizontal Irradiation [kWh/m2, Wh/m2 resp. W/m2]
GHI_CClear-sky Global Horizontal Irradiation [kWh/m2, Wh/m2 resp. W/m2]
GHI_UNC_HIGHGHI high estimate (10 % prob. of exceedance) [kWh/m2, Wh/m2 resp. W/m2]
GHI_UNC_LOWGHI low estimate (90 % prob. of exceedance) [kWh/m2, Wh/m2 resp. W/m2]
DNIDirect Normal Irradiation [kWh/m2, Wh/m2 resp. W/m2]
DNI_CClear-sky Direct Normal Irradiation [kWh/m2, Wh/m2 resp. W/m2]
DIFDiffuse Horizontal Irradiation [kWh/m2, Wh/m2 resp. W/m2]
GTIGlobal Tilted Irradiation [kWh/m2, Wh/m2 resp. W/m2]
GTI_UNC_HIGHGTI high estimate (10 % prob. of exceedance) [kWh/m2, Wh/m2 resp. W/m2]
GTI_UNC_LOWGTI low estimate (90 % prob. of exceedance) [kWh/m2, Wh/m2 resp. W/m2]
GTI_CGlobal tilted clear-sky irradiance [W/m2]
CI_FLAGCloud identification quality flag [categories], this parameter is presented as 'flagR' in the response
FLAG_Ralias for CI_FLAG
KTMDeprecated alias of KC. Can be discontinued in future versions.
KCClear-sky index [unitless]
KTclearness index, values range (0, 1.1), during the night -9
PARPhoto-synthetically Active Irradiation [kWh/m2, Wh/m2 resp. W/m2]
SESun Altitude (Elevation) Angle [deg.]
SASun Azimuth Angle [deg.]
TEMPAir Temperature at 2m [deg. C]
TDDew Point Temperature [deg. C]
WBTWet Bulb Temperature [deg. C]
APAtmospheric Pressure [hPa]
RHRelative Humidity [%]
WSWind Speed [m/s]
WDWind Direction [deg.]
PRECPrecipitation Rate [kg/m2]
PWATPrecipitable Water [kg/m2]
PVOUTPhotovoltaic Output [kW, resp. kWh]
PVOUT_UNC_HIGHPVOUT high estimate (10 % prob. of exceedance) [kW, resp. kWh]
PVOUT_UNC_LOWPVOUT low estimate (90 % prob. of exceedance) [kW, resp. kWh]
SWESDWEWater equivalent of accumulated snow depth [kg/m2]
SWEDeprecated alias of SDWE. Can be discontinued in future versions. SDWE will be returned in a response.
TMODModule temperature [deg. C]. This parameter needs a PV system defined in the request.
WGWind Gust [m/s]
WS100Wind speed at 100 m [m/s]
WD100Wind direction at 100 m [deg.]
SFWEWater equivalent of fresh snowfall rate [kg/m2/hour] - no data for 4 most recent months, source ERA5
INCIncidence angle of direct irradiance [deg.], this parameter needs GTI or PVOUT in the request
TILTTilt of inclined surface [deg.], this parameter needs GTI or PVOUT in the request
ASPECTAspect of inclined surface [deg.], this parameter needs GTI or PVOUT in the request

...

element namegeometry
defined inhttp://solargis.info/schema/common-pv.xsd
description

Parametrization of PV system mounting type used for calculating GTI and PVOUT. If this element is missing and GTI/PVOUT is requested, flat-lying PV panels are considered (GTI=GHI). Examples:

<pv:geometry xsi:type="pv:GeometryFixedOneAngle" azimuth="180" tilt="25"/>

<pv:geometry xsi:type="pv:GeometryOneAxisHorizontalNS" rotationLimitEast="-90" rotationLimitWest="90" backTracking="true" axisDeviationazimuth="0180"/>

<pv:geometry xsi:type="pv:GeometryOneAxisInclinedNS" axisTilt="30" rotationLimitEast="-90" rotationLimitWest="90" backTracking="true" axisDeviationazimuth="0180"/>

<pv:geometry xsi:type="pv:GeometryOneAxisVertical" tilt="25" rotationLimitEast="-180" rotationLimitWest="180" backTracking="true"/>

<pv:geometry xsi:type="pv:GeometryTwoAxisAstronomical" rotationLimitEast="-180" rotationLimitWest="180" tiltLimitMin="10" tiltLimitMax="60" backTracking="true"/>

contentnone
@type*

required, concrete type of given geometry. Use one from GeometryFixedOneAngle, GeometryOneAxisHorizontalNS, GeometryOneAxisInclinedNS, GeometryOneAxisVertical, GeometryTwoAxisAstronomical, see table below

@azimuth

the value in degrees of a true geographical azimuth (0: north, 90: east, 180: south, 270: west, 360: north --> a compass value) . In the case of 'GeometryFixedOneAngle' the azimuth attribute is required.

In the case of two tracker types (GeometryOneAxisHorizontalNS, GeometryOneAxisInclinedNS) the value is the compass value at which the southern end of the tracker axis is oriented. Regardless of the Earth's hemisphere. With trackers, the value is limited to the range from 135 deg. to 225 deg. inclusive, so the deviation from the north-south line is not bigger than 45 degrees. With trackers, the attribute is optional and it defaults to 180 deg. (which means the southern end of the axis faces to geographical south, so the tracker field is aligned with the north-south line which is the optimal solution for most cases).

@tilttilt of panel surface in degrees range (0, 90), 0=horizontal, 90=vertical surface, required for 'GeometryFixedOneAngle' and 'GeometryOneAxisVertical' types
@axisTilt

optional, tilt of rotating inclined axis in degrees, 0 = horizontal, 90 = vertical axis, only applicable for 'GeometryOneAxisInclinedNS',

WARNING: if this attribute is missing, the value defaults to 30 degree.

@rotationLimitEast

optional, default is the unlimited motion in the range (-180, 180), used for all trackers. The general rule is: negative value is used for the east side, positive for the west side, the same rule applies for both Earth hemispheres). The meaning is slightly different for different types of tracker:

GeometryOneAxisHorizontalNS: rotation limits are defined as tilt of tracker table relative to its central position (which is horizontal=0 deg.), both limits are typically symmetric, e.g., rotationLimitEast=-50, rotationLimitWest=50

GeometryOneAxisInclinedNS: rotation limits are defined as tilt of tracker table relative to its central position (in this case the inclined plane defined by axisTilt attribute), both limits are typically symmetric, e.g., rotationLimitEast=-50, rotationLimitWest=50

GeometryOneAxisVertical: rotation limits are defined relative to 0 deg. (initial tracker position regardless of hemisphere), default range from -180 to 180 deg (-90 deg. east and +90 deg. west)

GeometryTwoAxisAstronomical: definition (for vertical axis) is the same as with GeometryOneAxisVertical tracker

@rotationLimitWestoptional, westward motion limit, described above
@tiltLimitMinoptional, only used with the horizontal axis of 'GeometryTwoAxisAstronomical' tracker. Limit is defined in the range of degrees (-90, +90), relative to the horizontal position of the tracking surface (0 deg.). Example: tiltLimitMin="0" tiltLimitMax="60", the tracker follows the sun elevation in the range from horizontal position to 60 degree of tilt.
@tiltLimitMaxoptional, max tilt of the tracking surface, described above
@backTrackingoptional boolean value, default is 'false' - tracker moves freely regardless of the neighbors, value is 'true' - tracker moves in the way it avoids shading from neighboring tracker constructions.

...