Timeseries
Timeseries Endpoints¶
The Timeseries endpoints are used to generate time series data for the datasets available in Climate Engine.
There are four groups of Timeseries endpoints for points, polygons or an Earth Engine FeaturesCollection:
-
/timeseries/native - The native endpoints are used to generate ‘raw’ time series data.
-
/timeseries/interannual - The interannual endpoints are used to generate time series of yearly values of the dataset variable summarized over a season.
-
/timeseries/standard_index - The standard index endpoints are used to generate time series of standard index values for selected accumulation period.
-
/timeseries/regression - The regression endpoints are used to perform regression analysis of the dataset variable summarized over a season.
NOTES: - The ‘forecasts’ endpoints are only available for forecast datasets CFS_GRIDMET, FRET, GEPS_2WK, “GEPS_4WK.
/timeseries/native/coordinates¶
- Generates timeseries of values of the dataset variable and timeperiod between start_date and end_date for points or polygons.
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/native/coordinates?coordinates=%5B%5B-121.61%2C38.78%5D%5D&area_reducer=mean&dataset=GRIDMET&variable=tmmn%2C%20tmmx&start_date=2018-01-01&end_date=2018-01-02
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| coordinates | yes | List of point or polygon coordinates, see https://support.climateengine.org/article/152-formatting-coordinates-for-api-requests | [[-119.96,39.57]] | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | GRIDMET | LANDSAT7_TOA | |
| variable | yes | Single or multiple variable | tmmn, tmmx | NDVI or NDVI, EVI |
| compute_trends | no | Compute trend from variables returned | sens_slope, polyfit | |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_date | yes | 2018-01-01 | 2019-01-01 | |
| end_date | yes | 2018-01-02 | 2019-12-31 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/native/feature_collection¶
- Generates timeseries of values of the dataset variable and timeperiod between start_date and end_date for the features of an Earth Engine FeatureCollection.
- The values are averaged over the pixels lying within each feature of the feature collection.
- Permissions on the asset must be such that it is readable by anyone.
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/native/feature_collection?feature_collection_asset_id=blm_ga_nv&area_reducer=mean&dataset=GRIDMET&variable=tmmn%2C%20tmmx&start_date=2018-01-01&end_date=2018-01-02
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| feature_collection_asset_id | yes | EE FeatureCollection asset id, must have “Anyone can read” permissions | blm_ga_nv | WCMC/WDPA/current/points |
| sub_choices | no | List of features to use in analysis, must be strings | [“Golden Gate”] | |
| filter_by | no | Property name to filter sub-choices | NAME | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | GRIDMET | LANDSAT7_TOA | |
| variable | yes | Single or multiple variable | tmmn, tmmx | NDVI or NDVI, EVI |
| compute_trends | no | Compute trend from variables returned | sens_slope, polyfit | |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_date | yes | 2018-01-01 | 2019-01-01 | |
| end_date | yes | 2018-01-02 | 2019-12-31 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/native/forecasts/coordinates¶
- Generates timeseries of forecast values of the dataset variable and timeperiod between start_date and end_date for points or polygons.
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/native/forecasts/coordinates?coordinates=%5B%5B-121.61%2C38.78%5D%5D&area_reducer=mean&dataset=CFS_GRIDMET&variable=tmmx&model=ens_mean
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| coordinates | yes | List of point or polygon coordinates, see https://support.climateengine.org/article/152-formatting-coordinates-for-api-requests | [[-119.96,39.57]] | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | CFS_GRIDMET | CFS_GRIDMET, FRET, GEPS_2WK,GEPS_4WK | |
| variable | yes | Single or multiple variable | tmmx | pr |
| model | yes | ens01 to en | ens_mean | ens_max |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/native/forecasts/feature_collection¶
- Generates timeseries of forecast values of the dataset variable and timeperiod between start_date and end_date for the features of an Earth Engine FeatureCollection.
- The values are averaged over the pixels lying within each feature of the feature collection.
- Permissions on the asset must be such that it is readable by anyone.
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/native/forecasts/feature_collection?feature_collection_asset_id=blm_ga_nv&area_reducer=mean&dataset=CFS_GRIDMET&variable=tmmx&model=ens_mean
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| feature_collection_asset_id | yes | EE FeatureCollection asset id, must have “Anyone can read” permissions | blm_ga_nv | WCMC/WDPA/current/points |
| sub_choices | no | List of features to use in analysis, must be strings | [“Golden Gate”] | |
| filter_by | no | Property name to filter sub-choices | NAME | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | GRIDMET | LANDSAT7_TOA | |
| variable | yes | Single or multiple variable | tmmn, tmmx | NDVI or NDVI, EVI |
| compute_trends | no | Compute trend from variables returned | sens_slope, polyfit | |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_date | yes | 2018-01-01 | 2019-01-01 | |
| end_date | yes | 2018-01-02 | 2019-12-31 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/standard_index/coordinates¶
- Generates timeseries of standard index based on inputs for points or polygons.
- Standard Precipitation Index (SPI) for example is the standard index of precipitation. To calculate SPI, you would use precipitation as the variable.
- Similarly, the Standardized Precipitation Evapotranspiration Index (SPEI) potential water deficit (precipitation minus potential evapotranspiration) would be used as the variable.
- In the case of a buffer, the values are reduced over the pixels lying within the point before calculating the standard index.
- Note: Cannot use pre-calculated drought indices, i.e. GridMET Drought as dataset/variable.
- Available variables: spi, spei, eddi, speih, edddih
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/standard_index/coordinates?coordinates=%5B%5B-121.61%2C38.78%5D%5D&area_reducer=mean&dataset=PRISM_MONTHLY_4km&variable=spi&start_date=2018-01-01&end_date=2018-01-02&start_year=1991&end_year=2020&accumulation=3&distribution=gamma
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| coordinates | yes | List of point or polygon coordinates, see https://support.climateengine.org/article/152-formatting-coordinates-for-api-requests | [[-119.96,39.57]] | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | PRISM_MONTHLY_4km | PRISM_MONTHLY, GRIDMET | |
| variable | yes | Variable of interest | spi | spi, spei, eddi, speih, eddih |
| accumulation | yes | Accumulation period for index. Same unit as dataset | 3 | 3, 30, 12, 365 |
| distribution | yes | The distribution used to calculate the standard index | loglogistic | loglogistic, gamma, nonparametric |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_date | yes | 2018-01-01 | 2019-01-01 | |
| end_date | yes | 2018-01-02 | 2019-12-31 | |
| start_year | yes | 1991 | 1990 | |
| end_year | yes | 2020 | 2020 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/standar_index/feature_collection¶
- Generates timeseries of standard index based on inputs for an Earth Engine FeatureCollection.
- Standard Precipitation Index (SPI) for example is the standard index of precipitation. To calculate SPI, you would use precipitation as the variable.
- Similarly, the Standardized Precipitation Evapotranspiration Index (SPEI) potential water deficit (precipitation minus potential evapotranspiration) would be used as the variable.
- The values are reduced over the pixels lying within the feature before calculating the standard index.
- Note: Cannot use pre-calculated drought indices, i.e. GridMET Drought as dataset/variable.
- Available variables: spi, spei, eddi, speih, edddih
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/standard_index/feature_collection?feature_collection_asset_id=blm_ga_nv&area_reducer=mean&dataset=PRISM_MONTHLY_4km&variable=spi&start_date=2018-01-01&end_date=2018-01-02&start_year=1991&end_year=2020&accumulation=3&distribution=gamma
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| feature_collection_asset_id | yes | EE FeatureCollection asset id, must have “Anyone can read” permissions | blm_ga_nv | WCMC/WDPA/current/points |
| sub_choices | no | List of features to use in analysis, must be strings | [“Golden Gate”] | |
| filter_by | no | Property name to filter sub-choices | NAME | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | PRISM_MONTHLY_4km | PRISM_MONTHLY, GRIDMET | |
| variable | yes | Variable of interest | spi | spi, spei, eddi, speih, eddih |
| accumulation | yes | Accumulation period for index. Same unit as dataset | 3 | 3, 30, 12, 365 |
| distribution | yes | The distribution used to calculate the standard index | loglogistic | loglogistic, gamma, nonparametric |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_date | yes | 2018-01-01 | 2019-01-01 | |
| end_date | yes | 2018-01-02 | 2019-12-31 | |
| start_year | yes | 1991 | 1990 | |
| end_year | yes | 2020 | 2020 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/interannual/coordinates¶
- Generates timeseries of yearly values of the dataset variable summarized over a season for points or polygons.
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/interannual/coordinates?coordinates=%5B%5B-121.61%2C38.78%5D%5D&area_reducer=mean&dataset=GRIDMET&variable=tmmn%2C%20tmmx&start_day=01&end_day=30&start_month=01&end_month=12&start_year=1991&end_year=2020&temporal_statistic=mean
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| coordinates | yes | List of point or polygon coordinates, see https://support.climateengine.org/article/152-formatting-coordinates-for-api-requests | [[-119.96,39.57]] | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | GRIDMET | LANDSAT7_TOA | |
| variable | yes | Single or multiple variable | tmmn, tmmx | NDVI or NDVI, EVI |
| compute_trends | no | Compute trend from variables returned | sens_slope, polyfit | |
| temporal_statistic | yes | mean | mean, max, min, total | |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_day | yes | 01 | 01 | |
| end_day | yes | 30 | 30 | |
| start_month | yes | 01 | 01 | |
| end_month | yes | 12 | 12 | |
| start_year | yes | 1991 | 2016 | |
| end_year | yes | 2020 | 2018 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/interannual/feature_collection¶
- Generates timeseries of yearly values of the dataset variable summarized over a season for the features of an Earth Engine FeatureCollection.
- The values are averaged over the pixels lying within each feature of the feature collection.
- Permissions on the asset must be such that it is readable by anyone.
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/interannual/feature_collection?feature_collection_asset_id=blm_ga_nv&area_reducer=mean&dataset=GRIDMET&variable=tmmn%2C%20tmmx&start_day=01&end_day=30&start_month=01&end_month=12&start_year=1991&end_year=2020&temporal_statistic=mean
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| feature_collection_asset_id | yes | EE FeatureCollection asset id, must have “Anyone can read” permissions | blm_ga_nv | WCMC/WDPA/current/points |
| sub_choices | no | List of features to use in analysis, must be strings | [“Golden Gate”] | |
| filter_by | no | Property name to filter sub-choices | NAME | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max, stdev, count, count_un, skew, kurtosis, percentile_5, percentile_10, percentile_25, percentile_75, percentile_90, percentile_95 |
| dataset | yes | GRIDMET | LANDSAT7_TOA | |
| variable | yes | Single or multiple variable | tmmn, tmmx | NDVI or NDVI, EVI |
| compute_trends | no | Compute trend from variables returned | sens_slope, polyfit | |
| temporal_statistic | yes | mean | mean, max, min, total | |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_day | yes | 01 | 01 | |
| end_day | yes | 30 | 30 | |
| start_month | yes | 01 | 01 | |
| end_month | yes | 12 | 12 | |
| start_year | yes | 1991 | 2016 | |
| end_year | yes | 2020 | 2018 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/regression/coordinates¶
- Performs regression analysis of the dataset variable summarized over a season for points or polygons.
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/regression/coordinates?coordinates=%5B%5B-121.61%2C38.78%5D%5D&area_reducer=mean&dataset=LANDSAT_TOA&variable=NDVI&start_day=01&end_day=30&start_month=01&end_month=12&start_year=2016&end_year=2017&temporal_statistic=mean&var2_dataset=GRIDMET&var2_variable=pr&var2_start_day=01&var2_end_day=30&var2_start_month=01&var2_end_month=12&var2_temporal_statistic=sum
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| coordinates | yes | List of point or polygon coordinates, see https://support.climateengine.org/article/152-formatting-coordinates-for-api-requests | [[-119.96,39.57]] | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | LANDSAT_TOA | LANDSAT7_TOA | |
| variable | yes | NDVI | NDVI | |
| compute_trends | no | Compute trend from variables returned | sens_slope, polyfit | |
| temporal_statistic | yes | mean | mean, max, min, total | |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_day | yes | 01 | 01 | |
| end_day | yes | 30 | 30 | |
| start_month | yes | 01 | 01 | |
| end_month | yes | 12 | 12 | |
| var2_dataset | yes | GRIDMET | LANDSAT7_TOA | |
| var2_variable | yes | pr | NDSI | |
| var2_mask_image_id | no | Image mask ID for the second dataset/variable | ||
| var2_mask_band | no | Mask band for the second dataset/variable | ||
| var2_mask_value | no | Image mask value for the second dataset/variable | ||
| var2_start_day | yes | 01 | 01 | |
| var2_end_day | yes | 30 | 30 | |
| var2_start_month | yes | 01 | 01 | |
| var2_ end_month | yes | 12 | 12 | |
| var2_temporal_statistic | yes | total | mean, max, min, total | |
| start_year | yes | 2016 | 2016 | |
| end_year | yes | 2017 | 2018 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |
/timeseries/regression/feature_collection¶
- Performs regression analysis of the dataset variable summarized over a season for the features of an Earth Engine FeatureCollection.
- The values are averaged over the pixels lying within each feature of the feature collection.
- Permissions on the asset must be such that it is readable by anyone.
- Returns: json
URL Example:
https://api.climateengine.org/timeseries/regression/feature_collection?feature_collection_asset_id=blm_ga_nv&area_reducer=mean&dataset=LANDSAT_TOA&variable=NDVI&start_day=01&end_day=30&start_month=01&end_month=12&start_year=2016&end_year=2017&temporal_statistic=mean&var2_dataset=GRIDMET&var2_variable=pr&var2_start_day=01&var2_end_day=30&var2_start_month=01&var2_end_month=12&var2_temporal_statistic=sum
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| feature_collection_asset_id | yes | EE FeatureCollection asset id, must have “Anyone can read” permissions | blm_ga_nv | WCMC/WDPA/current/points |
| sub_choices | no | List of features to use in analysis, must be strings | [“Golden Gate”] | |
| filter_by | no | Property name to filter sub-choices | NAME | |
| simplify_geometry | no | maxError in meters, see ee.Feature.simplify | None | |
| buffer | no | List of integer buffers (meters) to be applied to each geometry | [400] | |
| area_reducer | yes | Statistic over region | mean | mean, median, min, max |
| dataset | yes | LANDSAT_TOA | LANDSAT7_TOA | |
| variable | yes | NDVI | NDVI | |
| compute_trends | no | Compute trend from variables returned | sens_slope, polyfit | |
| temporal_statistic | yes | mean | mean, max, min, total | |
| mask_image_id | no | Image mask ID | ||
| mask_band | no | Mask band | ||
| mask_value | no | Image mask value | ||
| start_day | yes | 01 | 01 | |
| end_day | yes | 30 | 30 | |
| start_month | yes | 01 | 01 | |
| end_month | yes | 12 | 12 | |
| var2_dataset | yes | GRIDMET | LANDSAT7_TOA | |
| var2_variable | yes | pr | NDSI | |
| var2_mask_image_id | no | Image mask ID for the second dataset/variable | ||
| var2_mask_band | no | Mask band for the second dataset/variable | ||
| var2_mask_value | no | Image mask value for the second dataset/variable | ||
| var2_start_day | yes | 01 | 01 | |
| var2_end_day | yes | 30 | 30 | |
| var2_start_month | yes | 01 | 01 | |
| var2_ end_month | yes | 12 | 12 | |
| var2_temporal_statistic | yes | total | mean, max, min, total | |
| start_year | yes | 2016 | 2016 | |
| end_year | yes | 2017 | 2018 | |
| export_path | no | Export CSV results to a Google cloud storage bucket (must have correct permissions) | climate-engine-public/my_csv_file.csv | |
| export_format | no | File format of export | json | csv, json |