Skip to content

API Reference

OrbitDeck exposes a FastAPI HTTP API for the web clients and for lightweight integration.

Use this section for the route map and the configuration model summary. Use the built-in Swagger UI at /docs when you need live schema details for a running instance.

For installation and operating workflow, start with Quick Start, First Hour, or Glossary. Use this section for route and model reference.

Main groups

  • health and system state
  • satellites, live tracks, passes, pass-cache refresh, and lite snapshots
  • location, timezone, pass-filter, lite, GPS, radio, and APRS settings
  • frequency guidance, radio control, APRS operation, and dataset refresh
  • technical reference pages for radio control, APRS transport/runtime behavior, frequency guidance, lite snapshot behavior, AMSAT enrichment, and Pi Zero/device gating