Child pages
  • Solargis API User Guide

Versions Compared

Key

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

...

The aim of Solargis API is to provide programmatic access to Solargis database and procedures (e.g. PV or GTI calculator) for computers over the web. API is a "user interface" for developers. Developers can automate sending requests and receiving getting Solargis products by using standard web protocols (FTP, HTTP) and integrate values into their processing chain (for evaluation. monitoring, forecasting, validation, calibration etc.). 

 


Solargis API type
Available data (PV, solar, meteorological)Technical features
historicaloperationalreal-time / nowcastNWP forecastlong-term averageweb protocolcommunicationcontent type
FTP API(tick)(tick)(tick)Image Modified(tick)Image Added(error)FTP

asynchronous

CSV
WS API Time Series(tick)(tick)(tick)Image Modified(tick)Image Added(error)HTTPsynchronousXML
WS API Long-term Averages(error)(error)(error)(error)Image Added(tick)HTTPsynchronousXML

Solargis API consists of three endpoints with slightly different capabilitiesfeatures:

  • FTP API - The service can deliver regularly updated PV simulation, solar radiation and meteorological Solargis 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 is scheduled regularly (e.g. once per 12 hours, day, per month) or occasionally. Both request and response are CSV delimited text files , thus they can easily be automated and processed in batch modeallowing multiple locations in one file. For pricing and setting up FTP user account, please contact us. FTP API is also suitable for forecasting.
  • 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 Solargis data in synchronous manner (client waits for server to finish deliver response). Due to performance reason the amount of data within single response is currently limited to period of max. 31 days regardless to data time step. Both request and response are XML documents.  WS WS API request parameters (represented as 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 endpoints, standard SOAP or more light REST-like access. Look for more technical information here Authentication and billing is based on API key registered with the user. Please contact us to discuss details and we will prepare a quotation.
  • WS API Long-term Averages - Standard XML-based Web service provides long-term averaged averages of PV simulation, solar radiation and meteorological data with global coverage. The service is targeted for site prospection and feasibility. The service imitates the click on Calculate button in interactive Solargis pvPlanner application. Request and response for the service is not described in this user guide. Technical information can be found here.

...

Solargis historical, operational and nowcasting data is seamlessly integrated with forecasting data coming from post-processed Numerical Weather Prediction model outputs.

...

Satellite based PV and solar data

Spatial coverage (valid for Oct 2016):

...

We regularly update light orange regions on the map with Solargis operational and historical data. In the dark orange areas Solargis , real-time & nowcasting data is available. Main data parameters include GHI, DNI, DIF, GTI, PVOUT.

available daily
satellite regiondata availability sinceoperational data updatehistorical data update

real-time and

nowcasting

satellite scan frequency

monthly
GOES-EAST1999-01-01every day at 10:00 UTC (USA), 13:00 UTC (whole region)

in the beginning of every month,

whole previous month is re-calculated

to become archived

no30 minutes
MSG2005-01-01every day at 03:45 UTCEurope, Kenya15 minutes
MTSAT / HIMAWARI2006-07-01every day at 22:40 UTCeast East China, Japan

...

30 min. (10 min. since Feb 2016 onward)

Operational data daily update affects two days - yesterday and day before yesterdayDAY-1 and DAY-2. Monthly update covers affects the whole previous month as soon as completed. The purpose of the those updates is described in this article. We gradually expands the spatial coverage of Solargis satellite data accessible via API. For the To access operational and historical data in the gray areas on the map, please use Solargis climData online shop. 

Meteorological data from re-analysed Numerical Weather Model

Main data parameters include TEMP, WS, WD, RH. Meteorological data comes from post-processed numerical weather models and is available globally. The DAY-1 and DAY-2 values are taken from NWP models - NOAA GFS (resp. ECMWF IFS) data source (forecasted valuevalues). The preliminary meteorological data from GFS model are is later updated with data from the NOAA CFS v2 data source (re-analysed archive data). Meteorological data for period DAY-3 or earlier can be considered as definitive.

...

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] - from NWP
  • Global tilted irradiance, GTI [W/m2] - calculated parameter
  • Air temperature at 2 m, TEMP [°C] - from NWP
  • PV electricity output, PVOUT [kWh]  - calculated parameter

