Welcome to Climate Engine API’s documentation!

Version:

649afc3

Date:

Mar 21, 2023

GETTING STARTED

• Overview
• Registration
• Authentication
  • Tokens
  • Security

REST API

• Maps
  • /raster/mapid/values
  • /raster/mapid/forecasts/values
  • /raster/mapid/climatologies
  • /raster/mapid/anomalies
  • /raster/mapid/forecasts/anomalies
  • /raster/mapid/percentiles
  • /raster/mapid/forecasts/percentiles
  • /raster/mapid/standard_index
  • /raster/mapid/forecasts/standard_index
  • /raster/mapid/mann_kendall
  • /raster/export/task_update
  • /raster/export/task_queue
  • /raster/export/values
  • /raster/export/forecasts/values
  • /raster/export/climatologies
  • /raster/export/anomalies
  • /raster/export/forecasts/anomalies
  • /raster/export/percentiles
  • /raster/export/forecasts/percentiles
  • /raster/export/standard_index
  • /raster/export/forecasts/standard_index
  • /raster/export/mann_kendall
  • /raster/metadata/percentiles/values
  • /raster/metadata/percentiles/climatologies
  • /raster/metadata/percentiles/anomalies
  • /raster/metadata/percentiles/standard_index
  • /raster/metadata/percentiles/mann_kendall
  • /raster/metadata/statistics/values
  • /raster/metadata/statistics/climatologies
  • /raster/metadata/statistics/anomalies
  • /raster/metadata/statistics/standard_index
  • /raster/metadata/statistics/mann_kendall
• Timeseries
  • /timeseries/native/points
  • /timeseries/native/forecasts/points
  • /timeseries/native/polygons
  • /timeseries/native/forecasts/polygons
  • /timeseries/native/climate_engine_asset
  • /timeseries/native/forecasts/climate_engine_asset
  • /timeseries/native/custom_asset
  • /timeseries/native/forecasts/custom_asset
  • /timeseries/interannual/points
  • /timeseries/interannual/polygons
  • /timeseries/interannual/climate_engine_asset
  • /timeseries/interannual/custom_asset
  • /timeseries/regression/points
  • /timeseries/regression/polygons
  • /timeseries/regression/climate_engine_asset
  • /timeseries/regression/custom_asset
• Zonal Statistics
  • /zonal_stats/pixel_count/climate_engine_asset
  • /zonal_stats/pixel_count/custom_asset
  • /zonal_stats/pixel_count/polygons
  • /zonal_stats/pixel_count/timeseries/climate_engine_asset
  • /zonal_stats/pixel_count/timeseries/custom_asset
  • /zonal_stats/pixel_count/timeseries/polygon
  • /zonal_stats/values/climate_engine_asset
  • /zonal_stats/values/custom_asset
  • /zonal_stats/values/polygons
  • /zonal_stats/value/climate_engine_asset
  • /zonal_stats/value/custom_asset
  • /zonal_stats/value/points
  • /zonal_stats/value/polygons
• Probabilities
  • /probabilities/exceedance/points
  • /probabilities/exceedance/polygons
  • /probabilities/exceedance/climate_engine_asset
  • /probabilities/exceedance/custom_asset
  • /probabilities/exxterior_probabilities/points
  • /probabilities/exterior/polygons
  • /probabilities/exterior/climate_engine_asset
  • /probabilities/exterior/custom_asset
  • /probabilities/interior/points
  • /probabilities/interior/polygons
  • /probabilities/interior/climate_engine_asset
  • /probabilities/interiorprobabilities/custom_asset

OPTIONS

• Datasets
• Variables
  • top
  • ACIS NRCC NN Daily
  • ANUSPLIN Gridded Climate for Canada - Daily
  • ANUSPLIN Gridded Climate for Canada - Monthly
  • Canadian Drought Outlook
  • Copernicus Emergency Management Service Fire Danger Indices
  • CHIRPS Daily
  • CHIRPS Pentad
  • CHIRPS Preliminary Pentad
  • CFS gridMET 28-Day Forecasts
  • CFSV2 Reanalysis
  • USGS 1/10-deg static earthquake damage risk dataset
  • ERA5 - Daily
  • ERA5 Ag - Daily
  • ERA5 Land - Daily
  • ESI 4 Week
  • ESI 12 Week
  • Global Ensemble Prediction System 2 week
  • Global Ensemble Prediction System 4 week
  • FLDAS
  • FRET 7-Day Forecasts
  • GLDAS
  • GPM 11km - Daily
  • GRIDMET
  • GRIDMET DROUGHT
  • RAP Herbaceous Production
  • RAP Vegetation Cover
  • HRDPA
  • HRDPS
  • Landsat 4/5/7/8 Surface Reflectance
  • Landsat 5 Surface Reflectance
  • Landsat 7 Surface Reflectance
  • Landsat 8 Surface Reflectance
  • Landsat 9 Surface Reflectance
  • Landsat 4/5/7/8 Top Of Atmosphere
  • Landsat 5 Top Of Atmosphere
  • Landsat 7 Top Of Atmosphere
  • Landsat 8 Top Of Atmosphere
  • Landsat 9 Top Of Atmosphere
  • MERRA2
  • MERRA2 Fire Weather Index dataset (NASA)
  • MODIS TERRA NET ET 16-day
  • MODIS Burned Area - Monthly
  • MODIS Terra/Aqua 16-Day
  • MODIS Terra 16-Day
  • MODIS Terra 8-Day
  • MODIS Terra Daily
  • MODIS Aqua 16-Day
  • MODIS Aqua 8-Day
  • MODIS Aqua Daily
  • NADM - Monthly
  • NCEP - Daily
  • NClimGrid-Daily 5-km
  • NClimGrid-Monthly 5-km
  • NLDAS2 DAILY reanalysis
  • NOAA AVHRR Pathfinder V 5.2 4-km sea surface
  • NOAA CDR PERSIANN
  • NOAA CPC Conus Unified Gauge-Based Analysis
  • NOAA CPC Global Unified Gauge-Based Analysis
  • NOAA Satellite Precipitation - CMORPH
  • OISST - Daily
  • OpenET Conus
  • PML_V2 Evapotranspiration dataset
  • PRISM
  • PRISM_MONTHLY
  • RDPA
  • RDPS
  • RTMA
  • Sentinel 2 Surface Reflectance
  • Sentinel 2 Top Of Atmosphere
  • RST Sentinel 5P Methane
  • SNODAS
  • TerraClimate
  • TRMM 28-km (1/4-deg) precipitation dataset (NASA)
  • US Drought Outlook
  • USDM Drought Monitor
  • USGS MODIS ET - SSEBop Dekadal
  • USGS MODIS ET - SSEBop Monthly
  • USGS MODIS ET - SSEBop Annual
  • USDA 30-m static wildfire risk dataset (WRC)
• Climate Engine Assets

TUTORIALS

• Basic Tutorials
  • Basic python example
  • Downloading files from Google Bucket
  • Testing your map id
• Google Cloud Storage Examples
  • What is a Google Cloud Storage bucket?
  • Setting up access on a local machine
  • Cloud Storage functions
• Timeseries API Examples
  • Native Values - Landsat NDVI
  • Interannual Values - NDVI and Precipitation
• Zonal Statistics API Examples
  • Pixel Counts - 180-day Standard Precipitation Index
  • Values - Aridity Index
• Maps API Examples
  • Vapor Pressure Deficit
  • NDVI Anomalies
  • Precipitation