Child pages
  • Solargis API User Guide
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 59 Next »

Overview of Solargis API

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


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


WS API Time Series(tick)(tick)(tick)(tick)(error)HTTPsynchronousXML
WS API Long-term Averages(error)(error)(error)(error)(tick)HTTPsynchronousXML

Solargis API consists of three endpoints with slightly different features:

  • FTP API - The service can deliver regularly updated 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 is scheduled regularly (e.g. once per 12 hours, day, month) or occasionally. Both request and response are CSV delimited text files allowing multiple locations in one file. For pricing and setting up FTP user account, please contact us.
  • WS API Time Series - This standard Web service is aimed for quickly serving Solargis data in synchronous manner (client waits for server to deliver response). 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  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 Web service provides long-term averages of PV, solar 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.

Description of data available through WS API Time Series and FTP API

In case of solar and PV time series we use satellite data since history up to present moment plus 4-5 hours ahead. This include historical (archived) data, operational data, real-time and nowcasting data. Historical data spans up to last completed calendar month and can be considered as "definitive". Data in current calendar month up to DAY-1 is "operational" and will be re-analysed in the next month using final data inputs. Important to note is that differences introduced with every update is typically small. Data in current day are from "real-time" satellite model and will be updated when day finishes. Then, based on last satellite scenes we predict cloud motion in period in next 4-5 hours ("nowcasting"). The present moment and short period before is covered by "nowcasting" data as the last satellite scene is still in progress. This delay can take up to 30 minutes (depends on satellite scan frequency). After nowcasting period 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 case of locations where real-time & nowcasting data is not available, NWP data is used for the whole current day. Also, not every location is supplied by ECMWF IFS data, in this case NOAA GFS data is used for all forecasted values. 

Schema below is valid for solar and PV data only. The schema shows how data sources are integrated into API response having in this case 9 days of data (generated at 12:00 noon of given day).

Satellite based PV and solar data

Spatial coverage of data available through API (valid for Oct 2016), click map to enlarge:

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

satellite regiondata availability sincehistorical data updateoperational data update

real-time &


satellite scan frequency


in the beginning of every month,

whole previous month is re-calculated

and archived

every day at 10:00 UTC (USA), 13:00 UTC (whole region)no30 minutes
MSG2005-01-01every day at 03:45 UTCpart of Europe, Kenya15 minutes
MTSAT / HIMAWARI2006-07-01every day at 22:40 UTCEast China, Japan30 min. (10 min. since Jan 2016 onward)

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

Note: the data from orange zones in the map is also available by using interactive application pvSpot (daily operational data) and is accessible within minutes when purchased via climData online shop (historical archived data).

Meteorological data from re-analysed numerical weather models

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 values). The preliminary meteorological data from GFS model 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.

PV, solar and meteorological data from Numerical Weather Prediction (NWP) models

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

  • 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

Map of NWP forecast coverage:

  • yellow regions: GFS model from NOAA, USA is available globally with forecasting up to 7 days ahead (today + 7 days = 8 days in total). Frequency of the update is once in 12 hours.
  • 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.

Find more information about forecast here.

Request Parameters

Most comprehensive set of parameters comes with FTP API. Subset of the parameters is exposed via WS API Time Series. Following list of parameters is created with regards to FTP API (CSV request). The last column shows the parameter availability in WS API Time Series. We use standard XPath notation to describe parameter location within XML request. More information about XML schema used in WS API Time Series can be found here.

Location and Solar Resource Related Parameters

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



floatdegree -90, 90Latitude/dataDeliveryRequest/site/@lat
lngYesfloatdegree -180, 180Longitude/dataDeliveryRequest/site/@lat
altYesfloatmeters -500, 8848Altitude 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)

  • 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.







  • 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


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


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

PV System Related Parameters

PV required parameters are required in case of PV output data is requested. For requesting solar radiation or meteorological data alone, PV parameters are not needed at all.

