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 requestId

  • Updated on Jun 15, 2026
  • Published on Oct 24, 2025
  • 1 minute(s) read
  • KE
  • MK
 Prev Next
Post
/tmy-integration/data-request

This guide explains how to set up the TMY data API integration to obtain a requestId. This endpoint is for integration testing only — it does not support downloading data from your live Solargis account. Once you have a requestId, proceed to Get the sample location data to understand the response structure.

Request type:

POST

URL:

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

Authorization:

Bearer {API token}

Body parameters:

See the specification below

Prerequisites
  • You must have an integration account. If you don't have one, contact the Sales team.
  • You must generate an API token for your integration account. Tokens are generated separately for TMY Hourly and TMY 15-minute integrations.
Things to know
  • Calls to integration API endpoints are free of charge.
  • The request parameters are fixed. Changing them will cause an error.
  • If 1-minute data is included in the request, the request period must be at least 1 year.
  • You can test the endpoint directly in the API console on the right. See Using the API console for instructions.

Execute the request

Select the parameters for your subscription type before executing the call.

TMY Hourly: Execute the call in the console as-is. No changes are needed.

TMY 15-minute: Update the body parameters indicated in the table below before executing.

Subscription type

Integration request parameters

Solargis TMY 15-minute

Change the following parameters in the API console:

  • "siteName": "Pro example Site"

  • "fileLabel": "pro_01"

Security
HTTP
Type bearer

Enter your Solargis TMY Bearer token.

Body parameters
object
latitude
number (double) Required

Geographic latitude of the site in decimal degrees (WGS84).

Example48.61259
longitude
number (double) Required

Geographic longitude of the site in decimal degrees (WGS84).

Example20.827079
timeStep
string Required

Temporal resolution of the output data; hourly (PT60M) is supported for integration.

Valid values[ "PT60M" ]
ExamplePT60M
tmyScenario
string Required

Statistical exceedance scenario for the TMY dataset; P50 represents the median energy yield.

Valid values[ "P50" ]
ExampleP50
outputFormats
Array of string Required

List of output file formats to generate for the TMY data.

Example[ "SOLARGIS_CSV", "SOLARGIS_JSON", "SAM", "HELIOSCOPE" ]
string
Valid values[ "SOLARGIS_JSON", "SOLARGIS_CSV", "SAM", "HELIOSCOPE" ]
siteName
string Required

Human-readable label identifying the site in output files and logs.

ExampleBasic example Site
fileLabel
string

Short identifier prepended to output file names for easy recognition.

Examplebasic_01
Responses
200

RequestId retrieved

object
requestId
string

Unique identifier used to retrieve the processed data in a subsequent GET request.

401

Invalid authorization

object

Invalid authorization

error
string

Machine-readable error code indicating the authentication failure reason.

Exampletoken.invalid