Page Comparison

Table of Contents

...

The client will send the XML request and wait for the XML response. Users can test web services directly by using applications like Postman. Before sending requests user must set the HTTP Method to "POST", define endpoint URL to https://solargis.info/ws/rest/datadelivery/request?key=demo and add the request header "Content-Type: application/xml". Then use one the XML request examples below and include them in the body of the HTTP request and explore XML responses. Typically, developers will create client code to send requests and handle responses. For creating the client code, we provide samples for Python, Java, PHP. For all other technical details visit this link.

...

Table of available data parameters in the XML request:

parameter	description
GHI	Global Horizontal Irradiation [kWh/m2, Wh/m2, W/m2]. Regarding units see below note.
GHI_C	Clear-sky Global Horizontal Irradiation [kWh/m2, Wh/m2, W/m2]
GHI_UNC_HIGH	GHI high estimate (10 % prob. of exceedance) [kWh/m2, Wh/m2, W/m2]
GHI_UNC_LOW	GHI low estimate (90 % prob. of exceedance) [kWh/m2, Wh/m2, W/m2]
DNI	Direct Normal Irradiation [kWh/m2, Wh/m2, W/m2]
DNI_C	Clear-sky Direct Normal Irradiation [kWh/m2, Wh/m2, W/m2]
DIF	Diffuse Horizontal Irradiation [kWh/m2, Wh/m2, W/m2]
GTI	Global Tilted Irradiation [kWh/m2, Wh/m2, W/m2]
GTI_UNC_HIGH	GTI high estimate (10 % prob. of exceedance) [kWh/m2, Wh/m2, W/m2]
GTI_UNC_LOW	GTI low estimate (90 % prob. of exceedance) [kWh/m2, Wh/m2, W/m2]
GTI_C	Global tilted clear-sky irradiance [W/m2]
CI_FLAG	Cloud identification quality flag [categories], this parameter is presented as 'flagR' in the response
FLAG_R	alias for CI_FLAG
KTM	Deprecated alias of KC. Can be discontinued in future versions.
KC	Clear-sky index [unitless]
KT	clearness index, values range (0, 1.1), during the night -9
PAR	Photo-synthetically Active Irradiation [kWh/m2, Wh/m2, W/m2]
SE	Sun Altitude (Elevation) Angle [deg.]
SA	Sun Azimuth Angle [deg.]
TEMP	Air Temperature at 2m [deg. C]
TD	Dew Point Temperature [deg. C]
WBT	Wet Bulb Temperature [deg. C]
AP	Atmospheric Pressure [hPa]
RH	Relative Humidity [%]
WS	Wind Speed [m/s]
WD	Wind Direction [deg.]
PREC	Precipitation Rate [kg/m2]
PWAT	Precipitable Water [kg/m2]
PVOUT	Photovoltaic Output [kW, kWh]. Regarding units see below note.
PVOUT_UNC_HIGH	PVOUT high estimate (10 % prob. of exceedance) [kW, kWh]
PVOUT_UNC_LOW	PVOUT low estimate (90 % prob. of exceedance) [kW, kWh]
SDWE	Water equivalent of accumulated snow depth [kg/m2]
SWE	Deprecated alias of SDWE. Can be discontinued in future versions. SDWE will be returned in a response.
TMOD	Module temperature [deg. C]. This parameter needs a PV system defined in the request.
WG	Wind Gust [m/s]
WS100	Wind speed at 100 m [m/s]
WD100	Wind direction at 100 m [deg.]
SFWE	Water equivalent of fresh snowfall rate [kg/m2/hour] - source ERA5 , the latest data available is approx. one month backward (no data for very recent or forecast period)
INC	Incidence angle of direct irradiance [deg.], this parameter needs GTI or PVOUT in the request
TILT	Tilt of inclined surface [deg.], this parameter needs GTI or PVOUT in the request
ASPECT	Aspect of inclined surface [deg.], this parameter needs GTI or PVOUT in the request

For detailed parameter description see the /wiki/spaces/public/pages/14975030.

Info

Units of solar and PV data parameters

For sub-hourly data the solar and PVOUT value typically represents instantaneous value (a power measured exactly at the given timestamp), so the PVOUT unit will be the kW (or W/m2 in case of solar irradiance).

For hourly and bigger aggregation, the value represents the amount of energy accumulated or averaged within the agg. interval - the unit is the kWh (or Wh/m2, kWh/m2 in case of solar irradiation).

element name

timeZone

defined in

http://solargis.info/schema/data-request.xsd

description

Simple The element provides controls the time zone in the response (how all timestamps should be shifted from GMT, resp. the UTC). Hourly and half-hourly precision is currently supported.

content

required, string value in the pattern "GMT[+-][ number of hours zero-padded hours ][:30]", default value is GMT+00 (=UTC time zone), ExampleExamples: GMT-04, GMT+05:30, GMT-02:30

Full request example for the GHI parameter in the India Standard Time (IST) zone:

Code Block

language	xml

<ws:dataDeliveryRequest dateFrom='2024-04-19' dateTo='2024-04-19' xmlns='http://geomodel.eu/schema/data/request' xmlns:ws='http://geomodel.eu/schema/ws/data' xmlns:geo='http://geomodel.eu/schema/common/geo' xmlns:pv='http://geomodel.eu/schema/common/pv' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
    <site id='Delhi' lat='28.758009' lng='77.296243' name='Delhi' />
    <processing summarization='HOURLY' key='GHI' terrainShading='true'>
        <timeZone>GMT+05:30</timeZone>
        </processing>
</ws:dataDeliveryRequest>

element name	timestampType
defined in	http://solargis.info/schema/data-request.xsd
description	Simple 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 the left (START) or the right (END) edge of the time interval for its label (besides the center).
content	required, one of START, CENTER, END

...

Note

Timestamps used in the XML response comply with the ISO 8601 standard for date and time representation https://en.wikipedia.org/wiki/ISO_8601. Time stamps are also aware of time zone (offset from UTC). Time zone designators are appended after the the time part of timestamp string. If the time is in UTC (https://en.wikipedia.org/wiki/Coordinated_Universal_Time), Z is added directly after the time without a space. Z is the zone designator for the zero UTC offset e.g., 2017-09-22T01:00:00.000Z . If there is an offset from UTC, this is designated by appending +/-HH:MM after the timestamp string, e.g., 2017-09-22T01:00:00.000-05:00 (UTC-5).

...

Versions Compared

Old Version 264

New Version Current

Key

Units of solar and PV data parameters