Get requestId for TimeSeries data

Prev Next
Post
/ts/data-request

This document provides information about production server API call parameters. Use this API endpoint to get the requestId for the Time Series data download from your live Solargis account. You will need the requestId to get 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 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.

If you have a GTI energy system configured in the Solargis Evaluate application, you can use it to retrieve the Time Series data. You can download the specification and use it in the body of the request directly from the GTI energy system designer.

If you want to download the data in CSV format for further use in PVsyst, set "outpuFormat": "SOLARGIS_CSV"  in the request parameters. Beware that PVsyst supports  "timeStep": "PT60M" (1 hour) and  "timeStep": "P1M" (1 month) only.

Request type:

POST

URL:

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

Authorization:

Bearer {API token}

Body: See the Body parameters section below.

Security
HTTP
Type bearer

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

Body parameters
object
site
object Required
latitude
number (float)
Example48.883755
longitude
number (float)
Example20.159472
siteName
string
ExampleSolargis Testing request KB
timeStep
string Required
Valid values[ "PT5M", "PT10M", "PT15M", "PT60M", "P1D", "P1M", "P1Y" ]
ExamplePT15M
columns
Array of string Required

The RH, AP, and PWAT parameters are available for ENTERPRISE subscriptions only.

Example[ "GHI", "DNI", "TEMP" ]
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
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
Min items16
Max items16
number
height
Array of number
Min items16
Max items16
number
gtiConfiguration
object (gtiConfigurationSchema)
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
relativeSpacing
number (float)
Minimum0.1
fileLabel
string
ExampleIntegration_example
Responses
200

RequestId retrieved

object
requestId
string
401

Ivalid authorization

object

Ivalid authorization

error
string
Exampletoken.invalid