Parameter name in FTP APIRequiredValue typeValue unitDefault valueValue RangeDescriptionWS API Time Series equivalent (XPath)
pvInstalledPowerYesfloatkWp 0.1 - 100000Total installed power of the PV system in kilowatts-peak (kWp). The total PV system rating consists of a summation of the panel ratings measured in STC./dataDeliveryRequest/site/system/@installedPower
dateStartupNostring   String formatted as "yyyy-mm-dd" (example 2015-01-01). Start up date of PV system (resp. unpacking of modules). This parameter is used for calculation of degradation (or aging) of modules. If omitted, degradation is not taken into account./dataDeliveryRequest/site/system/@dateStartup
This property of the PV system helps to estimate how modules are ventilated. For sloped roof with PV modules on rails tilted at the same angle as the roof choose 'ROOF_MOUNTED' value. For PV modules incorporated into building facade choose 'BUILDING_INTEGRATED' value. This option is considered as the worst ventilated. As the best ventilated option is considered free standing installation. This typically means stand-alone installation on tilted racks anchored into the ground. Also choose this option if a PV system is installed on a flat roof (similar to stand-alone installation). The string value is in this case ''FREE_STANDING'./dataDeliveryRequest/site/system/@installationType
pvTrackerRotMinNostringpair of degrees-180,180
 Parameter is a pair of limiting rotation angles for OneAxisVertical, OneAxisInclined, OneAxisHorizontalNS and TwoAxisAstronomical (its vertical axis) mounting geometries. If the tracker is purely theoretical (no limits) the default value of "-180,180" is used. 
pvTrackerRotMin2Nostringpair of degrees-90,90
 Parameter is a pair of limiting tilt angles for TwoAxisAstronomical (its horizontal axis) and OneAxisHorizontalEW trackers. Because of technical realizations of variable tilt often a linear actuator is used. Inclination angle seldom varies beyond 0 to 90, more often, it has smaller range e.g. "10,80". If the tracker is purely theoretical (no limits) the default value of "-90 to 90" should be used. Selecting tilt limits of "45,45" turns OneAxisHorizontalEW tracker to the FixedOneAngle system with tilt of 45 degree and TwoAxisAstronomical tracker to the OneAxisVertical tracker. 
pvTrackerBackTrackNostring FALSETRUE or FALSEDefault value "FALSE" corresponds to a single axis tracker without neighbors (best possible) with specified rotation limits (pvTrackerRotMin or/and pvTrackerRot2Min). Implemented for all trackers. 
pvFieldSelfShadingNostring FALSETRUE or FALSEThe parameter affects FixedOneAngle geometry, then OneAxisHorizontalNS and OneAxisInclined type of trackers with pvTrackerBackTrack=FALSE. When pvTrackerBackTrack=TRUE, the parameter does not make sense as self-shading is avoided. No other options are implemented. It is used to determine the impact of self (inter-row) shading on PV power production. When set to TRUE, the effect of self-shading is taken into account in calculation, otherwise the geometry is assumed without neighbors (best possible). 
pvFieldColumnSpacingRelativeNofloat no spacing = isolated module
 The parameter has effect only in case of tracking system when pvTrackerBackTrack is TRUE. It specifies the ratio between distance between the equivalent trackers legs (axis) and PV collector width. Affected are trackers TwoAxisAstronomical, OneAxisVertical, OneAxisInclined, OneAxisHorizontalNS. 
pvFieldRowSpacingRelativeNofloat no spacing = isolated module
In case of trackers the parameter has effect only when pvTrackerBackTrack is True. It specifies the ratio between distance of the equivalent trackers legs (axis) and PV collector width. Affected are trackers TwoAxisAstronomical and OneAxisHorizontalEW. Moreover, it affects FixedOneAngle system together with the parameter pvFieldSelfShading set to TRUE (self-shading impact is then included in calculation)./dataDeliveryRequest/site/system/topology/@relativeSpacing
pvFieldTerrainSlopeNofloatdegree00, 90Slope of terrain, applied only when calculating self-shading effect of PV system with FixedOneAngle geometry. Defined in the same way as the parameter "tilt"./dataDeliveryRequest/site/terrain/@tilt
pvFieldTerrainAzimuthNofloatdegree1800,360Azimuth of sloped terrain, applied only when calculating self-shading effect of PV system with FixedOneAngle geometry. Defined in the same way as the parameter "azimuth"./dataDeliveryRequest/site/terrain/@azimuth
  • PROPORTIONAL for all other module technologies

This parameter estimates a loss of PV system output when modules are self-shaded. The effect depends on wiring interconnection within a module. Shading influence ranges from 0% (no influence) to 100% (full influence) and is mapped to categories:


When parameter is missing at all, the self-shading influence is estimated to 5 %.

  • CSI
  • ASI
  • CDTE
  • CIS
