Gate API Documentation

Your guide to accessing gate data for aircraft spawning at VATSIM airports.

Introduction

The Gate API allows users to retrieve available gate data at airports to assist with aircraft spawn points. The API is designed to support applications by providing information about suitable gates by airport code (ICAO).

Base URL

The base URL for accessing the Gate API is: 

https://gateapi-ae6bb7ff61e6.herokuapp.com/GateAPI/[ICAO]

Replace [ICAO] with the 4-letter ICAO code of the airport you want to retrieve gate data for.

Example Request

To get gate information for Los Angeles International Airport (KLAX), use:

https://gateapi-ae6bb7ff61e6.herokuapp.com/GateAPI/KLAX

Response Format

The API returns data in JSON format, structured with details about each gate's size and suitability for various aircraft. Here’s an example response: 

        {
            "icao": "KLAX",
                "gates": [
                {
                    "name": "American Airlines Maintenance Apron E06",
                    "maxSize": "C"
                },
                {
                    "name": "American Airlines Maintenance Apron E07",
                    "maxSize": "C"
                },
                {
                    "name": "American Airlines Maintenance Apron E08",
                    "maxSize": "C"
                }
        }

Each gate object includes the gate name and the maxSize it can accommodate.

Parameters

The Gate API only requires one parameter:

Error Handling

If the requested ICAO code is invalid or not found, the API will return a JSON response with an error message:

{
  "error": "Airport not found."
}