Metadata

The Metadata endpoints are used to return metadata for the datasets available in Climate Engine.

/metadata/dataset_dates

/metadata/dataset_variables

/metadata/county_names

/metadata/raster/percentiles/values

/metadata/raster/percentiles/climatologies

/metadata/raster/percentiles/anomalies

/metadata/raster/percentiles/standard_index

/metadata/raster/percentiles/mann_kendall

/metadata/raster/statistics/values

/metadata/raster/statistics/climatologies

/metadata/raster/statistics/anomalies

/metadata/raster/statistics/standard_index

/metadata/raster/statistics/mann_kendall

/metadata/dataset_dates

Returns dataset start and end/most recent date.

Returns: json

Resource url example:

/metadata/dataset_dates?dataset=GRIDMET

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes	The dataset you want the dates for	GRIDMET	LANDSAT7_TOA
export_format	no	File format of export	json	csv, json

/metadata/dataset_variables

Returns list of input dataset’s variables.

Returns: json

Resource url example:

/metadata/dataset_variables?dataset=GRIDMET

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes	The dataset you want the variables for	GRIDMET	LANDSAT_SR
export_format	no	File format of export	json	csv, json

/metadata/county_names

Returns list of input state’s counties.

Returns: json

Resource url example:

/metadata/county_names?state=OR

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
state	yes	The state you want the county names for	OR	PA
export_format	no	File format of export	json	csv, json

/metadata/raster/percentiles/values

Computes percentiles of map values of the dataset variable.

The temporal statistic is applied over the date range defined by start_date and end_date.

Returns: json

Resource url example:

/metadata/raster/percentiles/values?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_date=2016-01-01&end_date=2016-12-30&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
temporal_statistic	yes			mean, median, max, min, total
export_format	no	File format of export	json	csv, json
start_date	yes			2019-01-01
end_date	yes			2019-12-31
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	yes	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]
percentiles	no	The percentiles	[0, 5, 10, 25, 50, 75, 90, 95, 100]

/metadata/raster/percentiles/climatologies

Computes percentiles of map of average values of the dataset variable over the time period.

Returns: json

Resource url example:

/metadata/raster/percentiles/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_season=08-01&end_season=10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
temporal_statistic	yes			mean, median, max, min, total
export_format	no	File format of export	json	csv, json
start_season	yes			05-10
end_season	yes			10-16
start_year	yes	Start year for the climatology		1981
end_year	yes	End year for the climatology		2010
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	yes	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]
percentiles	no	The percentiles	[0, 5, 10, 25, 50, 75, 90, 95, 100]

/metadata/raster/percentiles/anomalies

Computes percentiles of map of anomalies of the dataset variable over the time period.

The following calculation choices can be specified:

anom: differences of the values from average conditions

anompercentof: the values divided by the average conditions multiplied by 100 to cast as a percent

anompercentchange: difference of values from average conditions divided by average conditions and then multiplied by 100 to cast as a percent

Returns: json

Resource url example:

/metadata/raster/percentiles/anomalies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&calculation=anom&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
temporal_statistic	yes			mean, median, max, min, total
export_format	no	File format of export	json	csv, json
calculation	yes	Anomaly calculation		anom, anompercentof, anompercentchange
start_date	yes			2019-01-01
end_date	yes			2019-10-16
start_year	yes	Start year for the climatology		1981
end_year	yes	End year for the climatology		2010
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	yes	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]
percentiles	no	The percentiles	[0, 5, 10, 25, 50, 75, 90, 95, 100]

/metadata/raster/percentiles/standard_index

Computes percentiles of a map of drought indices of the dataset variable over the time period.

Available variables by dataset:

G: spi, spei, eddi, pdsi

CHIRPS_PENTAD: spi

CHIRPS_DAILY: spi

PRISM: spi

MERRA2: spi, spei, eddi

Returns: json

Resource url example:

/metadata/raster/percentiles/standard_index?dataset=GRIDMET&variable=eddi&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
start_date	yes			2019-01-01
end_date	yes			2019-10-16
start_year	yes	Start year for the climatology		1981
end_year	yes	End year for the climatology		2010
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	yes	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]
export_format	no	File format of export	json	csv, json
percentiles	no	The percentiles	[0, 5, 10, 25, 50, 75, 90, 95, 100]

/metadata/raster/percentiles/mann_kendall

Computes percentiles of a map of Mann Kendall trends of the dataset variable over the time period.

mk_sen: Slope of trend (Sen’s slope)

mk_tau: Correlation of trend (Kendall Tau-b)

