| Table of Contents |
|---|
...
- 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 endpoints - the REST-like endpoint, and the 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.
- LTA 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 aimed for prospection and pre-feasibility. By sending an XML request the user mimics the click on the Calculate button in the interactive Solargis Prospect application. Request and response for the service is not described in this user guide. More information can be found here.
...
Current spatial coverage of the satellite data available through the API.
Regions Regions with the orange color are updated every few minutes (satellite based real-time and nowcasting data are available in the current day). In the yellow regions the satellite data is updated every day (so that DAY-1 is available, see below table for the exact timing). Main solar data parameters include GHI, DNI, DIF (the main calculated parameters are GTI and PVOUT). Map of satellite data regions.
|
...
| satellite data region | historical data start | description of satellites | local DAY-1 is available at | real-time and nowcasting availability |
| GOES WEST | 1999-01-01 | 2019+: GOES-S, 10-minute time step 2018 - 1999: GOES-W, 30-minute time step | 09:00 UTC | Satellite data availability delay is 2-12 minutes and it increases from south to north. Processing frequency is every 10 minutes and it takes another 5-15 minutes. |
| GOES EAST | 1999-01-01 | 2019+: GOES-R, 10-minute time step 2018+: GOES-R, 15-minute time step 2017 - 1999: GOES-E, 30-minute time step | 05:00 UTC | same as the GOES WEST region |
| GOES EAST PATAGONIA | 2018-01-01 | 2019+: GOES-R, 10-minute time step 2018+: GOES-R, 15-minute time step | 05:00 UTC | same as the GOES WEST region |
METEOSAT PRIME SCANDINAVIA between 60°and 65° latitude | 2005-01-01 | 2005+: MSG 15-minute time step | 00:30 UTC | not yet |
| METEOSAT PRIME | 1994-01-01 | 2005+: MSG 15-minute time step 2004 - 1994: MFG, 30-minute time step | 00:30 UTC | Satellite data availability delay is 2-16 minutes and it increases from north to south. Processing frequency is every 15 minutes and it takes another 5-15 minutes. |
| METEOSAT IODC | 1999-01-01 | 2017+: MSG 15-minute time step 2016 - 1999: MFG, 30-minute time step | 22:30 UTC | same as the METEOSAT PRIME region |
| IODC-HIMAWARI | 1999-01-01 | 2017+: HIMAWARI 10-minute time step 2016 - 1999: MFG, 30-minute time step | 16:00 UTC | same as the HIMAWARI region |
| HIMAWARI | 2006-07-01 | 2016+: HIMAWARI 10-minute time step 2015 - 2006: MTSAT, 30-minute time step | 16:00 UTC | Satellite data availability delay is 5-15 minutes and it increases from south to north. Processing frequency is every 10 minutes and it takes another 5-15 minutes. |
...
| Info |
|---|
Each daily update of the data re-calculates satellite 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 the satellite data accessible via API - towards the global coverage. To request operational and historical data in the out-of-coverage areas, please use Solargis climData online shop or contact us. The data from orange covered regions in the map is also available by using in the interactive application pvSpot (daily operational data) and the data is accessible within minutes after purchasing in the climData online shop. |
...
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 creating client code, we provide samples for Python, Java, PHP. For all technical details visit this link.
XML request
Root
| element name | dataDeliveryRequest |
|---|---|
| defined in | http://solargis.info/schema/ws-data.xsd |
| 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" |
...
| 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). |
...