For the complete documentation index, see llms.txt. This page is also available as Markdown.

Coverage API

The Coverage API lets you check where Spexi has drone imagery available, expressed as H3 hexagonal cells. Use it to render a coverage map, query coverage for an area, or look up detail on a specific zone before placing a tasking order.

Endpoints

  • Get Coverage Tiles - fetch MVT vector tiles of coverage for map rendering, by zoom/x/y

  • Query Coverage - query aggregated coverage zones by bounding box or point

  • Get Zone Details - fetch full coverage detail for a single H3 cell, including missions and latest capture

Choosing an Endpoint

Get Coverage Tiles returns vector tiles (MVT) meant for rendering a coverage layer on a map at a given zoom level. Use this to visualize coverage across an area.

Query Coverage returns aggregated zone data for a bounding box or point. Useful when you need the underlying coverage data itself rather than a map layer, for example, to check coverage programmatically before deciding whether to place a tasking order.

Get Zone Details returns full detail for one H3 cell (mission list, mission count, latest capture date). Use this once you've identified a specific zone, for example, after retrieving a response from Query Coverage.

Filtering

All three endpoints support the same capture type and date filters, and the same entitlement filter.

Entitlement Filtering

Pass entitled=true to restrict results to coverage the authenticated caller is entitled to, rather than all coverage that exists. This requires authentication; passing entitled=true without valid auth returns a 401. Omit it (or leave it false) to see all coverage regardless of entitlement.

Last updated