Request type: | POST |
URL: | https://api.solargis.com/ts-integration/data-request/ |
Authorization: | Bearer {API token} |
Body parameters: | See the specification below |
In this guide, we will provide information about how to set up the Time Series API integration to obtain the requestId required for obtaining the location data. The endpoint provided here is for integration purposes only and does not allow you to download location data from your live Solargis account.
Once you obtain the integration requestId, you can proceed to get the sample location data to understand the response.
Key points to remember before you proceed:
Our Sales team must create an integration account for you. Contact them if you do not have one already.
This integration endpoint shows how to set up the API request for Time Series API subscription to obtain the
requestId.You will need to generate an API token to authenticate calls to the integration account.
Calls to the integration API endpoint are free of charge.
You can test the endpoint in the API console to the right. Learn how to use the console in the Using the API console guide.
The request parameters can not be changed for the API integration call to work. Amending the request parameters will result in an error.
Integration setup request parameters
When setting up your integration and executing the API calls, use the API parameters provided below to prevent errors.
To test the request for Time Series API in the API console to the right, enter the generated API token in the console and amend the request parameters according to the following table:
Subscription type | Integration request parameters |
|---|---|
Solargis Time Series Pro | Change the following parameters in the API console:
|
Enter your Solargis TimeSeries Bearer token. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
{
"site": {
"latitude": 48.88375,
"longitude": 20.159472,
"siteName": "Basic example Site"
},
"timeStep": "PT15M",
"columns": [
"GHI",
"DNI",
"DIF",
"GHI_NOSHD",
"DNI_NOSHD",
"DIF_NOSHD",
"GTI_NOSHD",
"GTI",
"CI_FLAG",
"SUN_ELEVATION",
"SUN_AZIMUTH",
"PANEL_AZIMUTH",
"PANEL_TILT",
"PANEL_INC",
"TEMP",
"WS",
"WD",
"WG",
"RH",
"AP",
"PWAT",
"PREC",
"TD",
"WBT",
"SDWE",
"SFWE"
],
"compressOutput": false,
"fromDate": "AUTODETECT",
"toDate": "2023-12-31",
"outputFormat": "SOLARGIS_JSON",
"timeAlignment": "CENTER",
"utcOffset": "+01:00",
"terrainShading": true,
"environment": {
"surfaceAlbedo": 0.12,
"horizon": {
"azimuth": [
0,
37.5,
60,
82.5,
105,
127.5,
150,
172.5,
195,
217.5,
240,
262.5,
285,
307.5,
330,
352.5
],
"height": [
0.705,
1.0588235,
1.058894,
1.428,
0.70588764,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
},
"gtiConfiguration": {
"layout": {
"mounting": {
"type": "FIXED_ONE_ANGLE",
"tilt": 39
}
}
},
"fileLabel": "Integration_example"
}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