Reference

API reference

1 min read

An overview of the Airfree platform APIs: one origin, one token, versioned service paths, and consistent conventions across every service.

This reference orients you across the Airfree platform APIs. Every service is reached through one origin and one authenticating edge, so a single access token works across all of them and the conventions below hold everywhere.

Paths and versioning

API resources live under a versioned, per-service path. The service segment names the capability; the version segment lets the platform evolve without breaking you.

https://airfree.au/api/v1/<service>/<resource>

Examples:
  /api/v1/ogc/collections
  /api/v1/cadastre/parcels
  /api/v1/eo/search
  /api/v1/geocoding/search

Per-service documentation

Geospatial API — tiles, features, coverages, processing, and OGC services.
Maps Embed SDK — interactive same-origin maps in the browser.
Earth Observation API — STAC-catalogued imagery and derived products.
Digital Twin API — live 3D models with IoT telemetry.
Cadastre API — authoritative parcels and boundaries.

Shared conventions

Across services, responses are JSON, authentication is a bearer token, errors carry a quotable trace reference, and collections are paginated. Read the Authentication and Rate limits guides before you build.

Wrong service name in the path returns 404; a valid token without the required role returns 403. Keep those two apart when debugging.

All documentation Need help? Contact us