Enumerated codes for materials used in PV modules. Use 'CSI' for crystalline silicon, 'ASI' for amorphous silicon, 'CDTE' for cadmium telluride, 'CIS' for copper indium selenide./dataDeliveryRequest/site/system/module/@type
pvModuleDegradationNofloatpercent0.50, 100Estimated annual degradation of rated output power of PV modules. This parameter is only considered if "dateStartup" parameter is set./dataDeliveryRequest/site/system/module/degradation
pvModuleDegradationFirstYearNofloatpercent0.80, 100Estimated annual degradation of rated output power of PV modules in the first year of operation. If this parameter is not set, but "pvModuleDegradation" is present, the value of "pvModuleDegradation" will be used, otherwise default value 0.8% is considered. This parameter is only considered if "dateStartup" parameter is set./dataDeliveryRequest/site/system/module/degradationFirstYear
pvModuleSurfaceReflectanceNofloat 0.160, 1Empirical dimensionless coefficient, which is used to estimate PV power loss due to angular reflectivity of PV module surface. This parameter includes not only optical properties of covering glass, but also glass coating and dirt. Typical values for commercially available PV modules are 0.16 - 0.17 for clean surfaces, 0.20 for moderate dirty and 0.27 for dirty surface./dataDeliveryRequest/site/system/module/surfaceReflectance
pvModuleTempNOCTNofloatdegree Celsius

according to "pvModuleTechnology":

  • CSI=46°C
  • ASI=44°C
  • CDTE=45°C
  • CIS=47°C
 Normal operating cell temperature. Float value of the temperature in degrees Celsius of a free standing PV module exposed to irradiance of 800 W/m2 and ambient air temperature of 20°C and wind speed is 1 m/s. The value is given by manufacturer and only for ventilated free standing PV system./dataDeliveryRequest/site/system/module/nominalOperatingCellTemp
pvModuleTempCoeffPmaxNofloatpercent per degree Celsius

according to "pvModuleTechnology":

  • CSI=-0.438%/°C
  • ASI=-0.18%/°C
  • CDTE=-0.297%/°C
  • CIS=-0.36%/°C
 Negative percent float value representing the change in PV panel output power for temperatures other than 25°C (decrease of output power with raising temperature). This property is given at STC by manufacturer./dataDeliveryRequest/site/system/module/PmaxCoeff
pvInverterEffConstantNofloatpercent97.50, 100Value of inverter's efficency known as Euro or CEC (California Energy Commission) efficiency. This value is a calculated weighted efficiency given by manufacturer. It gives a simplified picture about an inverter, in fact non-linear performance. Valid range of this value is practically 70%-100%. For better results, it is recommended to provide inverter efficiency curve (by using parameter "")./dataDeliveryRequest/site/system/inverter/efficiency/@percent
pvInverterEffCurveDataPairsNostringkW/percent pairs  Efficiency of inverter is of non-linear nature, so it can be described as simplified curve defined as list of data points. Data point on the curve is defined by coordinates, where the x coordinate is absolute float value of input power in kilowatts (kW) and y coordinate is percent float value of the corresponding inverter's efficiency (%). This parameter accepts string value of this pattern: 'x1:y1 x2:y2 x3:y3 xn:yn'. A dot should be used as decimal separator, white space as a point delimiter and colon as x:y delimiter. We assume the last point determines the maximum input power of the inverter (with corresponding efficiency). Example efficiency curve of an inverter with the maximum input power of 3 kW is '0:85.6 0.5:96.2 1:98 1.5:97 2:97 2.5:96 3.0:96'. It is assumed, that one efficiency curve is valid for all inverters of the PV system (their powers are summed)./dataDeliveryRequest/site/system/inverter/efficiency/@dataPairs
pvLossesDCOtherNofloatpercent5.40, 100Estimated integration of specific other DC losses (see pvLossesDCMismatch, pvLossesDCCables and pvLossesDCPollutionSnow parameters) into one number. Maximum simplification for DC losses./dataDeliveryRequest/site/system/losses/@dc
pvLossesDCMismatchNofloatpercent1.00, 100Share of estimated mismatch losses within the value of pvLossesDCOther parameter./dataDeliveryRequest/site/system/losses/dcLosses/@mismatch
pvLossesDCCablesNofloatpercent2.00, 100Share of estimated cabling losses within the value of pvLossesDCOther parameter./dataDeliveryRequest/site/system/losses/dcLosses/@cables
pvLossesDCPollutionSnowMonthNostringformatted list of float percent  Distribution of the pvLossesDCPollutionSnow value into 12 average months. Example: "5.0,2.0,2.0,2.0,0.0,0.0,0.0,0.0,0.0,2.0,5.0,8.0". Value of the parameter must consist of 12 percent float values delimited with comma. If this parameter has a value, it takes precedence over pvLossesDCPollutionSnow parameter./dataDeliveryRequest/site/system/losses/dcLosses/@monthlySnowPollution
pvLossesDCPollutionSnowNofloatpercent2.50, 100Share of estimated dirt and snow losses within the value of pvLossesDCOther parameter./dataDeliveryRequest/site/system/losses/dcLosses/@snowPollution
pvLossesACNofloatpercent1.50, 100Estimated integration of specific AC losses (see pvLossesACCable and pvLossesACTransformer parameters) into one number. Maximum simplification for AC losses./dataDeliveryRequest/site/system/losses/@ac
pvLossesACCableNofloatpercent0.50, 100Share of estimated cabling losses within the value of pvLossesAC parameter./dataDeliveryRequest/site/system/losses/acLosses/@cables
pvLossesACTransformerNofloatpercent1.00, 100Share of estimated transformer losses within the value of pvLossesAC parameter./dataDeliveryRequest/site/system/losses/acLosses/@transformer