...

Parameter name in FTP APIRequiredValue typeValue unitDefault valueValue RangeDescriptionWS API Time Series equivalent (XPath)

lat

Yes

floatdegree -90, 90Latitude/dataDeliveryRequest/site/@lat
lngYesfloatdegree -180, 180Longitude/dataDeliveryRequest/site/@lat
altYesfloatmeters -500, 8848Altitude above relative to sea level/dataDeliveryRequest/site/terrain/@elevation
groundAlbedoNofloat-0.120, 1

Estimated annual value of reflection coefficient expressing amount of ground-reflected radiation, value ranges from zero (no reflection, black surface) to 1 (perfect reflection)

 
geometryNostring-FixedOneAngle
  • FixedOneAngle
  • OneAxisVertical
  • OneAxisInclined
  • OneAxisHorizontalNS
  • OneAxisHorizontalEW
  • TwoAxisAstronomical

Type of surface absorbing solar energy. It can be fixed or sun-tracking. It is assumed this typically is a PV module mounted on some construction.

FixedOneAngle

OneAxisVertical

OneAxisInclined

OneAxisHorizontalNS

OneAxisHorizontalEW

TwoAxisAstronomical

  • fixed surface described by azimuth and tilt
  • single vertical axis tracking
  • tracks sun azimuth
  • tilted surface
  • rotation limits possible
  • back-tracking possible
  • relative column spacing
  • self-shading calculation not implemented
  • single inclined axis tracking
  • tracks sun azimuth
  • tilted surface
  • rotation limits possible
  • back-tracking possible
  • relative column spacing
  • self-shading calculation possible
  • single horizontal axis tracking
  • tracks sun azimuth
  • rotation limits possible
  • back-tracking possible
  • relative column spacing
  • self-shading calculation possible
  • single horizontal axis tracking
  • tracks sun elevation
  • rotation limits possible
  • back-tracking possible
  • relative row spacing
  • self-shading calculation not implemented
  • two axis tracking
  • tracks sun elevation and azimuth
  • rotation limits possible for both axis
  • back-tracking possible
  • relative column spacing
  • self-shading calculation not implemented

/dataDeliveryRequest/site/geometry/@type

In case of WS API Time Series, trackers are theoretical, without rotation limits and backtracking.

tilt

Nofloatdegree00, 90 /dataDeliveryRequest/site/geometry/@tilt
azimuthNofloatdegree0, resp. 1800, 360True north-based azimuth (0=North, 90=East, 180=South, etc.). When this parameter is missing, defaults are following: if "lat" is less than 0 (southern hemisphere), azimuth defaults to 0, otherwise azimuth is 180 (northern hemisphere)./dataDeliveryRequest/site/geometry/@azimuth

...

Code Block
languagehtml/xml
<dataDeliveryResponse>
<site id="site1dummy" lat="48.61259" lng="20.827079">
<metadata>
#HOURLY VALUES OF SOLAR RADIATION AND PV OUTPUT
#
#Issued: 2015-11-13 15:06
#
#Site name: Firstsite
#Latitude: 48.612590
#Longitude: 20.827079
#Elevation: 111.0 m a.s.l.
#http://solargis.info/imaps/#tl=Google:satellite&loc=48.612590,20.827079&z=14
#
#
#Output from the climate database Solargis v2.0.8
#
#Solar radiation data
#Description: data calculated from Meteosat MSG satellite data ((c) 2015
 EUMETSAT) and from atmospheric data ((c) 2015 ECMWF and NOAA) by 
