# Skyvex Software Pty Ltd

- [Stratos Documentation](https://docs.skyvexsoftware.com/introduction.md): Documentation for Skyvex Stratos — a multi-simulator ACARS client.
- [Getting Started](https://docs.skyvexsoftware.com/guide/getting-started.md): Download Stratos, connect to your virtual airline, and start tracking flights.
- [Uninstalling Stratos](https://docs.skyvexsoftware.com/guide/uninstalling.md): Remove Stratos from Windows, macOS, or Linux — including where your data is stored if you want a completely clean removal.
- [Remote Simulator Setup](https://docs.skyvexsoftware.com/guide/remote-sim-connection.md): Connect Stratos to a flight simulator running on a different PC over your local network.
- [VA Onboarding](https://docs.skyvexsoftware.com/guide/va-onboarding.md): Walk through creating your virtual airline on Skyvex, configuring it for your pilots, and installing the starter plugins so your pilots can fly.
- [OAuth Authentication Setup](https://docs.skyvexsoftware.com/guide/oauth-setup.md): Configure OAuth 2.0 with PKCE and refresh tokens so your pilots can sign in to Stratos with their existing crew system account.
- [Additional Fields](https://docs.skyvexsoftware.com/guide/additionalfields.md): Complete reference for the Additional Fields matrix VAs use to choose which optional fields ride along on position updates and the completion PIREP sent to their own ACARS backend, with the exact wire key, type and unit of every field.
- [Stratos API Modules for phpVMS](https://docs.skyvexsoftware.com/guide/stratos-api/overview.md): Open-source phpVMS 7 modules that expose the Stratos VA API on your crew system — what they are, how they fit together, and what order to install them in.
- [Stratos Core API](https://docs.skyvexsoftware.com/guide/stratos-api/core.md): Install the Stratos Core API module on your phpVMS 7 install — the required base for every Stratos integration.
- [Stratos Logbook API](https://docs.skyvexsoftware.com/guide/stratos-api/logbook.md): Install the Stratos Logbook API module on your phpVMS 7 install — adds the pilot flight history endpoints (list, detail, stats) the Stratos client uses for the in-app logbook.
- [Flight Phases & Transitions](https://docs.skyvexsoftware.com/guide/flight-phases.md): How Stratos detects what stage a flight is in — boarding, climb, cruise, landing and everything between — and the exact conditions that move a flight from one phase to the next. For pilots and VA administrators.
- [Pauses & Sim Disconnects](https://docs.skyvexsoftware.com/guide/pauses-and-disconnects.md): What Stratos does when the simulator goes quiet mid-flight — when it bridges the gap silently, when it stops and waits for you, and how to get tracking moving again.
- [Diversions & Tech Stops](https://docs.skyvexsoftware.com/guide/diversions.md): What happens in Stratos when you land somewhere other than the planned arrival airport — how tracking behaves, how the flight is submitted, what your VA receives, and what to do when you divert.
- [Landing Rate Detection](https://docs.skyvexsoftware.com/guide/landing-rates.md): How Stratos measures landing rates accurately, how it differs from other trackers, and how to interpret the numbers — for pilots and VA administrators.
- [Landing Score & Fuel Efficiency](https://docs.skyvexsoftware.com/guide/landing-score.md): How the Landing Analyser turns a touchdown into a score — the six categories, their bands, how the composite is weighted, and a full explanation of the Fuel Efficiency category and the numbers shown on its card.
- [Stratos VA API](https://docs.skyvexsoftware.com/api-reference/introduction.md): The HTTP contract every Stratos desktop client speaks to your virtual airline's crew system. Framework-agnostic — implement it in any language or stack.
- [Handshake — version and discovery](https://docs.skyvexsoftware.com/api-reference/handshake-—-version-and-discovery.md): Returns the implementing module's version, the handler name (always `Stratos`), and a link back to this documentation.
- [Credentials login](https://docs.skyvexsoftware.com/api-reference/pilot/credentials-login.md): Exchange a pilot's username (pilot ID or email) and password for an API key. Returns the full pilot session including the `token` field that the client uses on every subsequent request as a Bearer token.
- [Verify token and return profile](https://docs.skyvexsoftware.com/api-reference/pilot/verify-token-and-return-profile.md): Validates the Bearer token and returns the pilot's profile. Use this on app launch to confirm the stored token is still valid and refresh cached profile fields. The response shape matches `POST /pilot/login` minus the `token` field.
- [Pilot career statistics](https://docs.skyvexsoftware.com/api-reference/pilot/pilot-career-statistics.md): Aggregate stats for the authenticated pilot. The client uses these to render the pilot dashboard.
- [Fleet list](https://docs.skyvexsoftware.com/api-reference/reference-data/fleet-list.md): Every aircraft visible to pilots, including passenger and cargo capacity and the minimum rank required to fly each one. The client uses `id` to associate bids and flights with a specific airframe.
- [Airport directory](https://docs.skyvexsoftware.com/api-reference/reference-data/airport-directory.md): Every airport known to your VA. The client uses this to render airport pickers and to look up coordinates for map rendering when an airport is referenced by ICAO.
- [VA announcements feed](https://docs.skyvexsoftware.com/api-reference/reference-data/va-announcements-feed.md): Up to the 10 most recent news items for the VA. Rendered on the pilot dashboard. The phpVMS reference implementation strips HTML tags from the body and truncates to 200 characters for the `subtitle`.
- [Pilot's current bids](https://docs.skyvexsoftware.com/api-reference/flights/pilots-current-bids.md): Every flight the authenticated pilot has currently bid on (and not yet flown or unbid). The Stratos client renders this as the **My Bookings** list. If the `pilots.only_flights_from_current` VA setting is enabled, bookings whose departure airport is not the pilot's current location are filtered out…
- [Aircraft a pilot may switch to for a bid](https://docs.skyvexsoftware.com/api-reference/flights/aircraft-a-pilot-may-switch-to-for-a-bid.md): Aircraft eligible for this bid's flight, narrowed server-side by the VA's rank / typerating / location / booking rules (the reference module reuses `FlightService::filterSubfleets`). The Stratos client renders this as a dropdown on the booking card when the `allow_aircraft_changes` airline setting i…
- [Change a bid's aircraft](https://docs.skyvexsoftware.com/api-reference/flights/change-a-bids-aircraft.md): Assigns a different aircraft to a bid before the flight is started. Persists the bid's aircraft so `/flights/start` uses it. The chosen aircraft must be one returned by `GET /flights/bookings/{bid}/aircraft`. Rejected when the authenticated pilot has their own SimBrief OFP for the flight, once a PIR…
- [Search the schedule](https://docs.skyvexsoftware.com/api-reference/flights/search-the-schedule.md): Search the VA's published schedule. Every filter is optional — an empty query returns up to `limit` flights. Filters are AND-combined.
- [Begin tracking a booked flight](https://docs.skyvexsoftware.com/api-reference/flights/begin-tracking-a-booked-flight.md): Prefiles a PIREP for the chosen bid and returns a `tracking_id` (the new PIREP's UUID) that subsequent `/flights/update` and `/flights/complete` calls reference.
- [Position and phase update](https://docs.skyvexsoftware.com/api-reference/flights/position-and-phase-update.md): Sent by the desktop client at the pilot's chosen position-update interval (currently 15, 30, or 60 seconds) while a flight is active. Each call appends a FLIGHT_PATH point to the PIREP and updates the PIREP's status based on the reported `phase`.
- [File the PIREP](https://docs.skyvexsoftware.com/api-reference/flights/file-the-pirep.md): Closes out the flight. The server:
- [Cancel an active flight](https://docs.skyvexsoftware.com/api-reference/flights/cancel-an-active-flight.md): Cancels the in-progress PIREP and discards its FLIGHT_PATH rows. Send the `uuid` of the PIREP to cancel, or send an empty body to cancel the authenticated pilot's most recent in-progress PIREP.
- [Cancel a bid](https://docs.skyvexsoftware.com/api-reference/flights/cancel-a-bid.md): Removes a bid the pilot no longer wants to fly. This is **not** the same as cancelling an in-progress flight — `unbook` only affects scheduled bids that haven't been started.
- [Plugin SDK](https://docs.skyvexsoftware.com/sdk/overview.md): Build plugins for Stratos using the @skyvexsoftware/stratos-sdk package.
- [Getting Started](https://docs.skyvexsoftware.com/sdk/getting-started.md): Create your first Stratos plugin in 5 minutes.
- [Architecture](https://docs.skyvexsoftware.com/sdk/architecture.md): How plugins integrate with the Stratos shell.
- [Developer Mode](https://docs.skyvexsoftware.com/sdk/developer-mode.md): Run Stratos with the developer window enabled — login, airline switcher, dev tools tabs, and a debug footer for live introspection.
- [Plugin Manifest](https://docs.skyvexsoftware.com/sdk/manifest.md): Complete reference for plugin.json fields.
- [Plugin Settings](https://docs.skyvexsoftware.com/sdk/settings.md): Declare and read configuration settings for your plugin.
- [UI Module](https://docs.skyvexsoftware.com/sdk/ui-module.md): Building your plugin's user interface.
- [Sub-Page Routing](https://docs.skyvexsoftware.com/sdk/routing.md): Add multiple pages to your plugin with client-side routing.
- [Components](https://docs.skyvexsoftware.com/sdk/ui-components.md): Pre-built UI components from the Stratos SDK.
- [Hooks Overview](https://docs.skyvexsoftware.com/sdk/hooks/overview.md): All React hooks available in the Stratos Plugin SDK.
- [usePluginContext](https://docs.skyvexsoftware.com/sdk/hooks/use-plugin-context.md): Access the plugin UI context.
- [useSimData & Socket Hooks](https://docs.skyvexsoftware.com/sdk/hooks/use-sim-data.md): Real-time simulator data and socket event hooks.
- [useFlightPhase](https://docs.skyvexsoftware.com/sdk/hooks/use-flight-phase.md): Track the current flight phase in real-time.
- [useFlightEvents](https://docs.skyvexsoftware.com/sdk/hooks/use-flight-events.md): Access flight events and manage comments.
- [useFlightManager](https://docs.skyvexsoftware.com/sdk/hooks/use-flight-manager.md): Manage the full flight lifecycle.
- [useTrackingSession](https://docs.skyvexsoftware.com/sdk/hooks/use-tracking-session.md): High-level flight tracking state and controls.
- [useLandingAnalysis](https://docs.skyvexsoftware.com/sdk/hooks/use-landing-analysis.md): Access landing analysis data in real-time.
- [useShellAuth](https://docs.skyvexsoftware.com/sdk/hooks/use-shell-auth.md): Access VA authentication state from the shell.
- [useVaApi](https://docs.skyvexsoftware.com/sdk/hooks/use-va-api.md): Singleton axios instance for the bound airline's API with auto-refresh on 401.
- [Shell Utility Hooks](https://docs.skyvexsoftware.com/sdk/hooks/use-shell-hooks.md): Navigation, toasts, config, and logging hooks.
- [Background Module](https://docs.skyvexsoftware.com/sdk/background/overview.md): Running code in the Electron main process.
- [Plugin Context](https://docs.skyvexsoftware.com/sdk/background/context/overview.md): The ctx object passed to a background module's onStart and onStop — every accessor at a glance.
- [ctx.logger](https://docs.skyvexsoftware.com/sdk/background/context/logger.md): Scoped logging from a background module.
- [ctx.config](https://docs.skyvexsoftware.com/sdk/background/context/config.md): Persistent per-plugin key-value storage from a background module.
- [ctx.ipc](https://docs.skyvexsoftware.com/sdk/background/context/ipc.md): IPC handlers and renderer messaging from a background module.
- [ctx.auth](https://docs.skyvexsoftware.com/sdk/background/context/auth.md): Read-only authentication state from a background module.
- [ctx.airline](https://docs.skyvexsoftware.com/sdk/background/context/airline.md): The bound airline and a refresh-aware HTTP client, from a background module.
- [ctx.database](https://docs.skyvexsoftware.com/sdk/background/context/database.md): Per-plugin SQLite storage from a background module.
- [ctx.server](https://docs.skyvexsoftware.com/sdk/background/context/server.md): Mounting Express routes on the shell's local HTTP server from a background module.
- [ctx.flight](https://docs.skyvexsoftware.com/sdk/background/context/flight.md): Live flight state, subscriptions, the flight log, start guards, and PIREP attachments, from a background module.
- [ctx.notify](https://docs.skyvexsoftware.com/sdk/background/context/notify.md): Fire-and-forget toasts and sounds from a background module.
- [ctx.dialog](https://docs.skyvexsoftware.com/sdk/background/context/dialog.md): Blocking acknowledgement and confirmation dialogs that return the pilot's response, from a background module.
- [ctx.prompt](https://docs.skyvexsoftware.com/sdk/background/context/prompt.md): Blocking prompts that ask the pilot for a text, number, or selected value, from a background module.
- [ctx.plugin](https://docs.skyvexsoftware.com/sdk/background/context/plugin.md): Control this plugin's own presence in the shell — currently the sidebar indicator.
- [Background ↔ UI Communication](https://docs.skyvexsoftware.com/sdk/background/communication.md): Connecting a background module and a UI module with Express routes, TanStack Query, and IPC push.
- [PIREP File Attachments](https://docs.skyvexsoftware.com/sdk/pirep-file-attachments.md): What changes on the wire when a plugin attaches a file to its PIREP submission with attachFile(), and what an airline's backend needs to do about it.
- [Build & Deploy](https://docs.skyvexsoftware.com/sdk/build-and-deploy.md): Build, bundle, and distribute your plugin.
- [Best Practices](https://docs.skyvexsoftware.com/sdk/best-practices.md): Patterns, pitfalls, and tips for plugin development.
- [Type Reference](https://docs.skyvexsoftware.com/sdk/type-reference.md): Every public type exported by the Stratos SDK, in alphabetical order.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [Skyvex Software](https://skyvexsoftware.com)
- [Download (v2.20.0)](https://skyvexsoftware.com/download)
- [Stratos SDK (v0.20.0)](https://www.npmjs.com/package/@skyvexsoftware/stratos-sdk)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.