stac-api-extensions

STAC API Extensions

The stac-api-extensions GitHub organization is a home for extensions to the SpatioTemporal Asset Catalog API foundation specifications.

To learn about STAC API and Extensions, start with the extensions section of the STAC API specifications. It explains how extensions work, lists all the known extensions, and has instructions for how to go about creating new extensions.

The stac-api-extensions GitHub organization is a home for many of the leading “community extensions”, providing a neutral home for collaboration. Many of these used to be in the stac-api-spec repository, but were removed so they could evolve at their own pace, instead of having to follow the core STAC API release cycle.

List of STAC API Extensions

This is meant to be the definitive list of STAC API Extensions, but not all of them may be part of this GitHub organization.

An asterisk (*) indicates a community extension that is hosted externally. As such is not part of the stac-api-extensions GitHub organization and may not follow the normal procedure or classification for STAC API extensions, e.g. regarding the maturity.

Alphabetical

Title Scope Maturity Version Description
Aggregation STAC API - Core Proposal 0.3.0 Aggregation Extension to provide aggregated data over a search, rather than individual Item results
Browseable STAC API - Core Proposal 1.0.0-rc.3 Browseable advertises all Items in a STAC API Catalog can be reached by traversing child and item links.
Children STAC API - Core Proposal 1.0.0-rc.2 The purpose of this extension is to add an endpoint that presents a single resource from which clients can retrieve the immediate children of a Catalog.
Collection Search STAC API - Core Pilot 1.0.0-rc.1 Collection Search for STAC APIs
Collection Transaction STAC API - Collections Candidate 1.0.0-beta.1 The Collection Transaction Extension supports the creation, editing, and deleting of Collections through POST, PUT, PATCH, and DELETE requests.
Context STAC API - Features, STAC API - Item Search Deprecated 1.0.0-rc.2 Context Extension
Context Collections* STAC - Core WIP Unreleased This defines a new parameter, collections inside the context response which is a summary of all the collections which are part of the current result context.
Fields STAC API - Features, STAC API - Item Search Candidate 1.0.0 The Fields Extensions describes a mechanism to include or exclude certain fields from a response.
Filter STAC API - Features, STAC API - Item Search Pilot 1.0.0-rc.3 The Filter extension provides an expressive mechanism for searching based on Item attributes.
Free-Text Search - STAC API - Collection Search Proposal 1.0.0-rc.1 This defines a new parameter, q that allows the user to perform free-text queries against the item properties.
Language (I18N) STAC API - Core Pilot 1.0.0-rc.2 Definitions and recommendations around making multi-lingual STAC APIs available
Query STAC API - Features, STAC API - Item Search Stable 1.0.0 The Query Extension adds a query parameter that allows additional filtering based on the properties of Item objects.
Sort STAC API - Features, STAC API - Item Search Stable 1.0.0 The Sort Extension that allows the user to define the fields by which to sort results.
Transaction STAC API - Features Candidate 1.0.0-rc.3 The Transaction Extension supports the creation, editing, and deleting of items through POST, PUT, PATCH, and DELETE requests.
Version STAC API - Features Deprecated Unreleased Item and Collection Version Extension

Grouped by maturity

Stable

Candidate

Pilot

Proposal

WIP

Deprecated

You can add external/community extensions to the list above by editing the config file and creating a Pull Request for the change. All extensions hosted in the stac-api-extensions organization will be added automatically each night.