Use this endpoint to obtain a requestId for downloading Time Series data from your live Solargis account. You will need the requestId in the next step to retrieve data for your location.
Request type: | POST |
URL: | https://api.solargis.com/ts/data-request |
Authorization: | Bearer {API token} |
Body: See the Body parameters section below. | |
Prerequisites
- You must have a live Solargis account with an active Time Series API subscription.
- You must generate an API token to authenticate calls to your account.
Things to know
- Calls to this endpoint are paid and will deduct credits from your API call allowance.
- Available parameters and temporal resolutions depend on your Time Series API subscription type.
- If 1-minute data is included in the request, the request period must be at least 1 year.
- The API console on the right is connected to the production server. It does not support integration API calls. See Using the API console for instructions.
Additional request options
GTI energy system configuration
If you have a GTI energy system configured in Solargis Evaluate, you can use it to retrieve Time Series data. Download the specification directly from the GTI energy system designer and use it as the request body.
PVsyst export
To download data in a format compatible with PVsyst, set "outputFormat": "SOLARGIS_CSV" in the request parameters. Note that PVsyst supports only the following time steps:
"timeStep": "PT60M" — 1 hour"timeStep": "P1M" — 1 month
<
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,
0.0
]
}
},
"gtiConfiguration": {
"layout": {
"mounting": {
"type": "FIXED_ONE_ANGLE",
"tilt": 39
}
}
},
"fileLabel": "ts_pro"
}Geographic location of the site for which data is requested.
Geographic latitude of the site in decimal degrees (WGS84).
Geographic longitude of the site in decimal degrees (WGS84).
Human-readable label identifying the site in output files and logs.
Temporal resolution of the output data; available options depend on your subscription.
List of meteorological and solar parameters to include in the output. RH, AP, and PWAT are available for ENTERPRISE subscriptions only.
Output file format for the time series data.
When true, the output file is compressed as a ZIP archive.
When true, splits the output into one file per year; requires compressOutput to be set to true.
Start date in ISO 8601 format (YYYY-MM-DD). Use AUTODETECT to automatically select the earliest available start date.
End date in ISO 8601 format (YYYY-MM-DD). Use LAST_MONTH or LAST_YEAR for relative date selection.
Defines whether timestamps represent the center, start (left), or end (right) of each time interval.
UTC offset for the output timestamps in ±HH:MM format.
When true, applies terrain horizon shading to irradiance calculations.
Site-specific environmental parameters that influence irradiance calculations.
Surface albedo as a single annual value or an array of 12 monthly values (Jan–Dec).
Custom horizon profile defined by azimuth–height pairs to account for local obstructions.
Array of azimuth angles in degrees (0–360, measured clockwise from north) defining the horizon profile.
Array of horizon elevation angles in degrees corresponding to each azimuth point.
Panel mounting configuration used to compute plane-of-array irradiance (GTI).
Physical layout of the PV panel installation.
Mounting system type and its associated configuration parameters.
Identifies the mounting type as fixed single-angle.
Panel tilt angle in degrees from horizontal (0° = flat, 90° = vertical).
Identifies the mounting type as a horizontal single-axis tracker.
When true, the tracker uses backtracking to avoid inter-row shading at low sun angles.
Maximum rotation angle in degrees toward the east (negative value).
Maximum rotation angle in degrees toward the west (positive value).
Identifies the mounting type as an inclined single-axis tracker.
Tilt angle of the tracker rotation axis from horizontal, in degrees.
When true, the tracker uses backtracking to avoid inter-row shading at low sun angles.
Maximum rotation angle in degrees toward the east (negative value).
Maximum rotation angle in degrees toward the west (positive value).
Identifies the mounting type as a vertical single-axis (azimuth) tracker.
Fixed panel tilt angle in degrees from horizontal.
Maximum azimuth rotation limit toward the east in degrees (negative value).
Maximum azimuth rotation limit toward the west in degrees (positive value).
When true, the tracker uses backtracking to avoid inter-row shading at low sun angles.
Identifies the mounting type as a two-axis tracker.
When true, the tracker uses backtracking to avoid inter-row shading at low sun angles.
Minimum allowable tilt angle in degrees from horizontal.
Maximum allowable tilt angle in degrees from horizontal.
Maximum azimuth rotation limit toward the east in degrees (negative value).
Maximum azimuth rotation limit toward the west in degrees (positive value).
Row-to-row spacing relative to the panel height, used to model inter-row shading.
Short identifier prepended to output file names for easy recognition.
RequestId retrieved
Unique identifier used to retrieve the processed data in a subsequent GET request.
Invalid authorization
Invalid authorization
Machine-readable error code indicating the authentication failure reason.