Child pages
  • Solargis API User Guide

Versions Compared

Key

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

...

Data Delivery Web Service

XML request

element namedataDeliveryRequest
defined inhttp://solargis.info/schema/ws-data.xsd
descriptionThe root element of the XML request is the <dataDeliveryRequest> with required attributes 'dateFrom' and 'dateTo' for setting desired data period in the response. Accepted is a date string in the form of  ''YYYY-mm-dd" e.g., "2017-09-30". It is assumed UTC (GMT+00) time zone for both dates unless otherwise specified by the <timeZone> element of the <processing>. 
contentrequired one <site> , required one <processing>
@dateFrom*start of the data period, ''YYYY-mm-dd"
@dateTo*end of the data period, ''YYYY-mm-dd"

Explanation of the table above: The element name is that what you can see in the XML request. If the element is of simple type, the content is a literal (text or number), otherwise the content can be list of another <element> or none. Attribute of the element is prefixed by '@' character. Required attribute is marked by '*' character.

...

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


element nameterrain
defined inhttp://solargis.info/schema/common-geo.xsd
descriptionGround terrain characterized by altitude, terrain slope and terrain azimuth. This element can affect the self shading of a fixed-angle PV array.
contentnone
@elevationoptional, meters above the mean see level. If missing, the value will be taken from SRTM terrain database
@azimuthoptional, orientation of tilted terrain in degrees, 0 for North, 180 for South, clockwise, default is 180, has no meaning for a flat terrain
@tiltoptional, slope tilt of terrain in degrees, 0 for flat ground, 90 for vertical surface, default is 0 (flat)


element namehorizon
defined inhttp://solargis.info/schema/common-geo.xsd
descriptionUser can provide custom skyline for expressing distant or close obstruction features (hills, trees, buildings, poles, etc.)
contentString of this form: space-delimited list of float number pairs [azimuth in degrees:0-360]:[horizon height in degrees:0-90], Example: "<geo:horizon>0:3.6 123:5.6 359:6</geo:horizon>"


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"/>

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

<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

@azimuthorientation of tilted panel surface in degrees, defined as true geographical azimuth (0:north, 90:east, 180:south, 270:west, 360:north), default is 180 deg., the attribute is not defined for a horizontal surface, required only for 'GeometryFixedOneAngle' type
@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 considered 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 hemispheres). The meaning is slightly different for different type of trackers:

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, westing 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 'true' - tracker moves in the way it avoids shading from neighboring tracker constructions.

...