API Reference

OpenET provides data at different scales. You can retrieve the data summarized for millions of individual fields or in the original raster format.

Account Endpoints

Information retrieval for your account.

Account

Raster Endpoints

Custom data services. More computationally intensive, but more options available.

Raster

Geodatabase Endpoints

Pre-computed data services. Faster to retrieve, but geometries are fixed.

Geodatabase

High-level Comparison

Geodatabase

• Lighting fast queries

• Single request multi-model, multi-variable data retrieval supported

• OpenET field boundary geometry retrieval as geoJSON

Raster

• Retrieve daily data

• Gridded raster retrieval as GeoTIFF

• Large query support with data exporting

• Additional query customization

• Dynamic map generation with automated tile cache

• Account syncing with Earth Engine

Accepted Parameters

Here are the current API parameter names and input values. If you aren't sure about the datatype, check out the endpoint schemas or one of the provided examples. Optional parameters are not checked with their default in bold.

Note: capitalization is optional for parameter values, unless it is a predefined user value such as a shapefile attribute name.

Account

• file: Multipart form data path as a string.

Geodatabase

• date_range: Inclusive start and end dates in an ISO8061 format as a list.

• interval: Data time step. Currently only monthly, supported.

• geometry: A longitude, latitude coordinate list for a simple closed polygon.

• model: OpenET model. Choose from Ensemble, geeSEBAL, SSEBop, SIMS, DisALEXI, PTJPL, or eeMETRIC.

• field_ids: A list of unique OpenET field identifiers.

• variable: Collection variable. Choose from ET, ET_MAD_MIN, ET_MAD_MAX, ETo, ETof, NDVI, or PR.

Raster

• asset_id: Path to Google Earth Engine feature collection. Must be shared with [e-mail].

• attributes: List of shapefile attributes to include in extraction. Must include a unique identifier for each polygon.

• cog: Boolean for cloud optimized GeoTIFF format. Default is False.

• date_range: Inclusive start and end dates in an ISO8061 format as a list.

• drive_folder: If Earth Engine account is linked you may specify the destination folder you have created at the root of your Google Drive. Default is OpenET Exports.

• encrypt: Boolean for file export encryption if enable for your account. Default is False.

• file_format: Output file extension. Choose from csv or json.

• geometry: A longitude, latitude coordinate list for a simple closed polygon.

• gradient: Visual options containing min and max bounds with list of hex codes for a color ramp.

• interval: Data time step. Choose from daily, or monthly.

• model: OpenET model. Choose from Ensemble, geeSEBAL, SSEBop, SIMS, DisALEXI, PTJPL, or eeMETRIC.

• overpass: When interval is set to daily, returns only the satellite observed scenes. Default is False.

• reducer: Pixel aggregation method. Choose from min, max, mean, median, mode, or sum.

• reference_et: Source collection for ET reference. Choose from CIMIS (California only) or gridMET. NOAA's forecasted reference ET FRET can now be used for 7 day forecasts.

• resample: Pixel re-sampling in meters for raster data. Choose from 0, 10, 20, or 30.

• tracking_id: Alphanumeric id assigned after exporting data.

• units: Output unit for depth measurement. Choose from in or mm.

• variable: Collection variable. Choose from ET, ET_MAD_MIN, ET_MAD_MAX, ETo, ETr, ETof, NDVI, PR, COUNT, or MODEL_COUNT