Collection and asset aliases

Catalogs can use different names for the same collection or band. Set aliases on each catalog so your queries and results use the names you choose.

Collection aliasesCopy Anchor Link

Put the name you want to use on the left and the catalog’s actual name on the right: your name → catalog name. For a catalog whose collection is called S2MSI2A:

# Fragment of one catalog entry, not a complete config file.
collection_aliases:
  sentinel-2-l2a: S2MSI2A

Search for sentinel-2-l2a in your application. SuperSTAC translates the outgoing query to S2MSI2A for that catalog. When response unification is enabled, the returned item's collection is changed back to the canonical name.

Check the catalog’s collection IDs before adding an alias. S2MSI2A here is an example; use the ID your catalog advertises.

Asset aliasesCopy Anchor Link

Group asset aliases under your collection name, called the canonical collection ID. Put your band name on the left and the catalog’s asset key on the right:

# Fragment of one catalog entry.
asset_aliases:
  sentinel-2-l2a:
    blue: B02
    green: B03
    red: B04
    nir: B08

With unification enabled, B04 appears as red in the returned item. Its URL and data stay the same. Check that the bands you give the same name are suitable for your analysis; an alias does not change resolution, calibration, or access requirements.

Keep the catalog’s names in resultsCopy Anchor Link

from superstac import Client

client = Client(settings={"unify_response": False})

Results keep the catalog’s collection and asset names. You can still search with your collection aliases: SuperSTAC translates them when sending the query. Names without an alias stay unchanged.

See the full configuration reference for where these fragments belong.