Updates to api timeseries and zonal stats endpoints

Overview¶

This update simplifies API endpoints by consolidating similar endpoints and streamlining parameter usage. Changes affect all timeseries, zonal_stats, and probabilities endpoints in the API.

1. Consolidation of Point and Polygon Endpoints to Coordinates¶

Updated Endpoints: The "point" and "polygon" endpoints have been merged into a single "coordinates" endpoint. While parameter names remain unchanged, you must now use the coordinates endpoint:

Examples:

• /timeseries/native/polygons → /timeseries/native/coordinates
• /zonal_stats/pixel_count/timeseries/custom_asset → /zonal_stats/pixel_count/timeseries/feature_collection
• /probabilities/interior/climate_engine_asset → /probabilities/interior/feature_collection

Parameter Details:

• Accepted Coordinate Formats :
  • Single point or list of point coordinates
  • Single polygon or list of polygon coordinates
  • List of multipolygon coordinates
• Note : Mixed geometries are unsupported. For example, do not mix points and multipolygons in the same request.

For detailed information on formatting coordinates, see Formatting Coordinates for API Requests.

2. climate_engine_asset and custom_asset Endpoints Consolidated to feature_collection¶

Updated Endpoints¶

The climate_engine_asset and custom_asset endpoints are now combined under feature_collection.

Parameter Updates:

• region → feature_collection_asset_id
  • You may provide either:
  • The Earth Engine asset ID of a Feature Collection, or
  • The original climate_engine_asset name.
  • Examples : feature_collection_asset_id = USGS/WBD/2017/HUC08 or feature_collection_asset_id = huc8

asset_id → feature_collection_asset_id

* As with `region`, you can pass the Earth Engine asset ID or the `climate_engine_asset` name.
* **Examples** : `feature_collection_asset_id = TIGER/2018/States` or `feature_collection_asset_id = states`

For detailed information on using feature collections, see Formatting feature collections for API requests.

Summary¶

These updates streamline endpoint access and make parameter usage more consistent. Update your API requests according to these guidelines to ensure compatibility. If you need further assistance, please refer to our full API Documentation.