Skip to main content
GET
Get a weather file

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.

Path Parameters

weatherId
integer
required

Response

Weather file

name
string
required
latitude
number
required
longitude
number
required
id
integer
read-only
description
string | null
status
enum<integer>

LibraryStatusEnum

Available options:
0,
1,
2,
3,
4,
5,
6
source
enum<integer>

WeatherSourceTypeAPIEnum

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
stationName
string
stationCode
string
format
enum<integer>

WeatherFormat

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
elevation
number
timeZone
number
timestampDefinition
enum<integer>

WeatherTimestampDefinitionEnum

Available options:
0,
1,
2,
3
timeInterval
integer
startDate
string

ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present.

endDate
string

ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present.

dataProvider
enum<integer>

WeatherDataProvider

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
dataType
enum<integer>

WeatherDataType

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
country
string
countryCode
string
stateProvince
string
stateProvinceCode
string
locality
string
region
string
globalHorizontalIrradianceSum
number
diffuseHorizontalIrradianceSum
number
directNormalIrradianceSum
number
planeOfArrayIrradianceSum
number
averageAirTemperature
number
averageWindSpeed
number
weatherDetails
object[]
pLevel
number
windSensorHeight
number
offsetMinutes
integer
moduleTilt
number
moduleAzimuth
number
trackingType
enum<integer>

DCFieldTrackingTypeEnum

Available options:
0,
1,
2
groundCoverageRatio
number
companyId
integer
read-only
createdDate
string
read-only

ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present.