Retrieve TimeSeries data by requestId

Prev Next
Get
/ts/data-request/{requestId}

This document provides information about production server API call parameters. Use this API endpoint to get the Time Series data for your location. 

Key points to remember before you proceed:

  • You need a live Solargis account and have purchased the Time Series API data subscription.
  • You will need the requestId add at the end of the request URL. Learn how to obtain requestId here
  • 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.

At first, you may get the “Request is being processed” message in the responseDepending on the site location, it may take some time to prepare your data. This message is to inform you that the request has been successful and your data is being prepared. Allow it a few moments and resubmit the request to get the URL link to your data.

Once the data is prepared and ready to download, you will get a downloadUrl field with a URL in the response. Use this URL to download your TMY data.

Request type:

GET

URL:

https://api.solargis.com/ts/data-request/{requestid}

Authorization:

Bearer {API token}

Security
HTTP
Type bearer

Enter your Solargis TimeSeries Bearer token. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Path parameters
requestId
stringRequired
ExampleBeHpHTBE8y
Responses
200

TimeSeries data retrieved

object
status
string
Valid values[ "success", "error", "pending" ]
Examplesuccess
statusCode
string
Pattern^SG2-\d{5}$
ExampleSG2-20000
statusMessage
string
ExampleRequest has been processed.
downloadUrl
string (uri)
Examplehttps://sg2-base-api-prod-apidatabucketa8a36...
401

Ivalid authorization

object

Ivalid authorization

error
string
Exampletoken.invalid
500

Bad requestId

object
error
string
Exampleapi.data_request.not_found