API Reference

API Reference#

The API Reference provides an overview of all public objects, functions and methods implemented in eodag.

EODataAccessGateway

The main entry point for accessing Earth observation data. Handles configuration, catalog access, search, filtering, and download operations.

EODataAccessGateway
SearchResult

Container for search results with filtering capabilities, conversion methods, and standardized interface for result manipulation.

SearchResult
EOProduct

Represents individual Earth observation products with download capabilities, format conversion, and pixel-level data access.

EOProduct
Assets

Manage product assets including AssetsDict and Asset classes for handling multi-file products and pixel access operations.

Assets
Utils

Utility functions for logging, callbacks, text search, notebook integration, S3 operations, xarray support, and miscellaneous helpers.

Utils
Exceptions

Complete set of custom exceptions for error handling including authentication, download, configuration, and validation errors.

Exceptions
Types

Type definitions, data models, and schema utilities for configuration management and type conversion between formats.

Types
Call Graphs

Visual representation of function call relationships and dependencies within the eodag codebase for development reference.

Call graphs