Parameters Controlling Request Processing

Parameter name in FTP APIRequiredValue typeValue unitDefault valueValue RangeDescriptionWS API Time Series equivalent (XPath)
siteIdYesstring   Unique identification of one request (one row in CSV request). example: "DETROIT_roof_1"/dataDeliveryRequest/site/@id
fromDateNostring   String formatted as "yyyy-mm-dd" (example "2015-01-01"). Date is assumed in UTC. Only required when requesting historical data by occasionally processed request. For regularly processed requests, avoid of using it (automated process will resolve it). Actual values differ according to data availability, see the coverage map. /dataDeliveryRequest/@dateFrom
toDateNostring   String formatted as "yyyy-mm-dd" (example "2015-01-01"). Date is assumed in UTC. Only required when requesting historical data by occasionally processed request. For regularly processed requests, avoid of using it (process will resolve it according your contract). Required when requesting historic data. The value should not exceed the date of TODAY-1 (yesterday), but actual possible value differs according to data availability, see the coverage map.  /dataDeliveryRequest/@dateTo
forecastFromDayYes (if forecast is needed)integer   In case of FTP API, forecast processing is indicated by file name of the CSV request file. Then this parameters are taken into account. 
forecastToDayYes (if forecast is needed)integer   In case of FTP API, forecast processing is indicated by file name of the CSV request file. Then this parameters are taken into account. 
  • min15
  • min30
  • hourly
  • daily
  • monthly
  •  yearly
This parameter defines time resolution of output data. Original satellite and meteorological data are in various time steps (e.g. MSG satellite: 15 min, GOES-EAST satellite: 30 min, GFS weather model: 3 hour). When finer summarization is requested, the data will be interpolated into desired time step. In other words, you can request time resolution of 10 minutes even if the original dataset is not available in such resolution. The "monthly-longterm" summarization means 12 long-term monthly averaged entries + 1 annual entry i the response./dataDeliveryRequest/processing/@summarization
  • GHI
  • DNI
  • DIF
  • GTI
  • SE
  • SA
  • TEMP
  • AP
  • RH
  • WS
  • WD

The white-space-separated list of variable codes which will be included in the response (example: "GHI DIF TEMP WS WD"):

  • GHI: Global horizontal radiation, (W/m2 for instantaneous values, Wh/m2 for hourly values, kWh/m2  for daily, monthly and yearly values).
  • DNI: Direct normal radiation, (W/m2 for instantaneous values, Wh/m2 for hourly values, kWh/m2  for daily, monthly and yearly values).
  • DIF: Diffuse horizontal radiation, (W/m2 for instantaneous values, Wh/m2 for hourly values, kWh/m2  for daily, monthly and yearly values).
  • GTI: Global tilted radiation, (W/m2 for instantaneous values, Wh/m2 for hourly values, kWh/m2  for daily, monthly and yearly values). Consider setting up the "geometry", "azimuth" and "tilt" parameters, otherwise default will be horizontal surface.
  • SE: Sun altitude (elevation) angle (degrees).
  • SA:  Sun azimuth angle (degrees).
  • TEMP: Air temperature at 2 m (degrees Celsius).
  • AP: Atmospheric pressure (hPa).
  • RH: Relative humidity (%).
  • WS:  Wind speed at 10 m (m/s)
  • WD: Wind direction (degrees), true north-based azimuth. Do not request this variable in time steps above "hourly".
  • PVOUT: Output from PV system (kW for instantaneous, otherwise kWh). Consider setting up "geometry" and related parameters and required PV-related parameters.
