Skip to content

Fetch API

Fetch API enables you to retrieve data that has been previously processed via the Core APIs and Batch APIs. It performs real-time querying capabilities on user-provided and processed supply base data, to return plot-level sustainability metrics (LUC emissions, biodiversity, deforestation), as well as statistically representative comparison to reference areas (watershed or administrative unit).

Available Endpoints

The current Fetch API requests are the following:

Core Data Retrieval

  • Fetch Plots (/fetch_plots/) - Retrieve user-provided and processed plots data with comprehensive sustainability metrics (deforestation, LUC, biodiversity, CFT).
  • Fetch Biomass Data (/fetch_biomass_data) - Retrieve plot-level biomass and LUC emissions data from processed collections.
  • Fetch Statistical Regions (/fetch_stat_regions/) - Retrieve statistical reference areas (watersheds or administrative units) where the user-uploaded supply base is located.
  • Fetch Statistical Biomass Data (/fetch_stat_biomass_data) - Retrieve statistical reference areas with biomass/LUC metrics.
  • Fetch Supply Shed (/fetch_supply_shed) - Retrieve supply shed analysis and traceability information.

Simple Fetch Endpoints

  • Fetch Deforestation Check (/fetch_deforestation_check) - Retrieve deforestation analysis data for individual plots with EUDR compliance support.
  • Fetch Biomass Emissions (/fetch_biomass_emissions) - Retrieve biomass emissions and land use change data for individual plots.
  • Fetch Biodiversity (/fetch_biodiversity) - Retrieve biodiversity metrics including canopy height and landscape connectivity for individual plots.
  • Fetch Water Stress (/fetch_water_stress) - Retrieve water stress metrics including precipitation, soil moisture, and evapotranspiration data for individual plots.
  • Fetch Samples (/fetch_samples) - Retrieve statistically valid field sampling plans (strata and sample points) generated via the Batch API.
  • Fetch Segments (/fetch_segments/) - Retrieve plot segments from segmentation/detection workflows.

EUDR / TRACES

Other Fetch Endpoints

  • /fetch_thumbnail/ - Retrieve thumbnail imagery for a plot.
  • /fetch_lca_inputs/ - Retrieve LCA input data for non-biomass emissions.
  • /fetch_lca_emissions/ - Retrieve LCA emissions data.
  • /fetch_cft_emissions - Retrieve Corporate Forest Transparency emissions data.

Legacy Endpoints

  • /fetch_non_biomass_data - Farmgate management practices-related emissions (currently not documented).
  • /fetch_stat_non_biomass_data - Farmgate emissions for statistical reference areas (currently not documented).

Response Format

All Fetch API endpoints return streaming responses in NDJSON format (newline-delimited JSON). This means that the server streams the database table rows as they become available, allowing for efficient handling of large datasets and real-time data population in dashboards.

Each line in the response contains a single JSON object representing either: - A GeoJSON Feature with plot-level data and geometry - Statistical summary data for reference areas - EUDR compliance information and risk assessments

Usage Patterns

Real-time Dashboard Integration

The streaming nature of these endpoints makes them ideal for populating dashboards incrementally, providing users with immediate access to data as it becomes available.

Batch Data Processing

For programmatic access, you can process the streaming response line by line to extract specific metrics or perform custom analysis on the plot-level data.

EUDR Compliance Workflows

The EUDR-specific endpoints provide structured data for compliance reporting, risk assessment, audit trail generation required under European Union regulations.

Authentication

All Fetch API endpoints require authentication using Bearer tokens. See the Authentication documentation for details on obtaining and using access tokens.