This document provides information about production server API call parameters. Use this API endpoint to get the requestId for the Time Series data download from your live Solargis account. You will need the requestId to get Time Series data for your location.
Key points to remember before you proceed:
- You need a live Solargis account and have purchased the Time Series API data subscription.
- You will need to generate an API token to authenticate calls to your account.
- Calls to this API are paid and will deduct credits from your API call allowance.
- You can use the API console to the right to perform the API calls if required. The API console is connected to our production servers. It does not allow you to execute integration API calls. Learn how to use it in the Using the API console guide.
- Parameters and temporal resolutions available via the Time Series API depend on the Time Series API subscription type.
If you have a GTI energy system configured in the Solargis Evaluate application, you can use it to retrieve the Time Series data. You can download the specification and use it in the body of the request directly from the GTI energy system designer.
If you want to download the data in CSV format for further use in PVsyst, set "outpuFormat": "SOLARGIS_CSV" in the request parameters. Beware that PVsyst supports "timeStep": "PT60M" (1 hour) and "timeStep": "P1M" (1 month) only.
Request type: | POST |
URL: | https://api.solargis.com/ts/data-request |
Authorization: | Bearer {API token} |
Body: See the Body parameters section below. | |
Enter your Solargis TimeSeries Bearer token. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
{
"site": {
"latitude": 48.88375,
"longitude": 20.159472,
"siteName": "KB Enterprise Site"
},
"timeStep": "PT15M",
"columns": [
"GHI",
"DNI",
"DIF",
"GHI_NOSHD",
"DNI_NOSHD",
"DIF_NOSHD",
"GTI_NOSHD",
"GTI",
"UVA",
"UVB",
"PAR",
"KT",
"KC",
"CI_FLAG",
"SUN_ELEVATION",
"SUN_AZIMUTH",
"PANEL_AZIMUTH",
"PANEL_TILT",
"PANEL_INC",
"TEMP",
"WS",
"WD",
"WS100",
"WD100",
"WG",
"RH",
"AP",
"PWAT",
"PREC",
"TD",
"WBT",
"SDWE",
"SFWE",
"PM2P5",
"PM10"
],
"outputFormat": "SOLARGIS_JSON",
"compressOutput": true,
"splitOutputByYears": false,
"fromDate": "AUTODETECT",
"toDate": "LAST_MONTH",
"timeAlignment": "CENTER",
"utcOffset": "+01:00",
"terrainShading": true,
"environment": {
"surfaceAlbedo": 0.12,
"horizon": {
"azimuth": [
0.0,
37.5,
60.0,
82.5,
105.0,
127.5,
150.0,
172.5,
195.0,
217.5,
240.0,
262.5,
285.0,
307.5,
330.0,
352.5
],
"height": [
0.705,
1.0588235,
1.058894,
1.428,
0.70588764,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0
]
}
},
"gtiConfiguration": {
"layout": {
"mounting": {
"type": "FIXED_ONE_ANGLE",
"tilt": 39
}
}
},
"fileLabel": "ts_example_request"
}The RH, AP, and PWAT parameters are available for ENTERPRISE subscriptions only.
If true, the output will be split into multiple files, one for each year. The file names will be in the format fileLabel_year.csv or fileLabel_year.json. NOTE: compressOutput has to be set to true.
Start date in ISO 8601 format (YYYY-MM-DD). You can also use the keyword AUTODETECT to automatically select the earliest available start date.
End date in ISO 8601 format (YYYY-MM-DD). You can also use LAST_MONTH or LAST_YEAR for relative date selection.
Surface albedo as a single value or array of 12 monthly values (Jan-Dec)
RequestId retrieved
Invalid authorization
Invalid authorization