Get
/tmy-integration/data-request/{requestId}/{outputFormat}
Request type: | GET |
URL: | https://api.solargis.com/tmy-integration/data-request/{requestid}/{outputFormat} |
Authorization: | Bearer {API token} |
Use this endpoint to get sample TMY data in different formats.
Key points to remember before you proceed:
- This is an integration endpoint, and the data you will obtain is sample data to examine its structure and format.
- Calls to this endpoint are free of charge.
- Allowed
outputFormatvalues are listed in the table below. - You will need to use the same API token that you have used when obtaining the integration
requestId. - You can test the endpoint in the API console to the right. Learn how to use the console in the Using the API console guide.
The API console will show
SOLARGIS_JSONformat data only. All other formats are not supported by the console and need to be tested elsewhere to view the received data.
| Parameter | Allowed values |
|---|---|
"outputFormat" | "SOLARGIS_JSON""SOLARGIS_CSV""SAM""HELIOSCOPE" |
Security
HTTP
Type bearer
Enter your Solargis TMY Bearer token.
Path parameters
requestId
stringRequired
outputFormat
stringRequired
Valid values[
"SOLARGIS_JSON",
"SOLARGIS_CSV",
"SAM",
"HELIOSCOPE"
]
Responses
200
TMY data in requestd format
400
Bad request format
object
Bad request format
error
string
Exampleapi.data_request.output_format
401
Invalid authorization
object
Invalid authorization
error
string
Exampletoken.invalid
404
Bad requestId
object
error
string
Exampleapi.data_request.not_found