History

History related operations

Get history data for given coordinates

SecurityAPI Key

Request

query Parameters

lat required	string
lon required	string
var	string Enum: "evapotranspiration" "humidity" "soil_moisture" "solar_radiation" "soil_temperature" "temp_mean" "temp_max" "temp_min" "precipitation" "wind_speed"

Responses

200

Success

Response Schema: application/json

object (Meta Payload)

variables

Array of strings

List of variables included in the payload

granularity

string

Data version that is being sent in the payload

object (Location)

latitude	number Latitude of data being served
longitude	number Longitude of data being served

data_version

string

Data version that is being sent in the payload

statistics

Array of strings

Array of objects (Data Payload)

Array

date

string <date>

Date of time step

type

string

Type of payload contained in the data list

integer

Unique id of payload in the data list

object

There will be one data packet per variable in the meta.variables list

object

The * will take the value of each variable name in meta.variables list

units

string

Units of data contained in this model

object

property name*

additional property

number

object

property name*

additional property

number

ensemble_mean

number

Ensemble mean

400

Validation Error

404

Data Not Found

500

Internal server error.

get/history

Request samples

Node.js
JavaScript
Python
Java
Go

Response samples

application/json

{"meta": {"variables": ["evapotranspiration",
"humidity",
"soil_moisture",
"solar_radiation",
"soil_temperature",
"temp_mean",
"temp_max",
"temp_min",
"precipitation",
"wind_speed"
],
"granularity": "month",
"location": {"latitude": 39.7,
"longitude": -100.1
},
"data_version": "alpha",
"statistics": ["ensemble_mean",
"quantile_0.05",
"quantile_0.25",
"quantile_0.50",
"quantile_0.75",
"quantile_0.95",
"clim_prob_0.00-0.33",
"clim_prob_0.33-0.67",
"clim_prob_0.67-1.00"
]
},
"data": [{"date": "2022-09-01",
"type": "Monthly Seasonal Forecast",
"id": 0,
"attributes": {"*": {"units": "mm",
"probability": {"clim_prob_0.00-0.33": 0.53,
"clim_prob_0.33-0.67": 0.1,
"clim_prob_0.67-1.00": 0.37
},
"quantile": {"quantile_0.05": 7.59,
"quantile_0.25": 15.44,
"quantile_0.50": 21.16,
"quantile_0.75": 26.39,
"quantile_0.95": 31.5
},
"ensemble_mean": 20.53
}
}
}
]
}

Get history data for given location id

SecurityAPI Key

Request

path Parameters

required

string

query Parameters

var	string Enum: "evapotranspiration" "humidity" "soil_moisture" "solar_radiation" "soil_temperature" "temp_mean" "temp_max" "temp_min" "precipitation" "wind_speed"

Responses

200

Success

Response Schema: application/json

object (Meta Payload)

variables

Array of strings

List of variables included in the payload

granularity

string

Data version that is being sent in the payload

object (Location)

latitude	number Latitude of data being served
longitude	number Longitude of data being served

data_version

string

Data version that is being sent in the payload

statistics

Array of strings

Array of objects (Data Payload)

Array

date

string <date>

Date of time step

type

string

Type of payload contained in the data list

integer

Unique id of payload in the data list

object

There will be one data packet per variable in the meta.variables list

object

The * will take the value of each variable name in meta.variables list

units

string

Units of data contained in this model

object

property name*

additional property

number

object

property name*

additional property

number

ensemble_mean

number

Ensemble mean

400

Validation Error

404

Data Not Found

500

Internal server error.

get/history/location/{id}

Request samples

Node.js
JavaScript
Python
Java
Go

Response samples

application/json

{"meta": {"variables": ["evapotranspiration",
"humidity",
"soil_moisture",
"solar_radiation",
"soil_temperature",
"temp_mean",
"temp_max",
"temp_min",
"precipitation",
"wind_speed"
],
"granularity": "month",
"location": {"latitude": 39.7,
"longitude": -100.1
},
"data_version": "alpha",
"statistics": ["ensemble_mean",
"quantile_0.05",
"quantile_0.25",
"quantile_0.50",
"quantile_0.75",
"quantile_0.95",
"clim_prob_0.00-0.33",
"clim_prob_0.33-0.67",
"clim_prob_0.67-1.00"
]
},
"data": [{"date": "2022-09-01",
"type": "Monthly Seasonal Forecast",
"id": 0,
"attributes": {"*": {"units": "mm",
"probability": {"clim_prob_0.00-0.33": 0.53,
"clim_prob_0.33-0.67": 0.1,
"clim_prob_0.67-1.00": 0.37
},
"quantile": {"quantile_0.05": 7.59,
"quantile_0.25": 15.44,
"quantile_0.50": 21.16,
"quantile_0.75": 26.39,
"quantile_0.95": 31.5
},
"ensemble_mean": 20.53
}
}
}
]
}

➔ Next to Datasets