Metadata
Metadata Endpoints¶
The Metadata endpoints are used to return metadata for the datasets available in Climate Engine.
/metadata/dataset_dates¶
- Returns dataset start and end/most recent date.
- Returns: json
URL Example:
| 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 a list of input dataset's variables.
- Returns: json
URL Example:
| 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
URL Example:
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | 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
URL Example:
https://api.climateengine.org/metadata/raster/percentiles/values?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&bounding_box=%5B-127.32%2C22.73%2C-57.44%2C49.19%5D&scale=4000&percentiles=%5B0%2C%205%2C%2010%2C%2025%2C%2050%2C%2075%2C%2090%2C%2095%2C%20100%5D&start_date=2010-06-01&end_date=2010-06-30
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| export_format | no | File format of export | json | csv, json |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-121.7, 38.3, -120.1, 38.9] |
| percentiles | no | The percentiles | [0, 5, 10, 25, 50, 75, 90, 95, 100] | [0, 25, 50, 75, 100] |
/metadata/raster/percentiles/climatologies¶
- Computes percentiles of map of average values of the dataset variable over the time period.
- Returns: json
URL Example:
https://api.climateengine.org/metadata/raster/percentiles/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&bounding_box=%5B-127.32%2C22.73%2C-57.44%2C49.19%5D&scale=4000&percentiles=%5B0%2C%205%2C%2010%2C%2025%2C%2050%2C%2075%2C%2090%2C%2095%2C%20100%5D&start_season=08-01&end_season=10-31&start_year=2016&end_year=2018
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| export_format | no | File format of export | json | csv, json |
| start_season | yes | 08-01 | 05-10 | |
| end_season | yes | 10-31 | 10-16 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-121.7, 38.3, -120.1, 38.9] |
| percentiles | no | The percentiles | [0, 5, 10, 25, 50, 75, 90, 95, 100] | [0, 25, 50, 75, 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
URL Example:
https://api.climateengine.org/metadata/raster/percentiles/anomalies?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&bounding_box=%5B-127.32%2C22.73%2C-57.44%2C49.19%5D&scale=4000&percentiles=%5B0%2C%205%2C%2010%2C%2025%2C%2050%2C%2075%2C%2090%2C%2095%2C%20100%5D&calculation=anom&start_date=2010-06-01&end_date=2010-06-30&start_year=2016&end_year=2018
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| export_format | no | File format of export | json | csv, json |
| calculation | yes | Anomaly calculation | anom | anom, anompercentof, anompercentchange |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-121.7, 38.3, -120.1, 38.9] |
| percentiles | no | The percentiles | [0, 5, 10, 25, 50, 75, 90, 95, 100] | [0, 25, 50, 75, 100] |
/metadata/raster/percentiles/standard_index¶
- Returns percentiles of a map of drought indices of the dataset variable over the time period. Available variables by dataset:
- GRIDMET: spi, spei, eddi, pdsi
- CHIRPS_PENTAD: spi
- CHIRPS_DAILY: spi
- PRISM: spi
- MERRA2: spi, spei, eddi
- Returns: json
URL Example:
https://api.climateengine.org/metadata/raster/percentiles/standard_index?dataset=GRIDMET&distribution=nonparametric&variable=eddi&start_date=2010-06-01&end_date=2010-06-30&start_year=2016&end_year=2018&bounding_box=%5B-121.7%2C38.3%2C-120.1%2C38.9%5D&scale=4000&percentiles=%5B0%2C%205%2C%2010%2C%2025%2C%2050%2C%2075%2C%2090%2C%2095%2C%20100%5D
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| export_format | no | File format of export | json | csv, json |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| distribution | yes | nonparametric | loglogistic, gamma, nonparametric | |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-121.7, 38.3, -120.1, 38.9] |
| percentiles | no | The percentiles | [0, 5, 10, 25, 50, 75, 90, 95, 100] | [0, 25, 50, 75, 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
URL Example:
https://api.climateengine.org/metadata/raster/percentiles/mann_kendall?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&bounding_box=%5B-127.32%2C22.73%2C-57.44%2C49.19%5D&scale=4000&percentiles=%5B0%2C%205%2C%2010%2C%2025%2C%2050%2C%2075%2C%2090%2C%2095%2C%20100%5D&start_season=08-01&end_season=10-31&start_year=2016&end_year=2018&calculation=mk_tau&p_value=0.5
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | 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_tau | 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 | 08-01 | 05-10 | |
| end_season | yes | 10-31 | 10-16 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-121.7, 38.3, -120.1, 38.9] |
| percentiles | no | The percentiles | [0, 5, 10, 25, 50, 75, 90, 95, 100] | [0, 25, 50, 75, 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
URL Example:
https://api.climateengine.org/metadata/raster/statistics/values?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&bounding_box=%5B-127.32%2C22.73%2C-57.44%2C49.19%5D&scale=4000&start_date=2010-06-01&end_date=2010-06-30
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| export_format | no | File format of export | json | csv, json |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-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
URL Example:
https://api.climateengine.org/metadata/raster/statistics/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&bounding_box=%5B-127.32%2C22.73%2C-57.44%2C49.19%5D&scale=4000&start_season=08-01&end_season=10-31&start_year=2016&end_year=2018
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| export_format | no | File format of export | json | csv, json |
| start_season | yes | 08-01 | 05-10 | |
| end_season | yes | 10-31 | 10-16 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-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
URL Example:
https://api.climateengine.org/metadata/raster/statistics/anomalies?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&bounding_box=%5B-127.32%2C22.73%2C-57.44%2C49.19%5D&scale=4000&calculation=anom&start_date=2010-06-01&end_date=2010-06-30&start_year=2016&end_year=2018
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| export_format | no | File format of export | json | csv, json |
| calculation | yes | Anomaly calculation | anom | anom, anompercentof, anompercentchange |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-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
URL Example:
https://api.climateengine.org/metadata/raster/statistics/standard_index?dataset=GRIDMET&distribution=nonparametric&variable=eddi&start_date=2010-06-01&end_date=2010-06-30&start_year=2016&end_year=2018&bounding_box=%5B-121.7%2C38.3%2C-120.1%2C38.9%5D&scale=4000
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| export_format | no | File format of export | json | csv, json |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| distribution | yes | nonparametric | loglogistic, gamma, nonparametric | |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-121.7, 38.3, -120.1, 38.9] |
/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
URL Example:
https://api.climateengine.org/metadata/raster/statistics/mann_kendall?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&bounding_box=%5B-127.32%2C22.73%2C-57.44%2C49.19%5D&scale=4000&start_season=08-01&end_season=10-31&start_year=2016&end_year=2018&calculation=mk_tau&p_value=0.5
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | 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_tau | 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 | 08-01 | 05-10 | |
| end_season | yes | 10-31 | 10-16 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| scale | no | Dataset scale | Depends on dataset and bounding box | 4000 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-127.32,22.73,-57.44,49.19] | [-121.7, 38.3, -120.1, 38.9] |