Post
/tmy/data-request
This document provides information about production server API call parameters. Use this API endpoint to get the requestId for the TMY data download from your live Solargis account. You will need the requestId to get TMY data for your location.
Key points to remember before you proceed:
- You need a live Solargis account and have purchased the TMY Basic or TMY Pro service.
- 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.
- Parameters and temporal resolutions available via the TMY API depend on the TMY API subscription type.
Request type: | POST |
URL: | https://api.solargis.com/tmy/data-request |
Authorization: | Bearer {API token} |
Body: See the Body parameters section below. | |
Security
HTTP
Type bearer
Enter your Solargis TMY Bearer token.
Body parameters
object
latitude
number (float) Required
Example48.883755
longitude
number (float) Required
Example20.159472
timeStep
string Required
Valid values[
"PT60M",
"PT15M"
]
ExamplePT60M
tmyScenario
string Required
Valid values[
"P50"
]
ExampleP50
terrainShading
boolean
Defaulttrue
environment
object
surfaceAlbedo
number (float)
Example0.12
horizon
object
azimuth
Array of number
Min items16
Max items16
number
height
Array of number
Min items16
Max items16
number
outputFormats
Array of string Required
Example[
"SOLARGIS_JSON",
"SOLARGIS_CSV"
]
string
Valid values[
"SOLARGIS_JSON",
"SOLARGIS_CSV",
"SAM",
"HELIOSCOPE"
]
siteName
string Required
ExampleSolargis Testing request KB
fileLabel
string
Examplepro_01
gtiConfiguration
object (gtiConfigurationSchema)
layout
object
mounting
OneOf
FixedOneAngleMounting
object (FixedOneAngleMounting)
type
string Required
Valid values[
"FIXED_ONE_ANGLE"
]
ExampleFIXED_ONE_ANGLE
tilt
number Required
Minimum0
Maximum90
Example39.0
TrackerOneAxisHorizontalMounting
object (TrackerOneAxisHorizontalMounting)
type
string Required
Valid values[
"TRACKER_ONE_AXIS_HORIZONTAL"
]
backtracking
boolean Required
rotationLimitEast
number Required
Minimum-180
Maximum0
Example-50.0
rotationLimitWest
number Required
Minimum0
Maximum180
Example50.0
TrackerOneAxisInclinedMounting
object (TrackerOneAxisInclinedMounting)
type
string Required
Valid values[
"TRACKER_ONE_AXIS_INCLINED"
]
axisTilt
number Required
Minimum0
Maximum90
Example30.0
backtracking
boolean Required
rotationLimitEast
number Required
Example-50.0
rotationLimitWest
number Required
Example50.0
TrackerOneAxisVerticalMounting
object (TrackerOneAxisVerticalMounting)
type
string Required
Valid values[
"TRACKER_ONE_AXIS_VERTICAL"
]
tilt
number Required
Minimum0
Maximum90
Example30.0
azimuthLimitEast
number Required
Minimum-180
Maximum0
Example-120.0
azimuthLimitWest
number Required
Minimum0
Maximum180
Example120.0
backtracking
boolean Required
TrackerTwoAxisMounting
object (TrackerTwoAxisMounting)
type
string Required
Valid values[
"TRACKER_TWO_AXIS"
]
backtracking
boolean Required
tiltLimitMin
number Required
Minimum0
Maximum90
Example10.0
tiltLimitMax
number Required
Minimum0
Maximum90
Example90.0
azimuthLimitEast
number Required
Example-90.0
azimuthLimitWest
number Required
Example90.0
relativeSpacing
number (float)
Minimum0.1
Responses
200
RequestId retrieved
object
requestId
string
401
Ivalid authorization
object
Ivalid authorization
error
string
Exampletoken.invalid