timeZoneNoint 0 (=UTC+0)-12, 12Signed integer. Time zone with hourly precision. Value defines the time zone of output data and it is used for all summarizations. For daily and monthly summarization, the time zone it is activated automatically in the background. This is important for summarization of whole days, otherwise daily summary in UTC+0 would for Japan or Hawaii end up in putting together data from two different local days. For hourly and shorter time steps time zone must be specified, otherwise UTC+0 is used. All the satellite model results are calculated and internally stored in UTC+0. Therefore depending on the requested time zone value, the data reader automatically extends period from which data are read to acquire completed local day. For example, one whole day D (0-24h) in the time zone of UTC-5 will be read from UTC database as D (5-24 hours) and D+1(0-5 hours)./dataDeliveryRequest/processing/timeZone, timeZone must be in format \"GMT+hh\" or \"GMT-hh\"
timeStampTypeNostring CENTER
  • END
The parameter can be used in hourly or even in sub-hourly time steps when averaging of more values occurred within time interval. Example: let's say the value is the result of averaging of more occurrences within hourly interval from 15:00 to 16:00. If the value of the parameter is "CENTER", the value is time-stamped at 15:30, in case of "END" at 16:00 and finally "START" at 15:00./dataDeliveryRequest/processing/timeStampType
satelliteTimeStampNostring TRUETRUE or FALSEThis parameter is used to preserve time stamp of satellite data acquisition. The data for given position are recorded by satellite in exact moment given by scanning speed of the instrument. For example MSG data scan starts nearby south pole at time T and data for Europe are recorded with 10-13 minutes delay from nominal (start) scan time. To present the original satellite information and avoid degradation of the information content by temporal interpolation it is good to preserve local time stamp of satellite data acquisition. 
terrainShadingNostring FALSETRUE or FALSEApply or not terrain (or horizon) shading (whether default SRTM terrain or local horizon passed by user)./dataDeliveryRequest/processing/@terrainShading
userHorizonNostring   Formatted string describing custom local horizon. The horizon can be in any resolution, it will be interpolated internally. Example (sun azimuth:sun elevation pairs): 0:16.2,0.5:16.2,1:16,1.5:16,2:16,2.5:16,3:15.8,...358.5:16,359:16.2. Azimuth is true north-based (North=0 degree)./dataDeliveryRequest/site/horizon
activeNostring TRUETRUE or FALSEUser can toggle if particular request (=site, =row in CSV request file) should be processed or not. 

Request Examples


Data request CSV file must have header with parameter names on a first row. Below header, there can be unlimited number of rows with parameter values (site requests). Order of parameters is optional.

Regular data request example

Note, there are no "fromDate" and "toDate" parameters. Date period is resolved according to contract and managed by the automated process.

PV_plant_example48.6125920.82707920OneAxisHorizontalNS00hourlyTRUEGHI GTI DIF TEMP PVOUTCSIFREE_STANDING4002098.445-0.453.520.,450.545TRUEUNPROPORTIONAL_1TRUE

On-time data request example

Parameters "fromDate" and "toDate" are required in this case. Such request is processed only once. Note, only radiation and temperature is requested in this case, so no PV system settings are needed. 

Variant_448.6125920.82707920 FixedOneAngle18020min15FALSEGHI GTI DIF TEMP2012060120121130TRUE0TRUECENTER

Forecast data request example

Note the usage of "forecastFromDay" and "forecastToDay" parameters. Typically data will processed each 12 hours forecasting period since today (forecastFromDay=0) up to 7 days ahead (forecastToDay=7).

148.61259117.346977FixedOneAngle031hourly07TRUEGHI GTI TEMP PVOUTCSIFREE_STANDING10097.345-0.453.520.810.50.50.8201505211.731.73FALSE1180TRUEUNPROPORTIONAL_1TRUE300002START

Minimalist PV data request example

