API reference

This section is generated from api/openapi.json on every build; there is no hand-written copy. Endpoint and field descriptions come from the OpenAPI document. For authentication, rate limits and the error format see the guides.

Source: api/openapi.json, API version 0.1.0, sha256 edae20545f20.

OpenAPI document of the public endpoints (for client generators)

Status

Whether the service is up.

• GET /v1/health Health

Flight upload

IGC upload (server to server, with the consent version).

• POST /v1/flights Upload a flight track (IGC, GPX or FIT)

Take-offs and landings

Approved take-off and landing sites as GeoJSON.

• GET /v1/sites Approved takeoff and landing sites in a bounding box
• GET /v1/sites/{site_id}/suitability Take-off suitability for a day from the wind forecast (pre-flight planning only)

Layer parameters

Hourly sun position and forecast wind for the slope layers (pre-flight only).

• GET /v1/slope-conditions Sun position and forecast wind per hour for the slope layers (pre-flight only)

Route suggestions

A few unranked route options from a take-off for a local day and hour, with landing alternatives; pre-flight planning only, always shown with the fixed pre-flight notice.

• GET /v1/routes Route suggestions from a take-off for a day and hour (pre-flight planning only)

Region packs

PMTiles files per region for offline use.

• GET /v1/packs/{region} Current offline pack of a region, with download URLs
• GET /v1/packs/{region}/{pack_version}/{file} Download one pack file through a signed URL (no API key)

Open data

Yearly open data packages (CC BY 4.0): releases, files, size and SHA-256; the same package downloads without a key on Atlas.

• GET /v1/open-data Published yearly open data packages (CC BY 4.0)
• GET /v1/open-data/{year}/{file} Download one file of a yearly open data package

Regions

Flying regions and region profiles.

• GET /v1/regions Public flying regions with simplified boundaries
• GET /v1/regions/{region}/profile Profile of a public flying region
• GET /v1/regions/{region}/incidents Known incidents and precautions of a public flying region

Consent

Withdrawing and giving again the consent to contribute.

• POST /v1/consents/withdrawals Withdraw a pilot's consent to the shared layers
• POST /v1/consents/grants Give consent to the shared layers again

Sharing

Opening and closing the public replay link of a flight.

• POST /v1/flights/{flight_id}/shares Share a flight: open (or return) its public replay link
• DELETE /v1/flights/{flight_id}/shares Stop sharing a flight: its public link is gone at once

Deletions

Reporting a pilot deletion request (GDPR/KVKK erasure); flight data is deleted and a tombstone remains.

• POST /v1/deletions Delete a pilot's flights, or the pilot's data altogether (KVKK)
• GET /v1/deletions/{deletion_id} Progress of a deletion request

Privacy masks

A pilot's home and custom masks, set by the pilot's own app: fixes inside them leave every shared layer.

• GET /v1/privacy-masks The privacy masks of a pilot
• POST /v1/privacy-masks Add a home or custom privacy mask for a pilot
• DELETE /v1/privacy-masks/{mask_id} Remove a privacy mask of a pilot

Replay

Public replay data of a shared flight.

• GET /v1/replay/{public_id} Public replay of a shared flight
• POST /v1/replay/{public_id}/video Ask for the MP4 video of a shared flight
• GET /v1/replay/{public_id}/video/{video_format} State of a video, with a download URL when ready
• GET /v1/replay/{public_id}/video/{video_format}/file Download a video through a signed URL (no API key)

Schemas · Error codes

• Schemas
• Error codes