Integration setup - get the TMY data

Prev Next
Get
/tmy-integration/data-request/{requestId}

Request type:

GET

URL:

https://api.solargis.com/tmy-integration/data-request/{requestId}

Authorization:

Bearer {API token}

Body parameters:

N/A

This endpoint enables you to obtain sample location data for TMY Basic data API and TMY Pro data API subscriptions. You can use it to set up your integration to understand the structure and content of the response. 

Key points to remember before you proceed:

  • You will need an API token and the requestId to download sample location data. Learn how to obtain the requestId for integration setup purposes in the Integration setup - get the requestId guide. 
  • Calls to the integration API endpoints are free of charge.
  • You can test the endpoint and get the response in the API console to the right. Learn how to use the console in the Using the API console guide.
Security
HTTP
Type bearer

Enter your Solargis TMY Bearer token.

Path parameters
requestId
stringRequired
Responses
200

TMY request status

object
status
string
Valid values[ "queued", "processing", "success", "reject", "error", "expired" ]
Examplesuccess
statusCode
string
Example200
statusMessage
string
ExampleRequest has been processed.
downloadUrl
string (uri)
Examplehttps://s3.amazonaws.com/...
401

Ivalid authorization

object

Ivalid authorization

error
string
Exampletoken.invalid
500

Bad requestId

object
error
string
Exampleapi.data_request.not_found