Documentation Index

Fetch the complete documentation index at: https://kb.solargis.com/llms.txt

Use this file to discover all available pages before exploring further.

Integration setup - get the TMY data

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

This endpoint returns sample location data for TMY Basic and TMY Pro API subscriptions. Use it to explore the structure and content of the response before working with your live account.

Request type:

GET

URL:

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

Authorization:

Bearer {API token}

Body parameters:

N/A

Prerequisites
Things to know
  • Calls to the integration API endpoints are free of charge.
  • If 1-minute data is set in the request, the request period can not be less than 1 year. 
  • You can test the endpoint directly in the API console on the right . See Using the API console for instructions.
Security
HTTP
Type bearer

Enter your Solargis TMY Bearer token.

Path parameters
requestId
stringRequired

Unique identifier returned by the TMY data request POST endpoint.

Responses
200

TMY request status

object
status
string

Current processing state of the TMY data request.

Valid values[ "queued", "processing", "success", "reject", "error", "expired" ]
Examplesuccess
statusCode
string

Machine-readable code providing additional detail about the request outcome.

Example200
statusMessage
string

Human-readable message describing the request result.

ExampleRequest has been processed.
downloadUrl
string (uri)

Pre-signed URL to download the output TMY data file.

Examplehttps://s3.amazonaws.com/...
401

Invalid authorization

object

Invalid authorization

error
string

Machine-readable error code indicating the authentication failure reason.

Exampletoken.invalid
500

Bad requestId

object
error
string

Machine-readable error code indicating the reason for the failure.

Exampleapi.data_request.not_found