Note, degradation is not considered (missing "dateStartup" parameter).

PV_plant_example48.6125917.65040220FixedOneAngle1800hourlyGHI GTI DIF TEMP PVOUTCSIFREE_STANDING100TRUE

Minimalist solar radiation data request example

MySite148.6125917.65040220hourlyGHI DIF TEMPTRUE

WS API Time Series

There is no regularly processed request in case of this standard synchronous web service. Instead, the client will post the request and wait for the response. For technicalities visit this link. Developer can test various requests directly from web browser by using e.g. REST Client for Firefox. From within REST Client set HTTP Method to "POST", endpoint URL to: and also set header "Content-Type: application/xml". Then post the examples below in the body of the request and explore responses. Note, there is a limit of max. 31 days within requested date period. Typically, developer will create client code to post requests and handle responses. This client code can be created based on XSD schema documents by multiple libraries (JAXB for Java, PyXB for Python etc.)

Data request example

Setting "dateFrom" and "dateTo" is required in all cases. User can control time zone for output data in two ways. Either by using "timeZone" element or by the "dateFrom" and "dateTo" attributes of "dataDeliveryRequest" element. The "timeZone" element takes precedence over "dateFrom" and "dateTo" attributes.

<ws:dataDeliveryRequest dateFrom="2014-04-28+01:00" dateTo="2014-04-28+01:00"
    <site id="site1dummy" lat="48.61259" lng="20.827079">
        <geo:terrain elevation="111" azimuth="112" tilt="11"/>
        <geo:horizon>0:5 7.5:3 15:7 22.5:0</geo:horizon>
        <pv:geometry xsi:type="pv:GeometryFixedOneAngle" azimuth="165" tilt="22"/>
        <pv:system installedPower="100" installationType="FREE_STANDING" dateStartup="2011-06-01">
            <pv:module type="CSI">
                <pv:powerTolerance low="3" high="3"/>
                <pv:efficiency xsi:type="pv:EfficiencyConstant" percent="94"/>
                <pv:acLosses cables="1" transformer="2.1"/>
                <pv:dcLosses cables="1.2" mismatch="0.65" monthlySnowPollution="4 2 3 4 5 7 8 4 7 4 5 1"/>
            <pv:topology xsi:type="pv:TopologySimple" relativeSpacing="2.5"/>
    <processing key="GHI DIF DNI PVOUT" summarization="HOURLY" terrainShading="true">

Forecast data request example

There is no difference between historical an forecast data request. Note, there are no "forecastFromDay" and "forecastToDay" parameters as with FTP API. Instead, user has to explicitly set the date period needed to be forecast-ed (max. 7 days ahead). Following request will give 8 days forecast-ed in total. The request below also shows minimalist settings needed for getting PV production (note that "inverter" and "losses" elements are mandatory even if they are empty) .

<ws:dataDeliveryRequest dateFrom="2015-11-13+01:00" dateTo="2015-11-20+01:00"
    <site id="site1dummy" lat="48.61259" lng="20.827079">
        <pv:geometry xsi:type="pv:GeometryFixedOneAngle" azimuth="165" tilt="22"/>
        <pv:system installedPower="100" installationType="FREE_STANDING" dateStartup="2011-06-01">
            <pv:module type="CSI"/>
    <processing key="GHI DIF DNI PVOUT" summarization="HOURLY">

Minimalist solar data request example

<ws:dataDeliveryRequest dateFrom="2015-02-15" dateTo="2015-02-15"
    <site id="site1" lat="48.61259" lng="20.827079"/>
    <processing key="GHI DIF DNI" summarization="MIN_15"/>


Response Examples

FTP API response

Responses from this service are standard Solargis CSV format files with header, metadata and data sections. Files are suitable for automated processing. Examples of CSV response files: 

WS API Time Series response

Content of metadata element match with the metadata used in Solargis CSV format file.

<site id="site1dummy" lat="48.61259" lng="20.827079">
#Issued: 2015-11-13 15:06
#Site name: Firstsite
#Latitude: 48.612590
#Longitude: 20.827079
#Elevation: 111.0 m a.s.l.
#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, 
#Company ID: 45 354 766, VAT Number: SK2022962766
#Registration: Business register, District Court Bratislava I, Section 
Sro, File 62765/B
#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.
#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]
<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"/>



(tick) (tick)(error)FTP


WS API Time Series(tick)(tick)
  • No labels