Overview of Solargis API
The purpose of the Solargis API is to provide automated access to Solargis data and services for computers over the web. API is a "user interface" for developers. Developers can automate getting Solargis products by using standard internet protocols (HTTP, FTP) and integrate Solargis data into their customized solutions (for evaluation. monitoring, forecasting, validation, calibration, etc.).
|Availability of PV, solar and meteorological data||Technical features|
|historical||operational||real-time & nowcast||NWP forecast||long-term average||protocol||type of communication||content type|
|Data Delivery Web Service|
|pvPlanner Web Service||NO||NO||NO||NO||YES||HTTP||synchronous||XML|
|FTP data delivery||YES||YES||YES||YES||NO||FTP||asynchronous||CSV|
Table: Description of data available through the Solargis API.
Solargis API consists of two different endpoints:
- Data Delivery Web Service - the main service for accessing Solargis time series data. Both request and response is an XML document. The request parameters (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 architectural styles, the REST-like endpoint, and SOAP endpoint. Look for more technical information here. Authentication and billing is based on API key registered with the user. Please contact us to discuss details, set up trial or ask for a quotation.
- pvPlanner Web Service - this simple web service provides monthly long-term averaged data (including yearly value) of PV, solar and meteorological data with global coverage. The service is targeted for prospection and pre-feasibility. Sending an XML request mimics the click on the Calculate button in the interactive Solargis pvPlanner application. Request and response for the service is not described in this user guide. More information can be found here.
Additionally, we provide an FTP data delivery service where the request (CSV file) is stored in the user's FTP directory. The service is then scheduled to deliver CSV response files regularly. Request processing is asynchronous - the client creates the CSV request, the server processes the request according to schedule (e.g., 4x per day, every hour), the client then checks for the response files. The CSV request allows for multiple locations in one file. For pricing and setting up a trial FTP user account, please contact us.
In the case of solar and PV time series, we use satellite data since available history up to the present moment plus additional 4-5 hours ahead (in the regions where the real-time & nowcasting satellite data is available). Satellite data includes historical (archived) data, operational data, real-time and nowcasting data. Historical data ranges up to the last completed calendar month and can be considered as "definitive". Data in the current calendar month up to DAY-1 is so-called "operational", and will be re-analyzed in the next month using final versions of required data inputs (e.g. atmospheric data parameters). Important to note is that differences introduced with the re-analysis are typically small. Solar data in the current day is from the "real-time" satellite model and will be updated when the day is finished. Then, based on the latest satellite images we predict cloud motion vectors (CMV) in the range of next 4-5 hours ("nowcasting"). The present moment and short period before is covered by the nowcasting model data as the recent satellite scene is still in progress. This delay can take up to 30 minutes (depends on the satellite scanning frequency). Later on, after the nowcasting time range, 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 the case of locations where real-time & nowcasting data is not available, NWP data is used for the course of the current day. Also, not every location on the globe is supplied by more accurate ECMWF IFS data. In such case, NOAA GFS data is used for all forecasted values. Meteorological data (TEMP, WS, AP, RH...) is comprised of NWP (NOAA GFS) modeled data.
Schema below shows how the data sources are integrated on an example of the Data Delivery Web Service response having 9 days of data (generated at 12:00 of a given day).
Satellite based solar and PV data - from history up to real-time
Current spatial coverage of satellite data available through the API. Click image to enlarge:
Orange regions on the map are accessible via the API and data is updated every day (DAY-1 is available). In the subset of these regions, the real-time/nowcasting data is available (within the current day DAY+0, updated every 30 minutes). Main data parameters include GHI, DNI, DIF, GTI, PVOUT.
The following table will help users to schedule a time for sending requests to Data Delivery Web Service:
|satellite region||data since||local DAY-1 is available at|
original satellite scanning frequency
|GOES-E (America)||1999-01-01||10:00 UTC (USA), 13:00 UTC (whole region)||15-min resolution, 0-5 hours ahead, data updated every 30-min (usable via WS), shipping by FTP every 1 hour||30 minutes|
|MFG/MSG PRIME (Europe and Africa)||2005-01-01||03:45 UTC||15-min resolution, 0-5 hours ahead, data updated every 30-min (usable via WS), shipping by FTP every 1 hour||15 minutes|
|MTSAT/HIMAWARI (Asia and Pacific)||2006-07-01||22:40 UTC|
10-min resolution, 0-5 hours ahead, data updated every 30-min (usable via WS), shipping by FTP every 1 hour
|30 min. (10 min. since Jan 2016)|
|MFG/MSG IODC (Middle East, Central and South Asia)||1999-01-01||22:40 UTC||15-min resolution, 0-5 hours ahead, data updated every 30-min (usable via WS), shipping by FTP every 1 hour||30 min. (15 min. since Feb 2017)|
|GOES-W (America and Pacific)||1999-01-01||13:00 UTC (Hawaii)||planned||30 minutes|
Each daily update of the data re-calculates values for two days backward (DAY-1 and DAY-2). Monthly update (on the 3rd day of each calendar month) re-calculates the whole previous month as soon as it's completed. The purpose of these updates is described in this article. We gradually expand spatial coverage of satellite data accessible via API. To request operational and historical data in the grey areas on the map, please use Solargis climData online shop.
The data from orange zones in the map is also available by using interactive application pvSpot (daily operational data) and the data is accessible within minutes after purchase via climData online shop (historical multi-year time series).
Meteorological data from numerical weather models - from history up to current day
Main data parameters include air temperature (TEMP), wind speed (WS), wind direction (WD), relative humidity (RH) and many others. Historical meteorological data comes from post-processed numerical weather models and it is available globally. The DAY-1 and DAY-2 values are taken from NWP models - NOAA GFS (resp. ECMWF IFS) data sources (they are forecasted values). The preliminary meteorological data from the GFS model is later updated with data from the NOAA CFS v2 data source (re-analyzed archive data). Meteorological data for period DAY-3 and older can be considered as definitive.
Solar, PV and meteorological data from Numerical Weather Prediction (NWP) models - from current day onward
Solargis forecast is based on the post-processing of outputs from NWP models. The forecast time series include the following data parameters:
- Global horizontal irradiance, GHI [W/m2] - from NWP
- Direct normal irradiance, DNI [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
- Wind speed at 10 m, WS [m/s] - from NWP
- Wind direction at 10m, WD [°] - from NWP
- Relative humidity, RH [%] - from NWP
- Atmospheric pressure, AP [hPa] - from NWP
- Precipitable water, PWAT [kg/m2] - from NWP
Map of NWP forecast coverage (last update 1 Jan 2020):
- violet regions: high resolution, higher reliability forecast data is available in the violet regions marked on the map. Upon request, we can start this kind of forecasting service for any other area. Source: IFS model from ECMWF, UK. The frequency of the update is at UTC hours 00, 06, 12 and 18 (4 forecasts runs per day, every 6 hours). The forecast range is from DAY+0 up to DAY+3. Original temporal resolution for the first 48 hours is 1 hour, hours 48-84 are received in 3 hourly original resolution, however, in the final response, this can be interpolated into higher resolution.
- the rest of the map (in white color) is covered by lower resolution global forecasting data from the GFS model (NOAA, USA). The forecast range is from DAY+0 up to DAY+10. The frequency of the update is once in 6 hours.
Find more information about the forecast here.
Data Delivery Web Service
The client (most often a computer) will send the XML request and waits for the XML response. Users can test web services directly from the web browser by using e.g. REST Client for Firefox or via a native application 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 also set a header to "Content-Type: application/xml". Then use the XML request examples below and send them in the body of the HTTP request and explore XML responses. Typically, developers will create client code to send requests and handle responses scheduled in time. For all technicalities visit this link. In the next section, there is a description of XML requests with examples. They can serve as starter templates for most typical scenarios.
|description||The 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>.|
|content||required 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.
|description||Complex element with instructions about how response should be generated.|
|content||optional one <timeZone>, optional one <timestampType>|
|@summarization*||required, time frequency in the response. One of YEARLY, MONTHLY, DAILY, HOURLY, MIN_30, MIN_15, MIN_10, MIN_5|
|@key*||required, text value, output data parameters separated by white space. Example: key="GHI GTI TEMP WS PVOUT". See below table for all supported parameters.|
|@terrainShading||optional, 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:
|Global Horizontal Irradiation [kWh/m2, Wh/m2 resp. W/m2]|
|GHI_C||Clear-sky Global Horizontal Irradiation [kWh/m2, Wh/m2 resp. W/m2]|
|GHI_UNC_HIGH||GHI high estimate (10 % prob. of exceedance) [kWh/m2, Wh/m2 resp. W/m2]|
|GHI_UNC_LOW||GHI low estimate (90 % prob. of exceedance) [kWh/m2, Wh/m2 resp. W/m2]|
|DNI||Direct Normal Irradiation [kWh/m2, Wh/m2 resp. W/m2]|
|DNI_C||Clear-sky Direct Normal Irradiation [kWh/m2, Wh/m2 resp. W/m2]|
|DIF||Diffuse Horizontal Irradiation [kWh/m2, Wh/m2 resp. W/m2]|
|GTI||Global Tilted Irradiation [kWh/m2, Wh/m2 resp. W/m2]|
|GTI_UNC_HIGH||GTI high estimate (10 % prob. of exceedance) [kWh/m2, Wh/m2 resp. W/m2]|
|GTI_UNC_LOW||GTI low estimate (90 % prob. of exceedance) [kWh/m2, Wh/m2 resp. 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|
|KTM||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 resp. 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, resp. kWh]|
|PVOUT_UNC_HIGH||PVOUT high estimate (10 % prob. of exceedance) [kW, resp. kWh]|
|PVOUT_UNC_LOW||PVOUT low estimate (90 % prob. of exceedance) [kW, resp. kWh]|
|SWE||Water equivalent of accumulated snow depth [kg/m2]|
|TMOD||Module temperature [deg. C]|
|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] - no data for 4 most recent months, source ERA5|
|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|
|description||Simple element provides time zone in the response (how all timestamps should be shifted from GMT, resp. UTC). Hourly precision is currently supported.|
|content||required, string value in the pattern "GMT[+-][number of hours zero padded]", default value is GMT+00 (=UTC time zone), Example: GMT-04, GMT+05|
|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|
|description||Complex element representing site location, optionally with a PV technology installed|
|content||optional 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|
|@name||optional, any name of the site, default is empty string|
|description||Ground terrain characterized by altitude, terrain slope and terrain azimuth. This element can affect the self shading of a fixed-angle PV array.|
|@elevation||optional, meters above the mean see level. If missing, the value will be taken from SRTM terrain database|
|@azimuth||optional, orientation of tilted terrain in degrees, 0 for North, 180 for South, clockwise, default is 180, has no meaning for a flat terrain|
|@tilt||optional, slope tilt of terrain in degrees, 0 for flat ground, 90 for vertical surface, default is 0 (flat)|
|description||User can provide custom skyline for expressing distant or close obstruction features (hills, trees, buildings, poles, etc.)|
|content||String 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>"|
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"/>
required, concrete type of given geometry. Use one from GeometryFixedOneAngle, GeometryOneAxisHorizontalNS, GeometryOneAxisInclinedNS, GeometryOneAxisVertical, GeometryTwoAxisAstronomical, see table below
|@azimuth||orientation 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|
|@tilt||tilt of panel surface in degrees range (0, 90), 0=horizontal, 90=vertical surface, required for 'GeometryFixedOneAngle' and 'GeometryOneAxisVertical' types|
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.
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
|@rotationLimitWest||optional, westing motion limit, described above|
|@tiltLimitMin||optional, 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.|
|@tiltLimitMax||optional, max tilt of the tracking surface, described above|
|@backTracking||optional 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.|
Table of supported geometries (PV mounting types):
Parametrization of the PV system. Required for simulating PVOUT parameter.
|content||required one <module> element, required one <inverter> element, required one <losses> element, optional one <topology> element,|
required float value (greater than zero). Total installed DC 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.
|@installationType||optional, use one from FREE_STANDING (default), ROOF_MOUNTED, BUILDING_INTEGRATED. This property of the PV system helps to estimate how modules are cooled by air. 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.|
optional string formatted as "yyyy-mm-dd" (example 2015-01-01). Start-up date of the PV system (unpacking of modules). This parameter is used for calculation of degradation of modules caused by aging. If omitted, the degradation is not taken into account.
optional, default is 'false'. The parameter affects PV power calculation for 'GeometryFixedOneAngle' geometry, then 'GeometryOneAxisInclinedNS' and 'GeometryOneAxisHorizontalNS' trackers if backTracking="false". When 'selfShading' is switched on, the simulated PV power is typically lower comparing to standalone PV construction not affected by shading from its neighbors. With trackers, always switch off 'backTracking' attribute, because the back tracking avoids self-shading.
Parametrization of the PV system modules. Required for simulating PVOUT parameter. All modules in one PV system are considered of the same type.
|content||optional one <degradation> element, optional one <degradationFirstYear> element, optional one <nominalOperatingCellTemp> element, optional one <PmaxCoeff> element|
required. 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. For the estimate of module's surface reflectance we use an approach described here.
Estimated annual degradation [%] of rated output power of PV modules. This element is only considered if "dateStartup" attribute of PV system is present. If the element is missing, degradation defaults to 0.5%/year.
|content||required, float number in the range (0, 100), %|
Estimated annual degradation [%] of rated output power of PV modules in the first year of operation. If the element is missing, degradation defaults to 0.8%/year.
|content||required, float number in the range (0, 100), %|
Normal operating cell temperature (NOCT). Float value of the temperature in degrees Celsius of a free standing PV module exposed to irradiance of 800 W/m2 in the ambient air temperature of 20°C and wind speed of 1 m/s. The value is given by manufacturer and for ventilated free-standing PV systems only. If the element is missing, the NOCT value defaults to (based on technology):
|content||required, float number in degrees Celsius|
Negative percent float value representing the change of PV panel output power for temperatures other than 25°C (decrease of output power with raising temperature). This property is given at the STC by manufacturer. If the element is missing, the PmaxCoeff value defaults to (based on technology):
|content||required, float number, percent per degree Celsius (%/°C)|
Parametrization of the PV system inverter. Required for simulating PVOUT parameter. All inverters in one PV system are considered of the same type.
|content||optional one <efficiency> element, optional one <limitationACPower> element|
Efficiency of the inverter. If the element is missing, the efficiency is given as a constant value of 97.5%.
|@type*||required, concrete type of how efficiency of the inverter should be modeled. Use one from EfficiencyConstant, EfficiencyCurve|
required, based on type:
float number, [%]. Value 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's, in fact non-linear, performance. Valid range of this value is typically in the range 70%-100%. For better results, it is recommended to provide inverter's efficiency curve.
text value, pairs of kW:percent. 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 pair delimiter and colon as x:y delimiter. We assume the last point determines the maximum input power of the inverter (with corresponding efficiency). Example of an efficiency curve with the maximum input power of 3 kW is:
<pv:efficiency xsi:type="pv:EfficiencyCurve" dataPairs="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).
Maximum power accepted by the inverter as AC output. Higher power values are 'clipped'. Clipping refers to the situation where the AC power output of an inverter is limited due to the peak rating of the inverter (the parameter value in kW), even though the additional power may still be available from the solar modules. If you have power factor (PF) and AC limit in kVA available, use this formula: PF * AC_limit_kVA = kW, to obtain the value of this parameter.
|content||required, float number, kilowatts [kW]|
Estimation of various PV losses.
|content||optional one <acLosses> element, optional one <dcLosses> element|
Estimation of power losses on the DC side. If the element is missing, the specific DC losses are estimated by default as:
|@snowPollution||annual value of estimated dirt and snow losses [%]|
Distribution of the 'snowPollution' attribute value into 12 monthly average values. Value of the parameter must consist of 12 percent float values delimited by white space. If this parameter is present, it takes precedence over 'snowPollution' attribute. Example:
<pv:dcLosses cables="0.2" mismatch="0.3" monthlySnowPollution="5 5.2 3 1 1 1 1 1 1 1 2 4"/>
|@cables||annual value of estimated DC cabling losses [%]|
|@mismatch||annual value of estimated DC mismatch losses [%]|
Estimation of power losses on the AC side. If the element is missing, the specific AC losses are estimated by default as:
|@transformer||annual value of estimated transformer losses [%]|
|@cables||annual value of estimated AC cabling losses [%]|
The element is for defining PV plant layout on the ground. The reason is to provide inputs for calculation of self-shading impact on PV power (e.g., how close to each other are PV constructions).
|@type*||XML element type, required, concrete type of how topology should be modeled. Use one from TopologyRow (applies for the 'GeometryFixedOneAngle' geometry), TopologyColumn (use for all trackers). It is assumed trackers are spaced equally in both directions (rows and columns) creating a regular grid.|
required, unitless ratio. The attribute specifies the ratio of distance between the neighboring PV table legs and PV table width. Direction of the distance depends on whether topology is specified as TopologyRow or TopologyColumn. See picture below how to calculate the value.
|@type||optional. This parameter estimates a magnitude of loss of PV power when modules are shaded or semi-shaded. The effect depends on wiring interconnections within a module. Shading influence ranges from 0% (no influence) to 100% (full influence) and it is classified into following categories (based on the influence value):|
PROPORTIONAL = 20%
Figure: Calculation of relative row spacing value (= x3/x2).
XML request examples
Example of all options (full request)
Some elements or attributes are mutually exclusive and are commented-out in the listing e.g., user must decide which geometry type to simulate.
Example of fixed mounted PV system
Example of tracking PV system with one horizontal axis in the north-south direction
Example of tracking PV system with one inclined axis in the north-south direction
Example of tracking PV system with one vertical axis
Example of tracking PV system with two axes
The root element of the XML response is the <dataDeliveryResponse> containing one <site> element inside. The <site> element has the 'id' attribute referencing the site in the request. The <site> consists of <metadata> section, one <columns> element and multiple <row> items. The <row> holds timestamp information in the 'dateTime' attribute and the numeric values in space-separated text value of the 'values' attribute. Values are sorted in the same order as their labels in the <columns> element.
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).
FTP data delivery
CSV request examples
FTP delivery request is stored on user's FTP directory. Data request file must have header with input parameter names on a first row. Below header, there can be unlimited number of rows with parameter values (each row is treated as one request). Order of parameters in the header is optional. CSV request for the FTP contract delivery is typically prepared, maintained and validated by Solargis.
Example of regular CSV request for monitoring
Note, there are no "fromDate" and "toDate" parameters. Date period is resolved according to contract and managed by the scheduled automated process.
|PV_plant_example||48.61259||20.827079||20||OneAxisHorizontalNS||0||0||hourly||TRUE||GHI GTI DIF TEMP PVOUT||CSI||FREE_STANDING||40020||98.4||45||-0.45||3.5||2||0.5||0.9||0.8||0.5||0.8||20150701||2.53||TRUE||-45,45||0.5||45||TRUE||UNPROPORTIONAL_1||TRUE|
Example of on-time CSV request
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 to enter.
|Variant_4||48.61259||20.827079||20||FixedOneAngle||180||20||min15||FALSE||GHI GTI DIF TEMP||20120601||20121130||TRUE||0||TRUE||CENTER|
Example of CSV request for forecasting
Note the usage of "forecastFromDay" and "forecastToDay" parameters. In this example data will be send (e.g., every 12 hours) for the period since today (forecastFromDay=0) up to 7 days ahead (forecastToDay=7).
|1||48.612591||17.346977||FixedOneAngle||0||31||hourly||0||7||TRUE||GHI GTI TEMP PVOUT||CSI||FREE_STANDING||100||97.3||45||-0.45||3.5||2||0.8||1||0.5||0.5||0.8||20150521||1.73||1.73||FALSE||1||180||TRUE||UNPROPORTIONAL_1||TRUE||30000||2||START|
CSV response examples
FTP delivery response is stored on user's FTP directory. Responses from this service are files in the Solargis CSV format with title, metadata and data sections. Files are suitable for automated processing. Examples of CSV response files:
- hourly time-series: Solargis_TS_hourly_sample.csv,
- monthly time-series: Solargis_TS_monthly_sample.csv,
- monthly long-term averages: SolarGIS_LTA_monthly_sample.csv