Skip to main content
GET
/
Weather
/
Search
Search weather files by location
curl --request GET \
  --url https://api.plantpredict.terabase.energy/Weather/Search \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "<string>",
    "latitude": 123,
    "longitude": 123,
    "id": 123,
    "description": "<string>",
    "stationName": "<string>",
    "stationCode": "<string>",
    "elevation": 123,
    "timeZone": 123,
    "timeInterval": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "country": "<string>",
    "countryCode": "<string>",
    "stateProvince": "<string>",
    "stateProvinceCode": "<string>",
    "locality": "<string>",
    "region": "<string>",
    "globalHorizontalIrradianceSum": 123,
    "diffuseHorizontalIrradianceSum": 123,
    "directNormalIrradianceSum": 123,
    "planeOfArrayIrradianceSum": 123,
    "averageAirTemperature": 123,
    "averageWindSpeed": 123,
    "weatherDetails": [
      {}
    ],
    "pLevel": 123,
    "windSensorHeight": 123,
    "offsetMinutes": 123,
    "moduleTilt": 123,
    "moduleAzimuth": 123,
    "groundCoverageRatio": 123,
    "companyId": 123,
    "createdDate": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.plantpredict.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Query Parameters

Latitude
number
required
Longitude
number
required
SearchRadius
number
required

Response

Matching weather files

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<date-time>
endDate
string<date-time>
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<date-time>
read-only