Get requestId for Time Series data

Prev Next
Post
/ts/data-request

Request type:

POST

URL:

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

Authorization:

Bearer {API token}

Body: See the Body parameters section below.

Use this API endpoint to get the requestid for Time Series data download. You will need it to request Time Series data for your location. You must use a valid API token to get the requestid. You can test the request using the testing facility to the right. If you have a GTI energy system configured in the Solargis Evaluate application and you want to use its parameters to retrieve the Time Series data, you can download the specification and use it in the body of this request directly from the GTI energy system designer

Important: The testing facility is connected to our production servers. Every executed request will deduct one API call from you API call allowance. If you want to setup your integration first wihthout spending any allowance, follow steps in the TS integration setup guide.

  1. Enter your API token into the TimeSeriesToken field. 

  2. Amend the body parameters if required (see body parameters scheme below for permitted values for each field). The default body parameters are set to work without any amendments.

  3. Click the “Try it and see response” button to send the request.

  4. If the request is accepted, your requestid will pop up in the response window. You can now use it to request the Time Series data


GTI energy system designer

Security
HTTP
Type bearer
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)

You can use AUTODETECT to automatically add the earliest available start date

Valid values[ "AUTODETECT", "YYYY-MM-DD" ]
ExampleAUTODETECT
toDate
string (string)
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
number
height
Array of number
number
gtiConfiguration
object

Use the GTI configuration library in the introduction section for more details about this configuration

layout
object
mounting
OneOf
FixedOneAngleMounting
object (FixedOneAngleMounting)
type
string Required
Valid values[ "FIXED_ONE_ANGLE" ]
tilt
number Required

Tilt angle of the PV array.

TrackerOneAxisHorizontalMounting
object (TrackerOneAxisHorizontalMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_HORIZONTAL" ]
axisAzimuth
number
rotationLimit
number
backtracking
boolean
TrackerOneAxisInclinedMounting
object (TrackerOneAxisInclinedMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_INCLINED" ]
axisAzimuth
number
axisTilt
number
rotationLimit
number
backtracking
boolean
TrackerOneAxisVerticalMounting
object (TrackerOneAxisVerticalMounting)
type
string Required
Valid values[ "TRACKER_ONE_AXIS_VERTICAL" ]
axisAzimuth
number
rotationLimit
number
backtracking
boolean
TrackerTwoAxisMounting
object (TrackerTwoAxisMounting)
type
string Required
Valid values[ "TRACKER_TWO_AXIS" ]
fileLabel
string
ExampleIntegration_example
Responses
200

RequestId retrieved

object
requestId
string
401

Invalid authorization

object
error
string
ExampleInvalid token