Solargis method 
#Summarization type: hourly
#Summarization period: 28/04/2014 - 28/04/2014
#Spatial resolution: 250 m
#
#
#Service provider: GeoModel Solar s.r.o., M. Marecka 3, Bratislava, 
Slovakia
#Company ID: 45 354 766, VAT Number: SK2022962766
#Registration: Business register, District Court Bratislava I, Section 
Sro, File 62765/B
#http://solargis.info, contact@solargis.info
#
#Disclaimer:
#Considering the nature of climate fluctuations, interannual and 
long-term changes, as well as the uncertainty of measurements and 
calculations, GeoModel Solar s.r.o. cannot take full guarantee of the 
accuracy of estimates. The maximum possible has been done for the 
assessment of climate conditions based on the best available data, 
software and knowledge. GeoModel Solar s.r.o. shall not be liable for 
any direct, incidental, consequential, indirect or punitive damages 
arising or alleged to have arisen out of use of the provided data. 
Solargis is a trade mark of GeoModel Solar s.r.o.
#
#Copyright (c) 2015 GeoModel Solar s.r.o.
#
#
#Columns:
#Date - Date of measurement, format DD.MM.YYYY
#Time - Time of measurement, time reference UTC+1, time step 60 min, 
time format HH:MM, end of the averaging interval
#GHI - Global horizontal irradiation [Wh/m2], no data value -9
#DIF - Diffuse horizontal irradiation [Wh/m2], no data value -9
#DNI - Direct normal irradiation [Wh/m2], no data value -9
#PVOUT - PV output [kWh]
#
#Data:
Date;Time;GHI;DIF;DNI;PVOUT
</metadata>
<columns>GHI DIF DNI PVOUT</columns>
<row dateTime="2014-04-28T01:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
<row dateTime="2014-04-28T02:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
<row dateTime="2014-04-28T03:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
<row dateTime="2014-04-28T04:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
<row dateTime="2014-04-28T05:00:00.000+01:00" values="12.0 10.0 24.0 0.362"/>
<row dateTime="2014-04-28T06:00:00.000+01:00" values="123.0 61.0 314.0 7.642"/>
<row dateTime="2014-04-28T07:00:00.000+01:00" values="288.0 108.0 512.0 22.836"/>
<row dateTime="2014-04-28T08:00:00.000+01:00" values="472.0 128.0 682.0 39.531"/>
<row dateTime="2014-04-28T09:00:00.000+01:00" values="623.0 146.0 752.0 51.373"/>
<row dateTime="2014-04-28T10:00:00.000+01:00" values="710.0 200.0 694.0 56.572"/>
<row dateTime="2014-04-28T11:00:00.000+01:00" values="734.0 244.0 613.0 56.909"/>
<row dateTime="2014-04-28T12:00:00.000+01:00" values="454.0 283.0 208.0 33.365"/>
<row dateTime="2014-04-28T13:00:00.000+01:00" values="466.0 266.0 253.0 32.947"/>
<row dateTime="2014-04-28T14:00:00.000+01:00" values="677.0 248.0 578.0 48.315"/>
<row dateTime="2014-04-28T15:00:00.000+01:00" values="365.0 231.0 204.0 24.423"/>
<row dateTime="2014-04-28T16:00:00.000+01:00" values="462.0 170.0 579.0 28.702"/>
<row dateTime="2014-04-28T17:00:00.000+01:00" values="296.0 110.0 530.0 13.76"/>
<row dateTime="2014-04-28T18:00:00.000+01:00" values="120.0 61.0 269.0 3.287"/>
<row dateTime="2014-04-28T19:00:00.000+01:00" values="6.0 6.0 4.0 0.08"/>
<row dateTime="2014-04-28T20:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
<row dateTime="2014-04-28T21:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
<row dateTime="2014-04-28T22:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
<row dateTime="2014-04-28T23:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
<row dateTime="2014-04-29T00:00:00.000+01:00" values="0.0 0.0 0.0 0.0"/>
</site>
</dataDeliveryResponse>

 

 

(tick)Image Added (tick)Image Added(error)Image AddedFTP

asynchronous

CSV
WS API Time Series(tick)Image Added(tick)Image Added