Post
/ts/data-request
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[
"PT1M",
"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
Min items16
Max items16
number
height
Array of number
Min items16
Max items16
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"
]
ExampleFIXED_ONE_ANGLE
tilt
number Required
Minimum0
Maximum90
Example39
TrackerOneAxisHorizontalMounting
object (TrackerOneAxisHorizontalMounting)
type
string Required
Valid values[
"TRACKER_ONE_AXIS_HORIZONTAL"
]
backtracking
boolean Required
rotationLimitEast
number Required
Minimum-180
Maximum0
Example-50
rotationLimitWest
number Required
Minimum0
Maximum180
Example50
TrackerOneAxisInclinedMounting
object (TrackerOneAxisInclinedMounting)
type
string Required
Valid values[
"TRACKER_ONE_AXIS_INCLINED"
]
axisTilt
number Required
Minimum0
Maximum90
Example30
backtracking
boolean Required
rotationLimitEast
number Required
Example-50
rotationLimitWest
number Required
Example50
TrackerOneAxisVerticalMounting
object (TrackerOneAxisVerticalMounting)
type
string Required
Valid values[
"TRACKER_ONE_AXIS_VERTICAL"
]
tilt
number Required
Minimum0
Maximum90
Example30
azimuthLimitEast
number Required
Minimum-180
Maximum0
Example-120
azimuthLimitWest
number Required
Minimum0
Maximum180
Example120
backtracking
boolean Required
TrackerTwoAxisMounting
object (TrackerTwoAxisMounting)
type
string Required
Valid values[
"TRACKER_TWO_AXIS"
]
backtracking
boolean Required
tiltLimitMin
number Required
Minimum0
Maximum90
Example10
tiltLimitMax
number Required
Minimum0
Maximum90
Example90
azimuthLimitEast
number Required
Example-90
azimuthLimitWest
number Required
Example90
fileLabel
string
ExampleIntegration_example
Responses
200
RequestId retrieved
object
requestId
string
401
Ivalid authorization
object
Ivalid authorization
error
string
Exampletoken.invalid