API Documentation

This API (v2) is being retired on January 4th, 2026
Migrate to API v3, available via Orwell -> Settings -> API v3

Use the Protocol API to access vAMSYS Data for your Discord Bots, ACARS Trackers and other services.

Getting started

To get started, visit Authentication.

Learn how to authenticate your API requests.

Learn how to consume our API.

Read about the different types of errors returned by the API.

Learn about the Airport model and how to retrieve airports.

Learn about the Aircraft model and how to retrieve Aircraft.

Learn about the METAR model and how to retrieve METAR and TAF.

Learn about the Airline model and how retrieve Airline Info.