Use this endpoint to obtain a requestId for downloading TMY 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/tmy/data-request |
Authorization: | Bearer {API token} |
Body: See the Body parameters section below. | |
Prerequisites
- You must have a live Solargis account with an active TMY Basic or TMY Pro 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.
- The API console on the right is connected to the production server. It does not support integration API calls. See Using the API console instructions.
- Available parameters and temporal resolutions depend on your TMY API subscription type.
- If 1-minute data is included in the request, the request period must be at least 1 year.
<
Enter your Solargis TMY Bearer token.
{
"latitude": 48.61259,
"longitude": 20.827079,
"siteName": "KB Pro Site",
"timeStep": "PT60M",
"tmyScenario": "P50",
"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
}
}
},
"compressOutput": true,
"outputFormats": [
"SOLARGIS_CSV",
"SOLARGIS_JSON",
"SAM",
"HELIOSCOPE"
],
"fileLabel": "tmy_pro"
}Geographic latitude of the site in decimal degrees (WGS84).
Geographic longitude of the site in decimal degrees (WGS84).
Temporal resolution of the output data.
Statistical exceedance scenario for the TMY dataset; P50 represents the median energy yield.
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.
List of output file formats to generate for the TMY data.
Human-readable label identifying the site in output files and logs.
Short identifier prepended to output file names for easy recognition.
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.
When true, the output file is compressed as a ZIP archive.
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.