API User Guide

API User Guide#

The API user guide introduces all the features offered by eodag through its API and explains how they should be used. Each page is a Jupyter notebook that can be viewed online, run online thanks to Binder, or run locally after being downloaded (see how to Run the notebooks locally).

Providers & Products types

Discover available data providers and explore the different product types accessible through the API.

Providers and products
Configuration

Learn how to configure your data providers, set their priorities, and configure logging to optimize your workflow.

Configuration
Search

Master advanced search techniques: pagination, filters, custom parameters, and error handling for efficient data discovery.

Search
Queryables

Explore available query parameters to refine your searches and discover new filtering criteria for better results.

Queryables
Serialize / Deserialize

Efficiently manage serialization and deserialization of your search results to save and reuse them across sessions.

Serialize/Deserialize
Crunch

Post-search filter your products using various criteria: temporal, geographical, properties, and online availability.

Crunch
Download

Download your products with progress bars, quicklooks management, and efficient assets handling.

Download
Post-processing

Post-process your data: downloaded file path management, Sentinel formats, and xarray conversion with eodag-cube.

Post-process
STAC Client Tutorial

Learn how to use EODAG as a STAC client to access data through STAC APIs and static catalogs.

STAC client