Returns: json

Resource url example:

/metadata/raster/percentiles/mann_kendall?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&calculation=mk_tau&p_value=0.5&start_season=05-01&end_season=07-30&start_year=2016&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
temporal_statistic	yes			mean, median, max, min, total
export_format	no	File format of export	json	csv, json
calculation	yes	Sen’s Slope or Kendall Tau-b		mk_sen, mk_tau
p_value	no	Mann Kendall p-value mask	1.0	1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01
start_season	yes			01-01
end_season	yes			10-16
start_year	yes	Start year for the climatology		1981
end_year	yes	End year for the climatology		2010
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	yes	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]
percentiles	no	The percentiles	[0, 5, 10, 25, 50, 75, 90, 95, 100]

/metadata/raster/statistics/values

Computes statistics of map values of the dataset variable in a bounding box.

The temporal statistic is applied over the date range defined by start_date and end_date.

Returns: json

Resource url example:

/metadata/raster/statistics/values?dataset=GGRIDMETvariable=tmmx&temporal_statistic=Mean&start_date=2016-01-01&end_date=2016-12-30&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
temporal_statistic	yes			mean, median, max, min, total
export_format	no	File format of export	json	csv, json
start_date	yes			2019-01-01
end_date	yes			2019-12-31
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	no	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]

/metadata/raster/statistics/climatologies

Computes statistics of map of average values of the dataset variable over the time period in a bounding box.

Returns: json

Resource url example:

/metadata/raster/statistics/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_season=08-01&end_season=10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
temporal_statistic	yes			mean, median, max, min, total
export_format	no	File format of export	json	csv, json
start_season	yes			05-10
end_season	yes			10-16
start_year	yes	Start year for the climatology		1981
end_year	yes	End year for the climatology		2010
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	no	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]

/metadata/raster/statistics/anomalies

Computes statistics of map of anomalies of the dataset variable over the time period in a bounding box.

The following calculation choices can be specified:

anom: differences of the values from average conditions

anompercentof: the values divided by the average conditions multiplied by 100 to cast as a percent

anompercentchange: difference of values from average conditions divided by average conditions and then multiplied by 100 to cast as a percent

Returns: json

Resource url example:

/metadata/raster/statistics/anomalies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&calculation=anom&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
temporal_statistic	yes			mean, median, max, min, total
export_format	no	File format of export	json	csv, json
calculation	yes	Anomaly calculation		anom, anompercentof, anompercentchange
start_date	yes			2019-01-01
end_date	yes			2019-10-16
start_year	yes	Start year for the climatology		1981
end_year	yes	End year for the climatology		2010
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	no	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]

/metadata/raster/statistics/standard_index

Computes statistics of a map of drought indices of the dataset variable over the time period in a bounding box.

Available variables by dataset:

GRIDMET: spi, spei, eddi, pdsi

CHIRPS_PENTAD: spi

CHIRPS_DAILY: spi

PRISM: spi

MERRA2: spi, spei, eddi

Returns: json

Resource url example:

/metadata/raster/statistics/standard_index?dataset=GRIDMET&variable=eddi&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
start_date	yes			2019-01-01
end_date	yes			2019-10-16
start_year	yes	Start year for the climatology		1981
end_year	yes	End year for the climatology		2010
bounding_box	no	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]
export_format	no	File format of export	json	csv, json
scale	no	Dataset scale	Depends dataset and bounding box	4000

/metadata/raster/statistics/mann_kendall

Computes statistics of a map of Mann Kendall trends of the dataset variable over the time period in a bounding box.

mk_sen: Slope of trend (Sen’s slope)

mk_tau: Correlation of trend (Kendall Tau-b)

Returns: json

Resource url example:

/metadata/raster/statistics/mann_kendall?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&calculation=mk_tau&p_value=0.5&start_season=05-01&end_season=07-30&start_year=2016&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
dataset	yes			GRIDMET
variable	yes			tmmx
temporal_statistic	yes			mean, median, max, min, total
export_format	no	File format of export	json	csv, json
calculation	yes	Sen’s Slope or Kendall Tau-b		mk_sen, mk_tau
p_value	no	Mann Kendall p-value mask	1.0	1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01
start_season	yes			01-01
end_season	yes			10-16
start_year	yes	Start year for the climatology		1981
end_year	yes	End year for the climatology		2010
scale	no	Dataset scale	Depends dataset and bounding box	4000
bounding_box	no	The bounding box [SWLong, SWLat, NELong, NELat]	[-121.7, 38.3, -120.1, 38.9]