Integration setup - get the requestId

  • Updated on Oct 24, 2025
  • Published on Oct 24, 2025
  • 2 minute(s) read
  • MK
 Prev Next
Post
/ts-integration/data-request

Request type:

POST

URL:

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

Authorization:

Bearer {API token}

Body parameters:

See the specification below

In this guide, we will provide information about how to set up the Time Series API integration to obtain the requestId required for obtaining the location data. The endpoint provided here is for integration purposes only and does not allow you to download location data from your live Solargis account.

Once you obtain the integration requestId, you can proceed to get the sample location data to understand the response.

Key points to remember before you proceed:

  • Our Sales team must create an integration account for you. Contact them if you do not have one already. 

  • This integration endpoint shows how to set up the API request for Time Series API subscription to obtain the requestId.

  • You will need to generate an API token to authenticate calls to the integration account.

  • Calls to the integration API endpoint are free of charge.

  • 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 request parameters can not be changed for the API integration call to work. Amending the request parameters will result in an error.

Integration setup request parameters

When setting up your integration and executing the API calls, use the API parameters provided below to prevent errors. 

To test the request for Time Series API in the API console to the right, enter the generated API token in the console and amend the request parameters according to the following table:

Subscription type

Integration request parameters

Solargis Time Series Pro 

Change the following parameters in the API console:

  •  "compressOutput": false

Security
HTTP
Type bearer

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

Body parameters
object
site
object Required
latitude
number (float)
Example48.88375
longitude
number (float)
Example20.159472
siteName
string
ExampleBasic example Site
timeStep
string Required
Valid values[ "PT15M" ]
ExamplePT15M
columns
Array of string Required
Example[ "GHI", "DNI", "DIF", "GHI_NOSHD", "DNI_NOSHD", "DIF_NOSHD", "GTI_NOSHD", "GTI", "CI_FLAG", "SUN_ELEVATION", "SUN_AZIMUTH", "PANEL_AZIMUTH", "PANEL_TILT", "PANEL_INC", "TEMP", "WS", "WD", "WG", "RH", "AP", "PWAT", "PREC", "TD", "WBT", "SDWE", "SFWE" ]
string
Valid values[ "GHI", "DNI", "DIF", "GHI_NOSHD", "DNI_NOSHD", "DIF_NOSHD", "GTI_NOSHD", "GTI", "CI_FLAG", "SUN_ELEVATION", "SUN_AZIMUTH", "PANEL_AZIMUTH", "PANEL_TILT", "PANEL_INC", "TEMP", "WS", "WD", "WG", "RH", "AP", "PWAT", "PREC", "TD", "WBT", "SDWE", "SFWE", "UVA", "UVB", "PAR", "KT", "KC", "PM2P5", "PM10" ]
outputFormat
string Required
Valid values[ "SOLARGIS_JSON" ]
ExampleSOLARGIS_JSON
compressOutput
boolean
Defaultfalse
Examplefalse
fromDate
string (string)

Start date in ISO 8601 format (YYYY-MM-DD). You can also use the keyword AUTODETECT to automatically select the earliest available start date.

Valid values[ "AUTODETECT", "YYYY-MM-DD" ]
ExampleAUTODETECT
toDate
string (string)

End date in ISO 8601 format (YYYY-MM-DD). You can also use LAST_MONTH or LAST_YEAR for relative date selection.

Valid values[ "LAST_MONTH", "LAST_YEAR", "YYYY-MM-DD" ]
Example2023-12-31
timeAlignment
string
Valid values[ "CENTER", "LEFT", "RIGHT" ]
Default"CENTER"
ExampleCENTER
utcOffset
string
Pattern^[+-]\d{2}:\d{2}$
Example+01:00
terrainShading
boolean
Defaulttrue
environment
object
surfaceAlbedo
number (float)
Example0.12
horizon
object
azimuth
Array of number
Example[ 0.0, 37.5, 60.0, 82.5, 105.0, 127.5, 150.0, 172.5, 195.0, 217.5, 240.0, 262.5, 285.0, 307.5, 330.0, 352.5 ]
number
height
Array of number
Example[ 0.705, 1.0588235, 1.058894, 1.428, 0.70588764, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
number
gtiConfiguration
object (gtiIntegratoinConfigurationSchema)
layout
object
mounting
OneOf
FixedOneAngleMounting
object (FixedOneAngleMounting)
type
string Required
Valid values[ "FIXED_ONE_ANGLE" ]
ExampleFIXED_ONE_ANGLE
tilt
number Required
Minimum0
Maximum90
Example39.0
TrackerOneAxisHorizontalMounting
object (TrackerOneAxisHorizontalMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_HORIZONTAL" ]
backtracking
boolean Required
rotationLimitEast
number Required
Minimum-180
Maximum0
Example-50.0
rotationLimitWest
number Required
Minimum0
Maximum180
Example50.0
TrackerOneAxisInclinedMounting
object (TrackerOneAxisInclinedMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_INCLINED" ]
axisTilt
number Required
Minimum0
Maximum90
Example30.0
backtracking
boolean Required
rotationLimitEast
number Required
Example-50.0
rotationLimitWest
number Required
Example50.0
TrackerOneAxisVerticalMounting
object (TrackerOneAxisVerticalMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_VERTICAL" ]
tilt
number Required
Minimum0
Maximum90
Example30.0
azimuthLimitEast
number Required
Minimum-180
Maximum0
Example-120.0
azimuthLimitWest
number Required
Minimum0
Maximum180
Example120.0
backtracking
boolean Required
TrackerTwoAxisMounting
object (TrackerTwoAxisMounting)
type
string Required
Valid values[ "TRACKER_TWO_AXIS" ]
backtracking
boolean Required
tiltLimitMin
number Required
Minimum0
Maximum90
Example10.0
tiltLimitMax
number Required
Minimum0
Maximum90
Example90.0
azimuthLimitEast
number Required
Example-90.0
azimuthLimitWest
number Required
Example90.0
fileLabel
string
ExampleIntegration_example
Responses
200

RequestId retrieved

object
requestId
string
401

Ivalid authorization

object

Ivalid authorization

error
string
Exampletoken.invalid