Child pages
  • Solargis API User Guide

Versions Compared

Key

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

...

element nameprocessing
defined inhttp://solargis.info/schema/data-request.xsd
descriptionComplex element with instructions about how response should be generated.
contentoptional one <geometry><timeZone>, optional one <system>, optional one <terrain>, optional one <horizon><timestampType>
@summarization*required, time frequency in the response. One of YEARLY, MONTHLY, DAILY, HOURLY, MIN_30, MIN_15, MIN_10, MIN_5
@key*required, list of output data parameters. Example: key="GHI GTI TEMP WS PVOUT". See below table for all supported parameters.
@*@terrainShadingrequired, site longitude in decimal degrees e.g, 20.827079@optional, any name of the site, default is empty stringoptional, boolean, if 'true', the distant horizon taken from SRTM data is considered, default is 'false' (no horizon obstructions at all), Note: a user can also apply custom horizon data by providing <horizon> element within the <site> element


Table of supported data parameters in the XML request:

parameter

description

GHI

Global Horizontal Irradiation resp. Irradiance [kWh/m2, Wh/m2 resp. W/m2]
GHI_CClear-sky Global Horizontal Irradiation resp. Irradiance [kWh/m2, Wh/m2 resp. W/m2]
GHI_UNC_HIGHGHI high estimate (10 % prob. of exceedance) resp. Irradiance [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 resp. Irradiance [kWh/m2, Wh/m2 resp. W/m2]
DNI_CClear-sky Direct Normal Irradiation resp. Irradiance [kWh/m2, Wh/m2 resp. W/m2]
DIFDiffuse Horizontal Irradiation resp. Irradiance [kWh/m2, Wh/m2 resp. W/m2]
GTIGlobal Tilted Irradiation resp. Irradiance [kWh/m2, Wh/m2 resp. W/m2]
GTI_UNC_HIGHGTI high estimate (10 % prob. of exceedance) resp. Irradiance [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]
KTMClear-sky index [unitless]
KTclearness index, values range (0, 1.1), during the night -9
PARPhotosynthetically Active Irradiation resp. Irradiance [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]
SWEWater equivalent of accumulated snow depth [kg/m2]
TMODModule temperature [deg. C]
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 recent data 4 recent months missing, from ERA5
INCIncidence angle of direct irradiance [deg.]
TILTTilt of inclined surface [deg.]
ASPECTAspect of inclined surface [deg.]


element nametimeZone
defined inhttp://solargis.info/schema/data-request.xsd
descriptionSimple element provides time zone in the response (how all timestamps should be shifted from GMT, resp. UTC). Hourly precision is supported currently.
contentrequired, string value in the pattern "GMT[+-][number of hours zero padded]", default value is GMT+00 (=UTC time zone), Example: GMT-04, GMT+05


element nametimestampType
defined inhttp://solargis.info/schema/data-request.xsd
descriptionSimple element provides how aggregated time intervals in the response should be labeled.

Valid for [sub]hourly summarization. Intervals can be time-stamped at the center (default) or at start or at end. In other words, users can choose left or right edge of the time interval for its label (besides center).

contentrequired, one of START, CENTER, END


element namesite
defined inhttp://solargis.info/schema/data-request.xsd
descriptionComplex element representing site location, optionally with a PV technology installed
contentoptional one <geometry>, optional one <system>, optional one <terrain>, optional one <horizon>
@id*required, site identification, cannot start with number, cannot have white space
@lat*required, site latitude in decimal degrees e.g, 48.61259
@lng*required, site longitude in decimal degrees e.g, 20.827079
@nameoptional, any name of the site, default is empty string

...