Get requestId for TMY data

  • Updated on Jul 15, 2025
  • Published on May 21, 2025
  • 1 minute(s) read
  • MK
 Prev Next
Post
/tmy/data-request

Request type:

POST

URL:

https://api.solargis.com/tmy/data-request

Authorization:

Bearer {API token}

Body: See the Body parameters section below.

Use this API endpoint to get the requestId for TMY data download. You will need it to request TMY data for your location. You must use a valid API token to get the requestId. You can test the request using the testing facility to the right.

Important: The testing facility is connected to our production servers. Every executed request will deduct one API call from you API call allowance. If you want to setup your integration first wihthout spending any allowance, follow steps in the TMY integration setup guide.

  1. Enter your API token into the TMYToken field. 

  2. Amend the body parameters if required (see body parameters scheme below for permitted values for each field). The default body parameters are set to work without any amendments.

  3. Click the “Try it and see response” button to send the request.

  4. If the request is accepted, your requestId will pop up in the response window. You can now use it to request the TMY data. 


Security
HTTP
Type bearer
Body parameters
object
latitude
number (float) Required
Example42.91
longitude
number (float) Required
Example-114.84
timeStep
string Required
Valid values[ "PT60M", "PT15M" ]
ExamplePT15M
tmyScenario
string Required
Valid values[ "P50" ]
ExampleP50
siteName
string Required
ExampleKB_test_solargis
fileLabel
string
Examplepro_01
outputFormats
Array of string Required
Example[ "SOLARGIS_JSON" ]
string
Valid values[ "SOLARGIS_JSON", "SOLARGIS_CSV", "SAM", "HELIOSCOPE" ]
terrainShading
boolean
Defaulttrue
utcOffset
string
Valid values[ "+05:00" ]
environment
object
surfaceAlbedo
number (float)
Default0.3
horizon
object
azimuth
Array of number

Azimuth angles, typically in degrees (0-360).

number
height
Array of number

Horizon heights for each azimuth.

number
gtiConfiguration
object (GTIConfiguration)
layout
object
mounting
OneOf
FixedOneAngleMounting
object (FixedOneAngleMounting)
type
string Required
Valid values[ "FIXED_ONE_ANGLE" ]
tilt
number Required

Tilt angle of the PV array.

TrackerOneAxisHorizontalMounting
object (TrackerOneAxisHorizontalMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_HORIZONTAL" ]
axisAzimuth
number
rotationLimit
number
backtracking
boolean
TrackerOneAxisInclinedMounting
object (TrackerOneAxisInclinedMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_INCLINED" ]
axisAzimuth
number
axisTilt
number
rotationLimit
number
backtracking
boolean
TrackerOneAxisVerticalMounting
object (TrackerOneAxisVerticalMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_VERTICAL" ]
axisAzimuth
number
rotationLimit
number
backtracking
boolean
TrackerTwoAxisMounting
object (TrackerTwoAxisMounting)
type
string Required
Valid values[ "TRACKER_TWO_AXIS" ]
azimuth
number

Azimuth angle of the PV system layout.

Responses
200

RequestId retrieved

object
requestId
string
401

Invalid authorization

object
error
string
ExampleInvalid token