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.
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..."
The RH, AP, and PWAT parameters are available for ENTERPRISE subscriptions only.
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.
RequestId retrieved
Ivalid authorization
Ivalid authorization