# Introduction The aviowiki REST API gives access to all static and dynamic data stored in our database. The base path of all endpoints is `https://api.aviowiki.com`.\ TLS (HTTPS) is required to access all resources. Throughout the documentation, we will give examples of requests using [cURL](https://curl.haxx.se/). ### Quick Start To get you started, we’ll try a super easy search function using one of our *Free Endpoints*. This code will retrieve a list of airports that match the search query “Los Angeles”. ```bash curl -X GET \ "https://api.aviowiki.com/free/airports/search?query=London" ``` {% content-ref url="/pages/-MSI4r5osHHe0E79TPWr" %} [Limitations](/free-endpoints/limitations) {% endcontent-ref %} ### Testing environment aviowiki offers a testing environment that can be accessed by customers and prospect customers to test their integration, including contribution to aviowiki, without affecting Production data. Our Test environment also has a [frontend](https://testapp.aviowiki.com) associated, which can be used to visually check the data transacted on the API. The base path for the Test environment is `https://testapi.aviowiki.com`. Access to this environment is free of charge. To request access please[ send us an email](mailto:support@aviowiki.com?subject=Test%20environment%20access%20request\&body=Good%20day%2C%0AI%20would%20like%20to%20request%20access%20to%20your%20Test%20environment.%0AI%20would%20like%20to%20use%20aviowiki%20to%20%5Badd%20your%20use%20case%5D.%0A%0ABest%20regards%2C%0A). {% hint style="danger" %} Data in the Test environment is not intended for use in any production environment. Data in this environment is not verified by our Data team and can be incorrect, and incomplete. {% endhint %} {% hint style="warning" %} Data in the Test environment is not a reflection of the data available in our Production environment. For any qualitative or quantitative assessment of the data available in production, please [send us an email](mailto:support@aviowiki.com?subject=Data%20quality%20assessment\&body=Good%20day%2C%0AI%20would%20like%20to%20receive%20more%20details%20about%20the%20quality%20and%20coverage%20of%20your%20data.%0AI%20would%20like%20to%20use%20aviowiki%20to%20%5Badd%20your%20use%20case%5D.%0A%0ABest%20regards%2C%0A). {% endhint %} # Authentication In order to access Authenticated endpoints and to bypass the limitations of the rate-limiting imposed on Free Endpoints, calls need to be authenticated using an [API Token](/authentication/api-tokens). Before an [API Token](/authentication/api-tokens) can be issued, a [User](/authentication/users) needs to be created, either via the web frontend, or via the API. Authentication is obtained by passing the [API Token](/authentication/api-tokens) as `authorization` Header with type `Bearer`. ``` curl --request GET \ --url 'https://testapi.aviowiki.com/airports/search?query=London' \ --header 'Authorization: Bearer 8320d910-ec23-46ea-beda-a9015ea05871' ``` {% hint style="info" %} Whenever in this documentation we demonstrate API calls using cURL that require authentication, we will use randomly generated API Tokens that do not correspond to any user in our system and will return an error `403` if used against our system. {% endhint %} # Users aviowiki has an internal User management system that performs the functions of Authentication and Authorisation, as well as other administrative functions. [API Tokens](/authentication/api-tokens) are issued for and assigned to a specific User, and follow the same [Authorisation](/authentication/authorisation) rules as the User who owns them. Users are identified internally by their User [AID](/conventions/aviowiki-ids), with namespace `USR`. For example `USR-AA11-22BB`. When creating an account, users are required to provide a `login` and `password` . `login` should be in the form of an email address. `password` doesn't have any specific level of complexity required, however we **strongly** encourage people to be responsible with their passwords.\ If you need to have a memorable password (one you can remember without the help of a [Password Manager](https://en.wikipedia.org/wiki/Password_manager), consider using a [passphrase](https://en.wikipedia.org/wiki/Passphrase) which is [easy to remember, but difficult to guess](https://xkcd.com/936/).\ However the cases in which you really need to use a memorable password are nowadays quite limited. We always recommend to use a [Password Manager](https://en.wikipedia.org/wiki/Password_manager) where possible. ### User object When retrieving information about a user from the API, you will receive a user object which follows the structure shown below: ``` { "aid": "USR-AA11-22BB", "name": "Demo User", "login": "demo@example.com", "password": null, "roles": [ "USER" ], "reward": 0 } ``` `aid` indicates the [AID](/conventions/aviowiki-ids) of the user. `name` is a plaintext name that the user chose at the time of sign-up. `login` the login credential to authenticate the user. `password` is always returned `null` in all responses. `roles` is a list of [Authorisation roles](/authentication/authorisation) assigned to the user. `reward` is the total count of [reward points](/reward-points) collected by the user. For more user actions see: {% content-ref url="/pages/-MSKFx3qkk6\_W0IW3VzG" %} [Broken mention](broken://pages/-MSKFx3qkk6_W0IW3VzG) {% endcontent-ref %} # API Tokens API Tokens are strings that allow to authenticate API calls. ### Format They are issued and used in the form of UUID represented in [canonical format](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format), for example `123e4567-e89b-12d3-a456-426614174000`. ### Usage API Tokens should be used with bearer authentication. They need to be passed with the request as `authorization` Header with type `Bearer`. For example: ```bash curl --request GET \ --url 'https://testapi.aviowiki.com/airports/search?query=London' \ --header 'Authorization: Bearer 123e4567-e89b-12d3-a456-426614174000' ``` ### API Token types There are two types of API Tokens, `API` or `API_FREE`. `API_FREE` tokens allow access only to [Free Endpoints](/free-endpoints/limitations), without rate limitations. \ Such Tokens can be issued autonomously by every user as they do not require any contractual agreement in place, other than accepting the regular [Terms and Conditions](https://www.aviowiki.com/terms/). `API` tokens allow access to all endpoints.\ At the moment, these Tokens can only be issued by an aviowiki administrator, and an agreement need to be signed between the User and aviowiki. Please [get in touch](mailto:hello@aviowiki.com) if you require an `API` token. # Authorisation 1. General 2. List of roles and their uses 3. how to request a change in role All [API Tokens](/authentication/api-tokens) are associated with a [User](/authentication/users) and follow the same authorisation limitations as the associated User. Authorisation roles available to a specific user are listed in the `roles` property of the [User](/authentication/users) object. Newly created users always have role `USER` associated. Some functionalities of our API require additional levels of authorisation. For example, to retrieve the position of an aircraft. ### Available Roles | Role Name | Access allowed | | ------------------- | ------------------------------------------------------------------------------------------------ | | `USER` | All basic functionalities, except for functionalities that require a specific role listed below. | | `AIRCRAFT_POSITION` | Allows access to endpoints in the `/aircraft` namespace. | | `ADMIN` | aviowiki administrators. | # Conventions # Data format All data exchanged with the aviowiki API, both as part of a request’s body or of a reply’s body, are formatted using [JSON](https://www.json.org/json-en.html). You can find full details on individual objects in the Data Models section. ### Units of measure Aviowiki mostly uses the [International System of Units](https://en.wikipedia.org/wiki/International_System_of_Units) for data served via the API. The main deviation from this is the use of Celsius Degrees in place of Kelvin, for temperatures. This minor variation reflects the more operational use of our data, as compared to the scientific focus of the ISU. As a general overview, these are the units of measurement used for different use cases: | Measure | Unit | | ---------------- | --------------- | | Length | Metres | | Mass | Kilos | | Temperature | Celsius degrees | | Coordinates | Decimal degrees | | Horizontal Speed | Metres/Second | | Vertical Speed | Metres/Second | For full details about the format of each field, refer to the definition in the relevant data model. # aviowiki IDs Every object represented in our database, which is individually addressable, is assigned a unique identifier that we call **AID**, or **aviowiki ID**. ![Composition of the AIDs](/files/-MSOVVm9qM9SmZVpOqig) AIDs are formed of two parts: the namespace (A) and the identifier (B). The **namespace** is a way to quickly determine what type of object an AID refers to. For example, AIDs starting with `APT` refer to an airport, while those starting with `RWY` refer to a runway. A list of the namespaces used can be found [at the bottom of this page](#undefined). The **identifier** is a unique combination of eight letters or numbers, all capital (in Regular Expression:`[0-9A-Z]`). Every namespace, therefore, allows a total amount of 2,821,109,907,456 addressable objects. To avoid confusion and improve readability we follow these rules when displaying AIDs: * Always use block capital letters * Use a font type that makes easy distinctions between similar characters, like the number zero and the letter O * Separate the namespace portion from the identifier with a dash * Break down the identifier portion with a dash after 4 characters ### List of namespaces used | Namespace | Object | | --------- | --------------------------------------------------------------------------- | | USR | [User](/authentication/users) | | APT | [Airport](/data-models/airport) | | RWY | [Runway](/data-models/runway) | | ACF | Aircraft | | PRV | [Provider](/data-models/provider) | | RGN | [Region](/data-models/region) | | ONA | [Airport Operational Note](/data-models/operational-note/operational-notes) | | ONC | Country Operational Note | | ONR | Region Operational Note | | PVP | Provider Product | | FPR | Fuel Product | | FCO | Fuel Cost | | FIL | File Reference | | RAU | Region Authority | | RAC | Region Authority Contact | | AAU | [Airport Authority](/data-models/authority#airport-authority) | | AAC | Airport Authority Contact | | CAU | [Country Authority](/data-models/authority#country-authority) | | CAC | Country Authority Contact | # Pagination Many endpoints in aviowiki return a large list of results. To facilitate navigation through these, as well as providing a mechanism for lazy loading, such endpoints return a Paged List. Paged Lists divide the results into pages. Each page has a `number`, which is its index starting from `0`, and a certain `size`, which is the number of results in that page. To simplify calculations and evaluation of Paged Lists, the `totalPages` and `totalResults` properties are also provided. Respectively they indicate how many pages in total exist and how many results are available. It is worth noting that the `number` of the last page is always equal to `totalPage - 1`. This is because `number` starts counting from `0`. The list of results in a Paged List is contained in the property `content`. ### Example ``` { "page": { "number": 0, "size": 10, "totalPages": 3, "totalResults": 26 }, "content": [...] } ``` # Errors {% hint style="warning" %} This page is under construction. Please consult the [legacy documentation](https://www.aviowiki.com/docs/airports/data-models/error/) on our website. {% endhint %} # Reward Points For every contribution that users send to aviowiki, users are awarded a certain amount of Reward Points. One point is accrued for every field that is verified and accepted by our Data Team. Users can check their accrued Reward Points on the web app by going to the [Menu > User Profile > General](https://app.aviowiki.com/user). # Introduction At aviowiki we believe that certain public institutions should provide openly accessible aviation data free of charge. They are not doing it. This is our way to give back to the Industry. Our Open Data contains basic but necessary information about all airports in our database. It is the most complete professional aviation database that you can find on the internet. ### Open Data is free You don't need to pay anything to access our Open Data. ### Open Data is easy You can retrieve our Open Data via the API using a [free API token](https://app.aviowiki.com/user/tokens), or by making unauthenticated API calls. Check all details in the [Free Endpoints](/free-endpoints/limitations) section of this documentation. We also offer a convenient download of the full Open Data set. This is updated every 24 hours and it is a mere 8MB. You can download this set from Or in a command line, type: ```bash curl -O https://exports.aviowiki.com/free_airports.json.zip ``` ### How can I use it Open Data is licensed under the Creative Common License with Attribution 4.0 International (CC BY 4.0). Full terms of the license can be accessed at # Definition The following properties are defined as "*Open Data*" regardless of how they are retrieved. For example, if you are a customer paying for our premium data, using the following properties will fall under the license of Open Data.
PropertyTypeDescription
PropertyTypeDescription
aidstringA string with the AID of the airport, with APT as namespace
icaostring, nullA string with the 4-letters ICAO code of the airport, ornull if none is assigned
iatastring, nullA string with the 3-letters IATA code of the airport, or null if none is assigned.
faastring, nullA string with the FAA code, or null if none is assigned.
coordinatesobject, nullA Coordinates object which represents the location of the Aerodrome Reference Point.
This is null when the information is not known.
countryobject, nullA Country object which represents the country at which an airport is located.
null if this is not known.
timeZonestring, nullThe timezone of the airfield as noted in the IANA Time Zone Database.
null indicates that this information is not available.
namestring, nullThe name of the airport. This should be the official name of the airport written in Latin characters.
servedCitystring, nullA string containing the name of the city served by the airport. In some countries, like the USA, this includes the state. For example: Los Angeles, CA.
This is null when the information is not known.
# Airport Airports are root objects, meaning it does not have a parent object. AIDs identifying airports have `APT` as their namespace. An airport identifies a landing site, regardless of its form, usage or amount of traffic. For example, a heliport next to a hospital will be modelled by an Airport object. Separate landing surfaces within the same establishment, for example, different runways or helipads within the same airport, are identified as [Runways](/data-models/runway), not as separate Airports. Below is a description of all properties of the Airport object: | **Property** | **Type** | **Description** | | ------------------------------------------------------------------------------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | string | A string with the AID of the airport, with `APT` as namespace | | `icao` | string, `null` | A string with the 4-letters ICAO code of the airport, or`null` if none is assigned | | `iata` | string, `null` | A string with the 3-letters IATA code of the airport, or `null` if none is assigned. | |

faa
⚠️Being deprecated

| string, `null` | A string with the FAA code, or `null` if none is assigned. | | `localIdentifier` | string, `null` |

An identifier issued by the local authority, which is not recognised as an official ICAO or IATA code.
The name of the code for each country can be found in Country.localIdentifierName

| | `coordinates` | object, `null` |

A Coordinates object which represents the location of the Aerodrome Reference Point.
This is null when the information is not known.

| | `elevation` | number, `null` |

A decimal number representing the elevation of the airport expressed in meters. Two decimal positions are provided, for precise conversion to feet.

This is null when the information is not known.

| | `variation` | number, `null` |

A decimal number representing the magnetic variation at the airport. This is expressed in degrees, with two decimal positions. Positive for East variation and Negative for West variation.
This is null when the information is not known.

| | `country` | object | A [Country](/data-models/country) object which represents the country at which an airport is located. | | `timeZone` | string, `null` |

The time-zone of the airfield as noted in the IANA Time Zone Database.
null indicates that this information is not available.

| | `name` | string | The name of the airport. This should be the official name of the airport written in Latin characters. | | `servedCity` | string, `null` |

A string containing the name of the city served by the airport.


This is null when the information is not known.

| | `servedCityGoverningDistrict` | string, `null` |

A Governing District object indicating the Governing District of the servedCity.

This is null when the information is not known.

| | `administrativeCity` | string, `null` |

A String containing the name of the city where the airport is situated (not the major city that it serves, as in servedCity)

This is null when the information is not known.

| | `administrativeCityGoverningDistrict` | string, `null` |

A Governing Distric object indicating the Governing District of the administrativeCity.

This is null when the information is not known.

| | `type` | string, `null` |

A string that describes the type of airport. Possible values are:

null indicates that the information is not known.

| | `operator` | string, `null` |

A string that identifies the type of operator that runs the airport. Possible values are:

null indicates that the information is not known.

| | `accessibleFor` | list, `null` |

A list of strings that identifies what type of traffic has access to the airport.

This is null when the information is not known.

Each element of the list is a string of possible value:

| | `ifr` | boolean, `null` |

Indicates if the airport is capable and authorised to accept flights operating under Instrument Flight Rules.

true if IFR flights are accepted, false otherwise.

null if the information is not known.

| | `mandatoryHandling` | boolean, `null` |

Indicates if local regulations mandate that visiting aircraft utilise a ground handling company.

true if the use of a ground handling company is mandated, false otherwise.

null if the information is not known.

| | `mandatoryQualification` | boolean, `null` |

Indicates if local regulations mandate that pilots are qualified before operating at the airport.

true if pilots require a qualification, false otherwise.

null if the information is not known.

When this property is true, the properties qualificationLink and qualificationNotes may contain additional information.

| | `qualificationLink` | string, `null` |

A URL that points to a page explaining the process for pilots to obtain the qualification required to operate at the airport.

null indicate that this information was not added.

| | `qualificationNotes` | string, `null` |

Free-text notes about the mandatory qualification that must be obtained before operating at the airport.

null if this information was not added.

| | `nonScheduledPermission` | string, `null` |

Indicates what kind of permission is required for non-scheduled flights (of either a private or commercial nature) to operate on the airport.
Possible values are:

null indicates that this information is not available.

If this property is not null additional information may be available in the nonScheduledPermissionNotes property.

| | `nonScheduledPermissionNotes` | string, `null` | Free text with an explanation of the permission that needs to be obtained by non-scheduled flights to operate. | | `paxLimit` | number, `null` |

The maximum number of passengers seats allowed for each aircraft operating at the airfield.

When this is set to 999 there are no restrictions imposed.

null indicates that the information is not known.

| | `weightLimit` | number, `null` |

The highest MTOM (Maximum Take-off Mass, or Weight) allowed for an aircraft operating at the airfield.
Values are expressed in Kilos.

When this is set to 9999999 there are no restrictions imposed.

null indicates that the information is not known.

| | `wingspanLimit` | number, `null` |

The largest wingspan allowed for an aircraft operating at the field.
Values are expressed in meters.

When this is set to 999 there are no restrictions imposed.

null indicates that the information is not known.

| | `referenceWeatherStation` | string, `null` |

If an airfield is known to not publish weather reports, or if the weather reports are not published 24h a day, the identifier of a different location can be specified here to indicate which nearby station best describes the weather conditions at the airfield.

The value of this field is the AID of a nearby airport that is known to issue weather reports 24h a day.

null indicates that this information was not added.

| # Authority Authorities represent institutions that have some sort of power on an [Airport](/data-models/airport), [Country](/data-models/country) or [Region](/data-models/region). These could be, for example, the Airport Operator, or a Country's [Civil Aviation Authority](https://en.wikipedia.org/wiki/National_aviation_authority). Depending on whether an Authority depends on an Airport, Country or Region, different values are available for some of its properties. ### Common properties | Property | Type | Description | | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name | string | A free-text name for this Authority | | type | string |

The type of Authority, based on its parent entity.

| ### Airport Authority Airport Authorities represent Authorities that have jurisdiction over an Airport. In addition to the Common Properties, they have the following properties and possible values | Property | Type | Description | | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | String | The [AID](/conventions/aviowiki-ids) with namespace `AAU` | | `type` | String |

The type of authority represented.
Possible values are:

| | `landsideArea` | List |

A list of Coordinates that identify the landside area where the Authority is located, for example their offices.

Defaults to null if the information is not known.

| | `airsideArea` | List |

A list of Coordinates that identify the airside area where the Authority is located, for example a dedicated ramp space for customs clearance.

Defaults to null if the information is not know

| | `parent` | String | An [Airport](/data-models/airport) AID for the parent Airport. | | `customsDetails` | Object |

This additional property is present for Airport Authorities of type CUSTOMS, which are discussed further in Customs Airport Authority.

Defaults to null if the information is not know

| ### Customs Airport Authority These are [Airport Authorities](/data-models/authority#airport-authority) of `type` `CUSTOMS`, for which some additional properties are specified. The additional properties are useful to programmatically assess the feasibility of entry into a country at a specific Airport, based on the flight routing, persons' nationality and Visa types. These properties are found in the `customsDetails` object of an [Airport Authority](/data-models/authority#airport-authority). {% hint style="warning" %} In most countries, the eligibility of a person to enter the country depends on the assessment of the Border Officer that processes the entry. Information in our database are purely for reference purpose, and Aircraft Operators, Crew Members and Passengers should assess their individual status before attempting to enter a country. {% endhint %} | Property | Type | Description | | ------------------------------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowFlightsFromCountries` | list, `null` | A list of [Countries](/data-models/country) from which flights are allowed to be cleared by Customs. | | `allowFlightsFromRegions` | list, `null` | A list of [Regions](/data-models/region) from which flights are allowed to be cleared by Customs. | | `allowCrewFromCountries` | list, `null` | A list of [Countries](/data-models/country) from which crew members are allowed to be cleared by Customs. | | `allowCrewFromRegions` | list, `null` | A list of [Regions](/data-models/region) from which crew members are allowed to be cleared by Customs. | | `allowPassengersFromCountries` | list, `null` | A list of [Countries](/data-models/country) from which passengers are allowed to be cleared by Customs. | | `allowPassengersFromRegions` | list, `null` | A list of [Regions](/data-models/region) from which passengers are allowed to be cleared by Customs. | | `services` | list, `null` |

A list of services provided by the Customs Authority at this Airport. Possible values are:

| | `visaProcessed` | list, `null` |

A list of visa types that can be processed at this location. Possible values are:

| ### Country Authority These are Authorities that have jurisdiction over an entire [Country](/data-models/country). Below are additional properties to the [common properties](/data-models/authority#common-properties) already described above. | Property | Type | Description | | -------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | string | The [AID](/conventions/aviowiki-ids) in namespace `CAU`. | | `type` | string |

The type of Country Authority being described. Possible values are:

| | `parent` | object | A [Country](/data-models/country) object for the parent Country. | ### Region Authority These are Authorities that have jurisdiction over an entire [Region](/data-models/region). Below are additional properties to the [common properties](/data-models/authority#common-properties) already described above. | Property | Type | Description | | -------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | string | The [AID](/conventions/aviowiki-ids) in namespace `RAU`. | | `type` | string |

The type of Country Authority being described. Possible values are:

| | `parent` | object | A [Region](/data-models/region) object for the parent Region. | # Availability ## Availability The Availability model provides information about the availability of the Location for aircraft movements, Aerodrome Rescue and Fire Fighting service, Aerodrome Air Traffic Services and Customs and Immigration facilities. In the aviowiki API the following naming is used to identify these separate services: * `movement` for the availability of the location for take-off and landing without any further guarantee of service * `arff` for Aerodrome Rescue and Fire Fighting services * `atc` for Air Traffic Services * `ciq` for Customs, Immigration and Quarantine facilities ### Example A query for the availability of a Location will return the following JSON data: ``` { "openingIndicator": "SEE_TIMES", "arff": [ { "validFrom": "2021-05-17T00:00:00", "validTo": "2021-05-17T23:59:59.999999999", "status": "FULL", "info": { "icaoCatAirplane": "VIII", "faaCatAirplane": null, "faa139Certified": null, "catHelicopters": null, "waterQuantity": null, "complementaryQuantity": null, "arffVehicles": null, "dischargeCapacity": null, "extensionAvailable": null, "extensionNotice": null, "extensionUpToIcao": null, "firestationRemote": null, "firestationNotes": null } } ], "atc": [ { "validFrom": "2021-05-17T00:00:00", "validTo": "2021-05-17T23:59:59.999999999", "status": "FULL", "info": { "enRtfAvailable": true, "afisOnly": false } } ], "ciq": [ { "validFrom": "2021-05-17T00:00:00", "validTo": "2021-05-17T23:59:59.999999999", "status": "FULL" } ], "movement": [ { "validFrom": "2021-05-17T00:00:00", "validTo": "2021-05-17T06:00:59.999999999", "status": "CLOSED" }, { "validFrom": "2021-05-17T06:01:00", "validTo": "2021-05-17T23:30:59.999999999", "status": "FULL" }, { "validFrom": "2021-05-17T23:31:00", "validTo": "2021-05-17T23:59:59.999999999", "status": "LIMITED", "notes": null, "openFor": [ { "flightTypes": [ { "rules": [], "filing": [], "airframe": [], "status": [ "HUMANITARIAN", "FIREFIGHTING", "STATE", "HOSPITAL", "MEDEVAC", "SAR" ], "purpose": [], "direction": null } ], "priorNoticeRequired": 0, "costsInvolved": false, "other": null }, { "flightTypes": [], "priorNoticeRequired": 0, "costsInvolved": false, "other": "Available for emergency diversion" } ] } ] } ``` Each of `movement`, `arff`, `atc`, and `ciq` have a `blocks` property which is a list of time-referenced blocks that contain information on the availability of the individual service. ### Time reference The API allows selecting if times returned are with reference to UTC or to Local Time. By default, all times for the Availability Blocks are with reference to the Local Time of the airport being queried. When Availability times are entered in the aviowiki database, not all times are absolute, as some availability models depend on sunrise and sunset times. Whenever Availability Blocks are returned via the API, all such cases are resolved and times are always provided in an exact form, taking into account sunrise and sunset times where applicable. ### Availability `blocks` Different services require different properties to express their availability, however, all Availability Blocks have these properties in common: * `validFrom` is an ISO formatted date-time string that indicates when the block starts * `validTo` is an ISO formatted date-time string that indicates when the block ends * `status` is an enumeration that describes the current status of the facility. This can be * `FULL` to indicate that the facility is fully available as described by the object, * `LIMITED` to indicate that the facility is available under certain conditions that cannot be described by the model, or * `CLOSED` to indicate that the facility is not available. ### `movement` Availability Movement Availability indicates the availability for an aircraft to physically land or take-off at a location, with no guarantee of any other service being rendered. In addition to the common Availability Block properties, Movement Availability Blocks with `status` of `LIMITED` also include the following properties: * `openFor` a list of machine-readable conditions when Movement Availability can be considered equivalent to `FULL` . * `notes` a string that describes any additional limitation to those listed in `openFor` and that can be `null` if none additional exists. #### Modelling of `LIMITED` blocks in Movement Availability The `openFor` property is a list of conditions that describe for who, and under what conditions an [Airport](/data-models/airport) could be available. Each exception is described in the `flightType` object and has some additional conditions associated, to explain how access to the airport is possible. Below a simplified structure of a Movement Availability block with `LIMITED` status: ``` { "movement": [ { "validFrom": "2021-05-17T23:31:00", "validTo": "2021-05-17T23:59:59.999999999", "status": "LIMITED", "notes": null, "openFor": [ { "flightTypes": [ { "rules": [], "filing": [], "airframe": [], "status": [], "purpose": [], "direction": null } ], "priorNoticeRequired": 0, "costsInvolved": false, "other": null } ] } ] } ``` The properties that define a flight object, under `flightTypes` are: | Property | Type | Description | | ----------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `rules` | List |

The flight rules under which the flight operates. Possible options are:

An empty list indicates that there are no specific status requirements for flights. I.e. any flight, regardless of the rules it operates under, can operate

| | `filing` | List |

The type of flight. Possible options are:

An empty list means that there are not specific requirements for this field. I.e. any flight, regardless of the type of flightplan, can operate

| | `airframe` | List |

The category of aircraft being used. Possible options are:

An empty list indicates that there are no specific status requirements for flights. I.e. any flight, regardless of airframe type, can operate

| | `status` | List |

Any special status as defined in ICAO Doc 4444, and mentioned in the Flightplan Field 18 under STS/. Possible options are:

An empty list indicates that there are no specific status requirements for flights. I.e. any flight, regardless of its status, can operate

| | `purpose` | List |

The purpose for which the flight is operated. Possible options are:

An empty list indicates that there are no specific flight purpose requirements for flights. I.e. any flight, regardless of its purpose, can operate.

| | `direction` | String, `null` |

The direction in which the flight operates, either:

null indicates that both departures and arrivals are allowed.

| Each `openFor` object contains further properties to describe the conditions that need to be satisfied for the airport to be available to the flights listed. These additional properties are: | Property | Type | Description | | --------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `priorNoticeRequired` | Number, `null` | The number of hours, ahead of the movement time, required to give notice of a movement. `0` indicates that notice is required, but availability is immediate. `null` indicates that no notice is required. | | `costsInvolved` | Boolean | Indicates if there are additional costs involved in accessing the airport for the specific type of flight. | | `other` | String | Any additional condition that cannot otherwise be described. | ### `ciq` Availability CIQ (Customs Immigration and Quarantine) Availability indicates the availability of Customs and Immigration facilities to process aircraft, crew, passengers and cargo as required by local regulations. The `info` object for CIQ Availability can only contain `notes`, if applicable. ### `atc` Availability ATC (Air Traffic Control) Availability indicates the availability of Air Traffic Services to support aircraft during the final descent, landing and ground movement. The `info` object for ATC Availability have the following properties in addition to the base model described before: * `afisOnly` a boolean which when `true` indicates that only AFIS (Aerodrome Flight Information Service) is provided. * `enRtfAvailable` a boolean which when `true` indicates that English Radiotelephony is available. This simply means that the radio operator can speak English. ### `arff` Availability ARFF (Airport Rescue and Fire Fighting) Availability indicates the availability of Rescue and Fire Fighting services to attend in case of an emergency. The `info` object for ARFF Availability have the following properties in addition to the base model described before: * `icaoCatAirplane` indicates the ICAO Rescue and Fire Fighting category for airplanes (not helicopters). Possible values are `NONE`, `I`, `II`, `III`, `IV`, `V`, `VI`, `VII`, `VIII`, `IX`, `X`. `null` means the information is not available. * `faaCatAirplane` indicates the FAA category. Possible values are `NONE`, `A`, `B`, `C`, `D`, `E`. `null` indicates that the information is not available. * `faa139Certified` boolean that indicates if the airport is certified according to 14 CFR §139. If true, it means the basis for the ARFF certification are the US rules, which don’t allow for immediate conversion of `faaCatAirplane` to `icaoCatAirplane`. If `true` it indicates that `icaoCatAirplane` was a value calculated based on the values of `waterQuantity`, `complementaryQuantity`, `arffVehicles`, and `dischargeCapacity`. * `catHelicopters` indicates the ARFF value for helicopters. Possible values are `NONE`, `I`, `II`, `III`, `IV`. `null` if the information is not available. * `waterQuantity` the total water capacity of all ARFF vehicles available, in litres. * `complementaryQuantity` the total capacity of Complimentary Extinguishing Agent available, in kilograms. null if the information is not available. * `arffVehicles` the number of ARFF vehicles available. `null` if the information is not available. * `dischargeCapacity` the total discharge capacity of all ARFF vehicles available, in litres per minute. `null` if the information is not available. * `extensionAvailable` boolean which indicates if an upgrade of the ARFF to a higher category can be arranged. `null` if the information is not available. * `extensionNotice` amount of hours required to obtain ARFF extension before departure or arrival. `null` if the information is not available. * `extensionUpToIcao` the maximum ARFF obtainable with extension. This is only available in ICAO format. Possible values are as per `icaoCatAirplane`. `null` if the information is not available. * `firestationRemote` boolean which indicates if the ARFF service is offered by a remote fire station, not located at the airfield, for example, a village fire station. `null` if the information is not available. * `firestationNotes` if `firestationRemote` is `true`, this text field allows notes about the location and performance of the remote fire station, for example, to indicate the response time. ### The `openingIndicator` flag This indicator is produced by the backend and takes into consideration all 4 availabilities at the current time. Possible values are: * `OPEN` to indicate that all facilities are fully available. * `SEE_TIMES` to indicate that some, potentially non-critical, facilities are not fully available and that the user should check full details. * `CLOSED` to indicate that either `movemet` or all facilities are not available. * `UNKNOWN` to indicate that there is not enough information to determine the current opening status of the location. For client implementation, it is recommended that only `OPEN` and `CLOSED` statuses are used for decision-making, and that any other status is analyzed in more details or referred to a human for exception management. # Aircraft {% hint style="info" %} ## To be published soon This page will be published soon on our new shiny open documentation! If you would like to request a static copy of the documentation for this endpoint, please write us an email to {% endhint %} # Aircraft Position The Aircraft Position object specifies the physical location of an aircraft that is seen by our network. The same object is used independently of the source of the data, making it possible to receive information from multiple sources, like ground- and satellite-based ADS-B, ADS-C, Eurocontrol and FAA, all in one consistent format. The Aircraft Position object is broken down into a part with information about the Aircraft, and a child object with the Position information. ``` { "icao24": "4D212D", "registration": "9H-VJT", "blocked": false, "position": { "baroAltitude": 0, "groundSpeed": 0, "course": null, "verticalRate": null, "coordinates": { "latitude": 42.69123, "longitude": 23.400879 }, "observed": "2021-05-21T12:52:09.36603", "onGround": true, "callsign": "VJT817T", "squawk": "1054", "technology": "ADSB" } } ``` | Property | Type | Description | | -------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `icao24` | String | The ICAO 24bit address of the transponder in hexadecimal format. | | `registration` | String, `null` |

The aircraft registration marks, as commonly displayed in the country of registration. For example G-AVIO, or N372AW .

A value of null indicates that the information is not available.

| | `blocked` | Boolean | Indicates if the aircraft is included in the [FAA LADD](https://ladd.faa.gov/) blocking list. This is only for information, as aviowiki is not required to hide these aircraft from public view. | ### The Position object The Position object contains information on an individual position tracked by our network. | Property | Type | Description | | -------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `baroAltitude` | Number, `null` |

The barometric altitude as reported by the aircraft's transponder, in metres.

null indicates that this information is not available, or that the aircraft is on the ground, when onGround is true.

| | `verticalRate` | Number, `null` |

The rate of climb/descent as reported by the aircraft's transponder, in metres per second. This can be negative, which indicates a

null indicates that this information is not available.

| | `groundSpeed` | Number, `null` |

The ground speed as reported by the aircraft's navigation system, in metres per second.

null indicates that this information is not available.

| | `course` | Number, `null` |

The True Course as reported by the aircraft's navigation system, in degrees (0 to 359).

null indicates that this information is not available.

Be aware that this information is only reliable when the aircraft is moving.

| | `coordinates` | Object | A [Coordinates](/data-models/coordinates) object that describes the geographical position of the aircraft. | | `observed` | String |

The UTC time at which this position was received by us. This is usually just a few milliseconds after the aircraft transmits the information.

Time is formatted in ISO format.

| | `onGround` | Boolean |

Indicates if the transponder is transmitting that the aircraft is on the ground. This parameter works differently for different types of aircraft avionics. In some aircraft it is commanded by a pressure switch on the main landing gear, in others it is derived by the avionics' software. Not all transponders offer this information.

null indicates that this information is not available, because it either was not provided by the aircraft or it was not possible to reliably derive.

| | `technology` | String |

The source of the position report. Possible values are:

  • ADSB: for positions by a Mode S or ADS-B transponder, using a 24-bit ICAO address, and received by a ground receiver.
  • ADSB\_SAT: for positions by an ADS-B transponder, using a 24-bit ICAO address, and received by satellite.
  • ADSC: for a position received monitoring the ADS-C satellite downlink
  • MLAT: for a Multilateration position, calculated by arrival time differences using multiple receivers, outliers and varying accuracy is expected
  • MODE\_S: for ModeS data from the plane's transponder (no position transmitted)
  • ADSB\_NT: for positions from an ADS-B equipped “non-transponder” emitter e.g. a ground vehicle, using a 24-bit ICAO address, and received by a ground receiver.
  • ADSB\_REBROADCAST: for rebroadcast of ADS-B messages originally sent via another data link e.g. UAT, using a 24-bit ICAO address
  • TISB: for traffic information about a non-ADS-B target identified by a 24-bit ICAO address, e.g. a Mode S target tracked by secondary radar
  • ADSB\_OTHER: for positions from an ADS-B transponder using a non-ICAO address, e.g. anonymized addresses issued by the FAA.
  • ADSR\_OTHER: for rebroadcast of ADS-B messages originally sent via another data link e.g. UAT, using a non-ICAO address
  • TISB\_OTHER: for traffic information about a non-ADS-B target using a non-ICAO address
  • TISB\_TRACKFILE: for traffic information about a non-ADS-B target using a track/file identifier, typically from primary or Mode A/C radar
  • OTHER: miscellaneous data received via Basestation receivers or in SBS format. Quality and source is generally unknown.
| # Coordinates This object represents geographical coordinates in Latitude and Longitude. Throughout our API we provide coordinates using decimal degrees with a precision of up to 7 decimal places. This guarantees a worse accuracy of 1.1112 centimetres at the Equator. Decimal coordinates represent degrees of latitude and longitude. Negative values indicate South for Latitude and West for Longitude. All coordinates make reference to the [WGS84](https://en.wikipedia.org/wiki/World_Geodetic_System) model. | **Property** | **Type** | **Description** | | ------------ | -------- | --------------------------------------------------------------------------------------------------------------------------- | | `latitude` | number |

The decimal latitude, with up to seven decimal places.
Unsigned means positive, for North.
Negative for South.

| | `longitude` | number |

The decimal longitude, with up to seven decimal places.
Unsigned means positive, for East.
Negative for West.

| For example: ``` { "latitude" : 40.639925, "longitude" : -73.7786944 } ``` represent the Coordinates object for New York JFK airport. # Region Regions define political or geographical groupings of countries or territories. For example, the [European Union](https://en.wikipedia.org/wiki/European_Union) is defined as a list of countries, while [Europe](https://en.wikipedia.org/wiki/Europe) is defined geographically by a series of polygons. There is one special region that includes all countries in the world and has special AID `RGN-WRLD-WIDE` The Region object includes the following properties: | Property | Type | Description | | -------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | string | The aviowiki ID for this Region, with naspace `RGN` | | `name` | string | The name assigned to the Region. | | `countries` | list, `null` |

A list of Countries that are included in the Region.
null indicates that the Region is not defined by any Country.

| | `multipolygon` | list, `null` |

A list of polygons, that are on their own a list of Coordinates that define the vertices of the polygon.
null indicates that the Region is not defined by any polygon.

| For example ``` { "aid": "RGN-DOCS-TEST", "name": "Test Region", "countries": [ { "iso2": "FO", "iso3": "FRO", "isoNumeric": 234, "name": "Faroe Islands", "officialName": null, "localIdentifierName": null } ], "multipolygon": [ [ [ 3.7792969, 80.9491884 ], [ 41.0449219, 80.9422728 ], [ 18.984375, 73.4033377 ] ] ] } ``` Represents a Region that includes Faroes Islands as a Country, and Svalbard as a geographical area enclosed in a triangle. # Country The Country object provides information on world territories that are generally recognised to have sovereignty. When countries are referenced externally, the [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) Alpha-3 code should be used as it serves as a unique identifier. | **Property** | **Type** | **Description** | | --------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | The common name of the country in English. | | `officialName` | string | The official name of the country in English. This is sometimes different from `name` | | `iso2` | string | The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) Alpha-2 code. | | `iso3` | string | The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) Alpha-3 code. | | `isoNumeric` | number | The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) Numeric number. | | `localIdentifierName` | string, `null` | The name of the identifier that this country issues to airports that don't have an official ICAO or IATA code, or in addition to these. | **Example:** ``` { "iso2": "MX", "iso3": "MEX", "isoNumeric": 484, "name": "Mexico", "officialName": "United Mexican States" } ``` # Governing District The Governing District object represents the information for identifying the principal provinces or states of the US and Canada referenced in the [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) standards.
PropertyTypeDescription
codestringAn alphanumeric code consisting of the 2 letter country code and a string of up to three alphanumeric characters. This code can be used to uniquely identify a country subdivision.
administrativeTypestringThe type of subdivision in each country. For example, this could be a Parish, Province, Emirate or District.
namestringThe name of the subdivision.
{% hint style="warning" %} This object is reserved for future use, and it is currently defaulted to `null` in most API responses. {% endhint %} # Runway Runways a children elements of an [Airport](/data-models/airport). They don’t have any child element themselves. Runways are assigned [AIDs](/conventions/aviowiki-ids) in the `RWY` namespace. A Runway represents a landing surface in one of its usable directions, if applicable. For example, at an airport with one runway oriented North/South and usable in both directions, there will be two `RWY` elements, one representing the northbound take-off and landing direction and the other its southbound counterpart. | **Property** | **Type** | **Description** | | ------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | string | A string with the AID of the airport, with `RWY` as namespace | | `identifier` | string, `null` |

The runway identifier, for example 35L.

Can be null if helipad is true

| | `helipad` | boolean, `null` |

true to indicate that this surface is dedicated to the movement of VTOL aircraft.

null indicates that the information is not available.

| | `trueBearing` | number, `null` |

The runway bearing with reference to True North.

null indicates that the information is not available.

| | `surface` | string, `null` |

The type of material that constitutes the surface of the runway.

Possible values are:
– ASPHALT indicates any mineral aggregate bound with asphalt, including bituminous asphalt or tarmac.
– CONCRETE indicates any aggregate bonded together with a fluid cement.
– GRAVEL indicates any loose aggregation of rock fragments.
– DIRT indicates any prepared or semi-prepared surface with an earthy surface.
– GRASS indicates any prepared or semi-prepared surface with a grass cover.
– SNOW indicates any compact or loose snow cover, which is meant for usage with specific landing gears.
– WATER indicates any marked or unmarked body of water, or portion thereof, which is meant for floatplanes or amphibious aircraft operations.

null indicates that this information is not available.

| | `thresholdCoordinates` | number, `null` |

A Coordinates object that indicates the beginning of the surface being described, on the centerline.

null indicates that this information is not available.

| | `thresholdElevation` | number, `null` |

A number indicating the elevation in meters of the runway threshold at the location indicated by thresholdCoordinates. Precision is up to two decimal places.

null indicates that this information is not available.

| | `slope` | number, `null` |

A number indicating the slope in the direction of landing and take-off. This is expressed in decimal percentage.
For example, 0.03 means an uphill slope of 3%, and -0.04 a downhill slope of 4%.

null indicates that this information is not available.

| | `grooved` | boolean, `null` |

If true it indicates that the runway surface has been grooved to improve friction in wet conditions. false indicates that this process was not undertaken.

null indicates that this information is not available.

| | `tora` | number, `null` |

The Take-Off Run Available expressed in meters with precision up to two decimal positions.

null indicates that this information is not available.

| | `toda` | number, `null` |

The Take-Off Distance Available expressed in meters with precision up to two decimal positions.

null indicates that this information is not available.

| | `asda` | number, `null` |

The Accelerate Stop Distance Available expressed in meters with precision up to two decimal positions.

null indicates that this information is not available.

| | `lda` | number, `null` |

The Landing Distance Available expressed in meters with precision up to two decimal positions.

null indicates that this information is not available.

| | `width` | number, `null` |

The runway width expressed in meters with precision up to two decimal positions.

null indicates that this information is not available.

| | `pcnNumerical` | number, `null` |

The numerical portion of the Pavement Classification Number, which indicates the load-carrying capacity of the pavement.

null indicates that this information is not available.

| | `pcnType` | string, `null` |

Indicates the type of pavement as reported in the Pavement Classification Number.
Possible values are:
– R for Rigid, most typically concrete
– F for flexible, most typically asphalt

null indicates that this information is not available.

| | `pcnStrength` | string, `null` |

Indicates the strength of the subgrade, as reported in the Pavement Classification Number.
Possible values are:
– A High Strength – for example, concrete-stabilised clay
– B Medium Strength
– C Low Strength
– D Ultra-Low Strength – for example, uncompacted soil

null indicates that this information is not available.

| | `pcnTirePressure` | string, `null` |

Indicates the maximum tire pressure that the pavement can support, ad reported in the Pavement Classification Number.
Possible values are:
– W Unlimited – no tyre pressure limit
– X High – maximum tyre pressure of 1.75 MPa
– Y Medium – maximum tyre pressure of 1.25 MPa
– Z Low – maximum tyre pressure of 0.5 MPa

null indicates that this information is not available.

| | `pcnMethod` | string, `null` |

Indicates the method through which the value of pcnNumerical was obtained.
Possible values are:
– T to indicate technical evaluation
– U to indicate usage – a physical testing regime.

null indicates that this information is not available.

| | `visualApproachSlopeIndicator` | string, `null` |

Indicates what type of Visual Approach Slope Indicator System is used for the surface.
Possible values are:
– NONE No VASIS is installed or available.
– P2L PAPI with 2 lights installed left of the runway
– P2R PAPI with 2 lights installed right of the runway

– P2B PAPI with 2 lights installed both sides of the runway
– P4L PAPI with 4 lights installed left of the runway
– P4R PAPI with 4 lights installed right of the runway

– P4B PAPI with 4 lights installed both sides of the runway
– PSIL Pulsating/Steady burning VASI installed left of the runway
– PSIR Pulsating/Steady burning VASI installed right of the runway
– S2L Simplified Abbreviated VASI with 2 lights installed left of the runway
– S2R Simplified Abbreviated VASI with 2 lights installed right of the runway
– V2L VASI with 2 lights installed left of the runway
– V2R VASI with 2 lights installed right of the runway

– V4L VASI with 4 lights installed left of the runway
– V4R VASI with 4 lights installed right of the runway
– V6L VASI with 6 lights installed left of the runway
– V6R VASI with 6 lights installed right of the runway
– V12 VASI with 12 lights installed on both sides
– V16 VASI with 16 lights installed on both sides

null indicates that this information is not available.

| | `approachLightConfiguration` | string, `null` |

Indicates what type of Approach Light System is installed.
Possible values are:
– NONE Indicates that no ALS is installed

– MALS1,400 Foot Medium Intensity Approach Lighting System
– MALSR 1,400 foot medium intensity approach lighting system with runway alignment indicator lights
– MALSF 1,400 foot medium intensity approach lighting system with sequenced flashers
– SALS short approach lighting system

– SALSF short approach lighting system with sequenced flashing lights.
– SSALS simplified short approach lighting system
– SSALR simplified short approach lighting system with runway alignment indicator lights
– SSALF simplified short approach lighting system with sequenced flashers
– ODALS omnidirectional approach lighting system
– ALSF1 standard 2,400 foot high-intensity approach lighting system with sequenced flashers, category I configuration
– ALSF2 standard 2,400 foot high-intensity approach lighting system with sequenced flashers, category II or III configuration
– ICAO1\_HIALS ICAO-compliant configuration 1, High-Intensity Approach Lighting System
– ICAO2\_HIALS ICAO-compliant configuration 2 High-Intensity Approach Lighting System
– LDIN Lead-in lighting
– REIL Runway End Identification Lights
– RAIL Runway Alignment Indicator Lights

null indicates that this information is not available.

| | `thresholdLights` | boolean, `null` |

true indicates that the surface has Threshold Lights installed. false that such lights are not installed.

null indicates that this information is not available.

| | `touchDownZoneLights` | boolean, `null` |

true indicates that the surface has Touch-Down Zone Lights installed. false that such lights are not installed.

null indicates that this information is not available.

| | `centerLights` | boolean, `null` |

true indicates that the surface has Centerline Lights installed. false that such lights are not installed.

null indicates that this information is not available.

| | `centerLightsSpacing` | number, `null` |

Indicates the distance in meters between individual Lights along the Centerline. Precision is up to two decimal places.

null indicates that this information is not available.

| | `edgeLights` | boolean, `null` |

true indicates that the surface has Edge Lights installed. false that such lights are not installed.

null indicates that this information is not available.

| | `endLights` | boolean, `null` |

true indicates that the surface has End Lights installed. false that such lights are not installed.

null indicates that this information is not available.

| | `instrumental` | boolean, `null` |

true indicates that the runway has at least one instrumental approach that serves the landing direction being described. false that only visual approach is available.

null indicates that this information is not available.

| | `precision` | boolean, `null` |

true indicates that the runway has at least one instrumental precision approach that serves the landing direction being described. false that only non-precision approaches are available.

null indicates that this information is not available.

| | `separate` | boolean, `null` |

true indicates that the runway constitutes a separate landing surface from other runways. This runway may overlay or cross other runways in such a way that if one of the runways is blocked, it will not prevent operations on the other runway. This satisfies the criteria of JAR-OPS-1.192(9) for physical separation.

null indicates that this information is not available.

| | `standardPattern` | boolean, `null` |

true indicates that the runway has a standard left-hand traffic pattern. false indicates that a right-hand pattern is in use.

null indicates that this information is not available.

| | `parent` | string | The AID of the parent [Airport](/data-models/airport). | # Provider Providers are children elements of an [Airport](/data-models/airport). Providers can optionally have children elements, that are [Products](/data-models/generic-product) and describe goods or services offered for sale or hire by the Provider. A Provider represents an entity at or nearby an [Airport](/data-models/airport) that provides some service that can be useful to aircraft operations or aircraft crew members. All Providers have [AIDs](/conventions/aviowiki-ids) in the `PRV` namespace. It is worth noting that **Handling** Providers have additional properties to extend the Provider model. These are contained in the `handlingProvider` property. Details are discussed [further down on this page.](/data-models/provider#handling-provider) ### Generic Provider | **Property** | **Type** | **Description** | | ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | string | A string with the AID of the airport, with `PRV` as namespace. | | `category` | string |

Represents what the nature of the business for this provider is.

Possible values are:
– HANDLING For all ground handling providers. Providers with this category will be extended by property handlingProvider
– FUEL For all fuel providers. Providers in this category will be extended by property fuelProvider
– DEICING For companies offering aircraft de-icing and anti-icing.
– CATERING For companies offering food packed for carriage and consumption on-board an aircraft.
– PRIVATE\_TRANSFER For companies offering transport by road with private-hire vehicles (cars, minibus, bus), as opposed to regular taxi companies.
– TAXI For regularly licensed taxi companies.
– CAR\_RENTAL For companies offering vehicles for hire without a driver.
– HOTEL For all hotels and accommodation facilities.
– RESTAURANT For food businesses that have premises dedicated to hosting guests for on-site dining. These locations may also offer takeaway catering.
– CAFETERIA For food businesses that mainly focus on hot and soft drinks and light refreshments to be consumed on-site or taken away.
– AIRCRAFT\_CLEANING For companies dedicated to carrying out aircraft interior and/or exterior cleaning.
– LAUNDRY For companies dedicated to washing laundry. This may include aircraft laundry as well as clothes and uniforms and could be self-service or fully serviced.
– DISH\_WASHING For companies dedicated to washing aircraft crockery and cutlery.
– MAINTENANCE For companies certified to carry out aircraft maintenance.
– AIRCRAFT\_SERVICING For companies able to support aircraft with minor services, like tire pressure checking and inflation, towing, oxygen refill, power carts, air start, etc. These companies may or may not be certified by the competent authority, depending on the regulatory framework.
– TAX\_REFUND For services that facilitate claiming of taxes for international customers. These may governmental agencies or commercial establishments.
– SUPERMARKET For grocery shops.
– AIRCRAFT\_SUPPLIES For businesses dedicated to the warehousing sales and distribution of aircraft spare parts and consumables.

| | `name` | string | The name of the business. | | `email` | string, `null` |

The email address of the business.

null indicates that this information is not available.

| | `phone` | string, `null` |

The phone number of the business during regular business hours.

null indicates that this information is not available.

| | `vhf` | number, `null` |

The frequency in Mhz for voice communication between the aircraft and the Provider. This is in the range of 118.000 and 136.975.

null if this information was not added.

| | `outOfHoursPhone` | string, `null` |

The phone number of the business outside of regular business hours.

null indicates that this information is not available.

| | `website` | string, `null` |

The website of the business, pointing to the page most relevant for this location.

null indicates that this information is not available.

| | `sita` | string, `null` |

The SITA address to communicate with this business at this location, or the most relevant location.

null indicates that this information is not available.

| | `aftn` | string, `null` |

The AFTN address to communicate with this business at this location, or the most relevant location.

null indicates that this information is not available.

| | `streetName` | string, `null` |

The street address, including any numbering, for the business. This should be the most relevant address where the business can receive customers, suppliers and deliveries.

null indicates that this information is not available.

| | `locality` | string, `null` |

The city of the business address, as used for postal routing.

null indicates that this information is not available.

| | `municipality` | string, `null` |

The state, province, county, or administrative region in which the locality is situated.
For example, Ontario, Alberta, or California.

null indicates that this information is not available.

| | `governingDistrict` | string, `null` | This object is reserved for future use, and it is currently defaulted to `null` in all API responses. | | `postalCode` | string, `null` |

The postal code, according to the standard of the country.

null indicates that this information is not available.

| | `country` | object, `null` |

A Country object representing where the business is physically located. This may be different from the jurisdiction of incorporation of the business.

null indicates that this information is not available.

| | `paymentMethods` | list, `null` |

A list of payment methods that can be used at the Provider. These are intended available without prior arrangement with the provider and accepted for all customers.
Possible values are:
– VISA Visa debit and credit cards
– MASTERCARD Mastercard debit and credit cards
– AMERICAN\_EXPRESS American Express cards
– DINERS\_CLUB Diners Club cards
– JCB JCB cards
– DISCOVER Discover cards
– WORLD\_FUEL\_SERVICES World Fuel Services card or Release
– COLT Colt card or Release
– UVAIR UVair Fueling Card or Release
– AVFUEL AVCARD or Release
– AIRBP AirBP card or Release
– TOTAL Total card or Release
– SHELL Shell card or Release
– OTHER\_CARNET other carnets not listed above.
– OTHER\_RELEASE other releases not listed above.
– INVOICE the Provider will send an invoice to the customer for later payment.
– CASH cash in the local currency, and possibly in other international currencies.

– BITCOIN Bitcoin on-chain transactions.

| | `featuredOrder` | number, `null` |

This number indicates to clients in which order to display providers of the same category to the end users.
The position in this list depends on a series of commercial, data quality and usage factors.

-1 indicates a provider that should always be displayed on top, as “Featured”. These providers have been checked by our curators team and reliability of the data is highest. Only one provider per category at the same location can have this set to -1.

Any other value from 0 upwards indicates a decreasing position under the featured provider, if any. For clarification, 0 should be displayed before 1 and 1 before 2.

null indicates that the provider has not been vetted by our team, and the accuracy of the data is not guaranteed.

| | `logo` | reserved | This will contain methods to retrieve the logo of the Provider. | | `pictures` | reserved | This will contain methods to retrieve pictures for the Provider. | | `parent` | string | The AID of the [Airport](/data-models/airport) to which this Provider belongs. | | `handlingProvider` | object, `null` |

If category is HANDLING, this is an object that describes properties specific to Handling companies. Full details can be found in the next paragraphs.

null if category is any other value.

| | `fuelProviders` | object, `null` |

If category is FUEL, this is an object that describes properties specific to Fuel companies. Full details can be found in the next paragraphs.

null if category is any other value.

| ### Handling Provider | **Property** | **Type** | **Description** | | ------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `serviceLevel` | string, `null` |

The type of service offered by this Provider. Possible options are:

  • HANDLER for a ground handler that usually serves airlines, or a non-GA/BA specific ground handler.
  • FBO for a specific GA/BA ground handler.
  • SUPERVISION for a local representative offering airside support to GA/BA flights using equipment of another ground handler.
  • SUPPORT for any remote arrangement that facilitates the operations of GA/BA flights.

null if this information is not available.

| | `accountsEmail` | string, `null` |

The email address of the Accounting department. This is where the Provider prefers to receive emails related to accounting and financial matters.

null if this information was not available.

| | `accountsPhone` | string, `null` |

The phone number of the Accounting department. This is where the Provider prefers to receive calls related to accounting and financial matters.

null if this information was not available.

| | `paxMeetingCoordinates` | object, `null` |

A Coordinates object illustrating where passengers can meet with a representative of this Handling Provider. This should be in a public area accessible to private vehicles.

null if this information is not available.

| | `aircraftParkingPolygon` | list, `null` |

A list of Coordinates objects which delimit the area where aircraft served by this Handling Provider are usually parked.

null if this information was not added.

| | `fboBuildingPolygon` | list, `null` |

A list of Coordinates objects which delimit the area of the main building from which this Handling Provider perform its core services.

null if this information was not added.

| | `terminalServices` | list, `null` |

A list of services offered by this Handling Provider at their premises for passengers’ convenience.

Possible values are:

– DEDICATED\_TERMINAL a dedicated area in an own building, or part of another building, where passengers are physically separated from the airline passengers.
– CUSTOMS\_ON\_SITE a customs checkpoint on site, or the possibility to arrange one on request.
– SECURITY\_ON\_SITE a security screening point on site, or the possibility to arrange one.
– AIRSIDE\_BOARD\_TO\_BOARD the possibility to transfer a passenger from an airline flight to a GA/BA flight, or vice versa, meeting the passenger at a location airside.
– LANDSIDE\_CONNECTION\_ASSISTANCE the possibility to transfer a passenger from an airline flight to a GA/BA flight, or vice versa, meeting the passenger at a location landside.
– AIRLINE\_MEET\_AND\_GREET the possibility to receive an airline passenger to facilitate airport procedures. It is not specified if this happens landside or airside.
– CREW\_COURTESY\_CAR the availability of a car to be used by the crew for the period of time their aircraft is serviced by this Provider.
– CAR\_RENTAL a dedicated car-rental point, or the possibility of having rented cars picked-up at the location of this Provider.
– CREW\_TRANSFER transfer for the crew members, usually to and from their hotel, arranged by this Provider.
– CONFERENCE\_ROOMS the availability of rooms equipped to allow meetings at the premises of the Provider.
– CREW\_SHOWERS the availability of shower facilities and changing rooms for crew members to use.
– PASSENGER\_SHOWERS the availability of shower facilities and changing rooms for passengers to use.
– CREW\_SNOOZE\_ROOM a room equipped in such a way that allows crew members to take short periods of sleep.
– PASSENGER\_SNOOZE\_ROOM a room equipped in such a way that allows passengers to take short periods of sleep.
– CHILDREN\_AREA a safe area dedicated to children’s play.
– COMPLIMENTARY\_REFRESHMENTS the availability of refreshments for the users of this Provider.
– CONCIERGE\_SERVICES the availability of ancillary services arranged by the Provider on behalf of the user.
– CREW\_CAR\_PARK car park dedicated to the crew members of an aircraft using this Provider.
– PASSENGER\_CAR\_PARK car park dedicated to the passengers of an aircraft using this Provider.
– TAX\_REFUND the availability on site of a service that facilitates claiming of taxes for international customers. This may be a governmental agency or a commercial establishment.
– SHOPS\_ON\_SITE shops on the premises of the Provider. These may be convenience stores, gift shops, or other generic shops.
– RESTAURANTS\_ON\_SITE restaurants on the premises of the Provider that serve food and have space for dining in.
– CATERING\_COLD\_STORAGE the possibility of storing catering supplies in a refrigerated compartment or room.
– LUGGAGE\_STORAGE the possibility of storing customer luggage for a definite period of time.

null if this information was not added.

| | `aircraftServices` | list, `null` |

A list of aircraft services offered by this Handling Provider.

Possible values are:
– DEDICATED\_PARKING parking for the aircraft in a design area which is used exclusively by the Provider.
– SELF\_MANEUVERING\_PARKING parking that allows taxi in and taxi out without assistance from external vehicles.
– TOW\_TRUCK a dedicated vehicle to move the aircraft on the airport surface without the aircraft’s own power.
– LUGGAGE\_CARTS trolleys to move large amounts of luggage to and from the aircraft.
– WHEELCHAIR\_LOADER\_BIZJET a vehicle dedicated to the movement of Passengers with Reduced Mobility and with an interface suitable to business jets.
– WHEELCHAIR\_LOADER\_AIRLINER a vehicle dedicated to the movement of Passengers with Reduced Mobility and with an interface suitable to airliners.
– LUGGAGE\_BELT a belt on wheels to mechanically lift luggage from the ground to the aircraft’s luggage compartment.
– AIRLINE\_CONTAINER\_LOADER a vehicle to load, lift and manoeuvre ULD containers.
– POTABLE\_WATER a vehicle or other means to load potable water into the aircraft, via a suitable aircraft interface.
– VACUUM\_TOILET\_SERVICE a vehicle or other means to empty a waste tank for toilets operating with a vacuum system.
– CHEMICAL\_TOILET\_SERVICE the availability of adequate means to empty a waste tank for chemical toilets, including the supply of adequate consumables to make the toilet serviceable again.
– TKS\_FLUID availability of TKS anti-icing fuel.
– DEICING availability of de-icing and anti-icing equipment and fluids.
– OXYGEN\_UPLOAD equipment and trained personnel to refill the on-board oxygen system.
– TYRE\_INFLATION equipment and trained personnel to check tyre pressure and inflate tyres.
– GPU\_115V\_440HZ availability of AC Ground Power at a voltage of 115v and frequency of 440Hz.
– GPU\_28V availability of DC Ground Power at a voltage of 28v.
– GPU\_12V availability of DC Ground Power at a voltage of 12v.
– AIR\_STARTER equipment and trained personnel to conduct turbine engine air start. The aircraft interface is not specified.
– CREW\_LADDER a portable ladder available to the crew for inspecting parts of the aircraft that are not immediately available from the ground.
– AIRCRAFT\_STAIRS movable stairs, usually used for airliners or larger aircraft that do not carry a built-in ladder.
– FORKLIFT a vehicle and an operator able to forklift palletized cargo.
– CABIN\_COOLING\_HEATING\_CART a unit that can provide heated or chilled air to the aircraft cabin. The aircraft interface is not specified.

null if this information was not added.

| | `fuelProducts` | list, `null` |

A list of Fuel Products that are available for sale by the Provider.
Other Generic Products may also be available for this Provider and may be retrieved using the relevant endpoint.

| # Generic Product A Generic Product is any product that is not a [Fuel Product](/data-models/fuel-product). Generic Products can represent anything as easy as a can of coke sold by a [Handling Provider](/data-models/provider#handling-provider), to more complex structures like a parking fee charged per hour per ton of MTOM. Prices entered in aviowiki should always be intended as guidance, and do not constitute contractual obligation between the Provider and clients or prospects. They are, however, an extremely useful tool to compare pricing at different Providers, and better estimate the cost of a trip. | `aid` | string | A string with the AID of the Product, with `PVP` as namespace. | | -------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `name` | string | The name of the good or service being sold. | | `description` | string, `null` |

A brief description of the good or service being sold.

null if this information was not added.

| | `price` | number, `null` |

The unit price.

A value of 0 indicates that the service is free of charge.

null if this information was not added.

| | `currency` | string, `null` |

The ISO 4217 3-letters currency code.

null if this information was not added.

| | `taxInclusive` | boolean, `null` |

Boolean indicating if the price shown is inclusive of all local taxes or not.

true if the price includes all taxes, false otherwise.

null if this information was not added.

| | `unit` | string, `null` |

The unit for which the price is specified.

Possible values are:
– LTR for liters
– LBS for pounds
– KG for kilograms
– USG for US Gallons
– IMP for Imperial Gallons
– PIECE to indicate one piece
– QRT for US Quarts
– PINT for Imperial Pints
– NIGHT for a local night, for example when expressing hotel stays
– H24 for a period of 24 hours
– HOUR for each hour
– MINUTE for each minute
– CALENDAR\_DAY for each calendar day
– CALENDAR\_MONTH for each calendar month
– METER for linear metres
– SET to indicate a single set, for example if the Product is usually sold as a bundle.

More details about the unit can be included in the description, for example to specify the duration of a NIGHT, or the content of a SET.

null indicates that this information was not added.

| | `quantity` | number, `null` |

The quantity of unit that the price refers to.

This can be useful to create intermediate measure. For example, to describe price of a 6 hours parking: unit will be HOUR and quantity 6.

null indicates that this information was not added.

| | `parent` | string | The AID of the parent [Provider](/data-models/provider). | ### Example ``` { "name": "Grana Padano", "description": "Hard Italian Cheese PDO. Can be served grated or in pieces.", "currency": "EUR", "quantity": 1.00, "unit": "KG", "price": 69.95, "taxInclusive": false, "parent": "PRV-56CW-HX5K", "aid": "PVP-TFBJ-KTEU" } ``` # Fuel Product The Fuel Product can describe any product used as fuel for an aircraft. The units of measure available are volumetric since the billed amounts are always metered by volume. | **Property** | **Type** | **Description** | | ----------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | string | A string with the AID of the Fuel Product, with `FPR` as namespace. | | `name` | string | A label for this fuel product. | | `description` | string, `null` | A free text description for this product. This should not be used to enter information in contradiction with other properties in this or other models. | | `type` | string |

A string indicating the type of fuel product being described.

Possible values are:
– JET\_A for JET A fuel
– JET\_A1 for JET A-1 fuel
– JET\_B for JET B fuel
– TS1 for TS-1 fuel
– AVGAS\_100\_130 for AvGas 100/130
– AVGAS\_100LL for AvGas 100LL
– AVGAS\_91\_96UL for AvGas 91/96UL
– JP5 for military kerosene JP-5
– JP8 for military kerosene JP-8
– MO\_GAS for regular automotive gasoline
– DIESEL for regular automotive diesel

null if this information was not added.

| | `price` | number | The unit price for this Fuel Product. | | `currency` | string | The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letters currency code. | | `unit` | string |

The unit of measure to which the price refers.

possible values are:
– LTR for liters
– USG for US Gallons
– IMP for Imperial Gallons

| | `limitedAvailability` | boolean, `null` |

true indicates that this Fuel Product is available in limited quantity only and that, therefore, operators should make reasonable prior arrangements before planning on uplifting it.

false if the stock level allows usual uplifts to happen without prior arrangement.

This property only indicates stock levels, and any other prior arrangement required for payment or other purposes is not taken into consideration.

| | `minimumVolume` | number, `null` | A number between `0` and `999999 that`indicates the minimum volume to which the price is applicable. | | `maximumVolume` | number, `null` | A number between `0` and `999999 that`indicates the minimum volume to which the price is applicable. | | `selfService` | boolean, `null` |

A boolean which indicates if the fuel is applicable to self-service only.

true indicates that the price is for full service only.

false indicates that the price includes service.

| | `minimumHandlingWaiver` | number, `null` |

Indicates the minimum amount in unit required to waive handling charges.

It is a number from 0 to 999999, where 999999 indicates that handling charges are always applicable.

| | `parent` | string | The AID of the [Provider](/data-models/provider) which offers this Fuel Product. | ### Example ``` { "type": "JET_A1", "unit": "USG", "currency": "USD", "price": 3.47, "limitedAvailability": false, "selfService": false, "minimumVolume": 0, "maximumVolume": 200, "minimumHandlingWaiver": 50, "aid": "FPR-8P21-2ZOY", "parent": "PRV-234K-APDB" } ``` # Fuel Fee {% hint style="warning" %} This object is reserved for future use, and it is currently defaulted to `null` in all API responses. {% endhint %} # Webhook The webhook object is passed using the `POST` REST verb to an URL indicated by the User, to notify a customer's system about events happening in the aviowiki data. Events represent changes in data, and some information is given to assist the receiving service to select the best course of action to be taken. The POST requests include a JSON Body and a digital signature in the Header. A webhook notification is made up of a root Notification object and of a Data object, which contains details about the specific notification being sent. ### Notification object The Notification object is the root object of the JSON passed in the Body of the `POST` request sent to the webhook. Its properties are: | Property | Type | Description | | ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `timestamp` | String | The ISO 8601 timestamp of when the change occurred | | `event` | String |

The type of event that this notification refers to. Possible options are:

| | `data` | Object | A Data object that describes the change being notified. This object's content varies based on the `event` type. For full details refer to the following paragraphs. | ### `DATA_CHANGE` notifications Notifications with `event` `DATA_CHANGE` alert the client about changes in a static dataset, like a new airport being published, or a change in a runway length. An example of a `DATA_CHANGE` notification is shown below ``` { "timestamp": "2021-05-24T15:27:04", "event": "DATA_CHANGE", "data": { "type": "AIRPORT", "aid": "APT-1234-ABCD", "action": "EDIT", "url": "https://api.aviowiki.com/airports/APT-1234-ABCD" } } ``` The Data object in these notifications contains the following properties: | Property | Type | Description | | -------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | String |

The type of data object that the change affects. Possible options are:

  • AIRPORT
  • AIRPORT\_AVAILABILITY
  • RUNWAY
  • PROVIDER
  • PROVIDER\_AVAILABILTY
  • REGION
  • AIRPORT\_NOTES
  • COUNTRY\_NOTES
  • PROVIDER\_PRODUCT
  • FUEL\_PRODUCT
  • FUEL\_COST
  • AIRPORT\_AUTHORITY
  • AIRPORT\_AUTHORITY\_CONTACT
  • COUNTRY\_AUTHORITY
  • COUNTRY\_AUTHORITY\_CONTACT
| | `aid` | String | The AID of the entity affected by this change. | ### `FLIGHT_UPDATE` notifications Notifications with `event` `FLIGHT_UPDATE` alert the client about changes in the status of an aircraft moving. This data is computed by aviowiki using flight tracking data based on Mode-S, ADS-B and ADS-C messages. As an example, the body of such notification would look similar to the below ``` { "event": "FLIGHT_UPDATE", "timestamp": "2022-05-27T09:39:55.501951673", "data": { "type": "FLIGHT", "url": "https://api.aviowiki.com/flights/88bc0cf1-4480-4d4a-b121-136f442e8dfa", "id": "88bc0cf1-4480-4d4a-b121-136f442e8dfa", "action": "LANDING" } } ``` The Data object in these notifications contains the following properties | Property | Type | Description | | -------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | String | This is currently a static value always set to `FLIGHT` to indicate that the notification relates to a flight status change. | | `id` | String | The unique id of the flight. This is in UUID Version 4 format. A flight is created when the first event is detected by aviowiki. | | `url` | String | The API URL to retrieve full information about the flight. | | `action` | String |

Describe the action that the flight has executed and that is being notified.

Options currently implemented are:

  • TAKE\_OFF to indicate the lift-off.
  • LANDING to indicate the touch-down

Options reserved but not currently implemented are:

  • OFF\_BLOCK
  • ON\_BLOCK
  • APPROACH
  • OFF\_ROUTE
  • RETURN\_TO\_STAND
  • INITIATE\_EMERGENCY
  • END\_EMERGENCY
  • DIVERSION
| ### Security Webhook notifications are served over a TLS connection to the endpoint specified when creating the subscription. To make sure that webhooks are correctly delivered, please make sure that your client is capable of TLS version 1.2 or above, and that the connection is secure by a trusted certificate (you can obtain one for free from [Let's Encrypt](https://letsencrypt.org/)). Because most of the content of a web request can be spoofed, all our webhooks are served with a Header that contains a digital signature of the content. When you create a new webhook subscription, you are provided with a `secret` string, which is the private key used to generate such signatures. The header containing the signature is called `aviowiki-signature` and it looks something like this: `t=1637657904997,v1=f2f04243c4794a9c359691c8a88d4c8681d128184647af2e0bf4133b90d05322` As you can see the header is divided into two parts: `t` and `v1`. `t` contains a timestamp, while the `v1` parameter is the HMAC signature of the request body. To verify the signature, you should follow the steps below. #### Step 1: Extract the timestamp and signatures from the header Split the header, using the `,` character as the separator, to get a list of elements. Then split each element, using the `=` character as the separator, to get a prefix and value pair. The value for the prefix `t` corresponds to the timestamp, and `v1` corresponds to the signature. You can discard all other elements. #### Step 2: Prepare the `signed_payload` string The `signed_payload` string is created by concatenating: * The timestamp (as a string) * The character `.` * The actual JSON payload (i.e., the request body) #### Step 3: Determine the expected signature Compute an HMAC with the SHA256 hash function. Use the endpoint’s signing `secret` as the key, and use the `signed_payload` string as the message. #### Step 4: Compare the signatures Compare the signature in the header to the expected signature. For an equality match, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance. To protect against timing attacks, use a constant-time string comparison to compare the expected signature to the received signature. # Error Should an error occur with your request, the aviowiki API will reply with an HTTP response code in the `4xx` or `5xx` range, depending on the type of error. Errors in the `4xx` range relate to client errors, meaning that something unexpected happened with data supplied or an action requested by the client. This could be bad format or invalid authentication for example. Errors in the `5xx` range relate to server errors, meaning that an unexpected exception happened in our backend while trying to serve your request. When an error code is returned, the body of the response will contain a JSON object with the following properties: | **Property** | **Type** | **Description** | | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `timestamp` | string | The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date and time of when the error occurred on the server. For example `2019-08-30T13:23:32.163+0000` | | `status` | number | The HTTP response code returned. For example `403` | | `error` | string | A description of the HTTP response code returned. | | `message` | string | A human-readable message explaining what generated the error. | | `path` | string | The resource path that was requested. This does not include the base URL. For example `/airports/search`. | ### Example ``` { "timestamp": "2019-08-30T13:23:32.163+0000", "status": 403, "error": "Forbidden", "message": "Token expired", "path": "/airports/search" } ``` # Operational Note # Airport Operational Note An Operational Note is a piece of textual information that is intended for [Airport](/data-models/airport) users, and that cannot be otherwise modelled digitally. Scenarios that should be entered as Operational Notes include occurrences such as potential delays, special events, parking restrictions, etc. To facilitate the filtering of Operational Notes in client systems, some machine-readable properties are included. {% hint style="info" %} Airport Operational Notes should not be used for temporary airport closures, runways closures, or any other information that can be modeled in [Availability](/data-models/availability) or any other part of the data model. {% endhint %} | **Property** | **Type** | **Description** | | ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aid` | string | A string with the [AID](/conventions/aviowiki-ids) of the Airport Operational Note, with `ONA` as namespace | | `validFrom` | string |

An ISO 8601 formatted date-time string that indicates when the Operational Note is first in force. This is expressed in Local Time.
For example 2020-01-30T08:00:00.

| | `validTo` | string |

An ISO 8601 formatted date-time string that indicates when the Operational Note ceases to be in force. This is expressed in Local Time.
For example 2020-02-02T18:59:59

| | `criticality` | string |

A string indicating the level of criticality of the Operational Note.
Possible values are:

  • INFORMATION\_ONLY for information that have no operational impact. Knowledge is considered relevant to make the operations smoother, but no operational impact arises from not knowing of it. For example: JET-A1 pressurized refuelling not available. Only overwing refuelling possible.
  • OPERATIONALLY\_RELEVANT for information that may have an operational impact, but is not critical. Not knowing such information will likely have a minor operational impact in the form of delays or inconvenient to the crew or passengers. The flight can still take place under all circumstances. For example: Parking stands in front of the FBO are closed due to Work In Progress. Only remote stands available with a car transfer to the FBO.
  • OPERATIONALLY\_CRITICAL for information that is relevant and critical. Not knowing will likely have a major operational impact up to refusal of service. Performance of a flight might not be possible in all conditions. For example: ILS CAT I inoperative, or JET-A1 fuel not available.
| | `source` | string |

A description of where this information was originated.
For example Airport Authority or Ground Handler or Local news.

| | `category` | string |

A string that indicates what the Airport Operational Note is about.
Possible values are:

  • RUNWAY For runways and other take-off and landing surfaces.
  • AIRLINES\_TERMINAL For the terminal building and connected services that are used by scheduled airlines.
  • GENERAL\_AVIATION\_TERMINAL For the terminal building and connected services that are used by General and Business Aviation.
  • FUEL For all fuel supplies.
  • PARKING For parking availability and restrictions.
  • TAXIWAYS For all taxiways and taxilanes.
  • WEATHER For weather phenomena affecting the airport.
  • PROCEDURES For special or non-standard procedures that are in place at the airport.
  • EVENTS For events affecting airport traffic, such as airshows.
  • COSTS For extraordinary costs that airport users should be aware of.
  • STRIKES For upcoming personnel strikes that might affect airport operations.
  • IMMIGRATION For all airport-specific immigration issues.
  • DELAYS For upcoming events that are expected to bring delays, but are not included in any other more specific category above.
  • RISK For all safety and security risks related to airport operations.
  • RESTRICTIONS For all temporary restrictions that cannot be documented in other parts of the Airport model.
| | `affectedTraffic` | list | This object is reserved for future use, and it is currently defaulted to `null` in all API responses. | | `notes` | string |

The text of the information that is to be displayed to the human.
For example JET-A1 pressurized refuelling not available

| | `parent` | string | The [AID](/conventions/aviowiki-ids) of the [Airport](/data-models/airport) at which this Operational Note is applicable | # Country Operational Note An Operational Note is a piece of textual information that is intended for [Country](/data-models/country) users, and that cannot be otherwise modelled digitally. Scenarios that should be entered as Operational Notes include occurrences such as special events and restrictions, etc.
PropertyTypeDescription
aidstringA string with the AID of the Country Operational Note, with ONA as namespace
validFromstringAn ISO 8601 formatted date-time string that indicates when the Operational Note is first in force. This is expressed in Local Time. For example 2020-01-30T08:00:00.
validTostringAn ISO 8601 formatted date-time string that indicates when the Operational Note ceases to be in force. This is expressed in Local Time.
For example 2020-02-02T18:59:59.
sourcestringA description of where this information was originated.
For example Airport Authority or NOTAM or Local news.
criticalitystring

A string indicating the level of criticality of the Operational Note.
Possible values are:

  • INFORMATION_ONLY for information that have no operational impact. Knowledge is considered relevant to make the operations smoother, but no operational impact arises from not knowing of it.
  • OPERATIONALLY_RELEVANT for information that may have an operational impact, but is not critical. Not knowing such information will likely have a minor operational impact in the form of delays or inconvenient to the crew or passengers. The flight can still take place under all circumstances. For example: Temporary military exercises.
  • OPERATIONALLY_CRITICAL for information that is relevant and critical. Not knowing will likely have a major operational impact up to refusal of service. Performance of a flight might not be possible in all conditions. For example: widespread fuel shortages, volcanic activity, strikes and no-fly/conflict zones
notesstringThe text of the information that is to be displayed to the human.
Due to ongoing armed conflict, all airports are closed until further notice.
category

A string that indicates what the Airport Operational Note is about.
Possible values are:

  • WEATHER For weather phenomena affecting the airport.
  • PROCEDURES For special or non-standard procedures that are in place at the airport.
  • EVENTS For events affecting airport traffic, such as airshows.
  • COSTS For extraordinary costs that airport users should be aware of.
  • STRIKES For upcoming personnel strikes that might affect airport operations.
  • IMMIGRATION For all airport-specific immigration issues.
  • DELAYS For upcoming events that are expected to bring delays, but are not included in any other more specific category above.
  • RISK For all safety and security risks related to airport operations.
  • RESTRICTIONS For all temporary restrictions that cannot be documented in other parts of the Airport model.
affectedTrafficlistThis object is reserved for future use, and it is currently defaulted to null in all API responses.
parentstringThe AID of the Country which this Operational Note is applicable.
### Example ``` { "validFrom": "2024-01-15T09:03:04.448", "validTo": "2099-12-31T23:59:59", "source": "NOTAM", "criticality": "OPERATIONALLY_CRITICAL", "notes": "Due to ongoing armed conflict, all airports are closed until further notice. ", "category": "EVENTS", "affectedTraffic": null, "parent": { "iso2": "MX", "iso3": "MEX", "isoNumeric": 484, "name": "Mexico", "officialName": "United Mexican States", "localIdentifierName": null }, "aid": "ONC-9C2R-QYYM", "kind": "COUNTRY" } ``` # Region Operational Note {% hint style="info" %} ## To be published soon This page will be published soon on our new shiny open documentation! If you would like to request a static copy of the documentation for this endpoint, please write us an email to {% endhint %} # Limitations At aviowiki, we believe that certain pieces of information are just public knowledge. Although we take pride in accurately collecting, carefully curating, precisely storing and easily serving them, we still want to make such information available to the larger public for free. The endpoints in this section can be accessed by anybody for free with no restrictions and no need for authentication. For the security of our systems, we have some soft limits in place also on these endpoints. If you think you’re going to use more than what’s listed below, you can [issue yourself a free API token](https://app.aviowiki.com/user/tokens) that allows you to go beyond such restrictions. These are your limits for free endpoints, without using an API token: * Maximum of 750 requests every 60 minutes from a single IP address, and * maximum of 7,500 requests every 24 hours from a single IP address. # Free airport endpoints # Airport data ## Get airport data by ICAO code `GET` `https://api.aviowiki.com/free/airports/icao/{icao}` #### Path Parameters | Name | Type | Description | | -------------------------------------- | ------ | ------------------------ | | icao\* | String | ICAO code of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} ```javascript { // Response } ``` {% endtab %} {% tab title="404: Not Found " %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Get airport data by IATA code `GET` `https://api.aviowiki.com/free/airports/iata/{iata}` #### Path Parameters | Name | Type | Description | | -------------------------------------- | ------ | ------------------- | | iata\* | String | IATA of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} ```javascript { // Response } ``` {% endtab %} {% tab title="404: Not Found " %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Get airport data by local identifier code `GET` `https://api.aviowiki.com/free/airports/localIdentifier/{localIdentifier}` #### Path Parameters | Name | Type | Description | | ------------------------------------------------- | ------ | ------------------------------- | | localIdentifier\* | String | Local identifier of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} ```javascript { // Response } ``` {% endtab %} {% tab title="404: Not Found " %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} # Searching airports ## Searching using a query ## Search Airports using a text query `GET` `https://api.aviowiki.com/free/airports/search` This endpoint allows you to conduct an airport search using a free-text query string. #### Query Parameters | Name | Type | Description | | ----- | ------ | ------------------------------------------------------------------------------- | | page | number | The page number for pagination, starting from \`0\` to indicate the first page. | | size | number | The number of results in a page, for pagination. | | query | string | The query string you want to look for. | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200 The query succeeded and 0 or more results are returned." %} ``` { "page": { "number": 0, "size": 10, "totalPages": 1, "totalResults": 2 }, "content": [ { "country": { "iso2": "GB", "iso3": "GBR", "isoNumeric": 826, "name": "United Kingdom", "officialName": "United Kingdom of Great Britain and Northern Ireland" }, "timeZone": "Europe/London", "aid": "APT-FO61-WBTO", "coordinates": { "latitude": 51.4775, "longitude": -0.4613889 }, "icao": "EGLL", "iata": "LHR", "faa": null, "servedCity": "London", "servedCityGoverningDistrict": null, "name": "Heathrow Airport" }, { "country": { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America" }, "timeZone": "America/Chicago", "aid": "APT-PEKY-N349", "coordinates": { "latitude": 44.4641394, "longitude": -89.3587256 }, "icao": null, "iata": null, "faa": "WS14", "servedCity": "Amherst, WI", "servedCityGoverningDistrict": { "code": "US-WI", "name": "Wisconsin", "administrativeType": "State" }, "name": "Lake Ell Field" } ] } ``` {% endtab %} {% endtabs %} ### Format of the returned objects The response will be a Paged List of results. Each result object contains a limited set of information that we consider to be essential to identify a location. For this endpoint the properties available in the response are:
PropertyTypeDescription
PropertyTypeDescription
aidstringA string with the AID of the airport, with APT as namespace
icaostring, nullA string with the 4-letters ICAO code of the airport, ornull if none is assigned
iatastring, nullA string with the 3-letters IATA code of the airport, or null if none is assigned.
faastring, nullA string with the FAA code, or null if none is assigned.
coordinatesobject, nullA Coordinates object which represents the location of the Aerodrome Reference Point.
This is null when the information is not known.
countryobject, nullA Country object which represents the country at which an airport is located.
null if this is not known.
timeZonestring, nullThe timezone of the airfield as noted in the IANA Time Zone Database.
null indicates that this information is not available.
namestring, nullThe name of the airport. This should be the official name of the airport written in Latin characters.
servedCitystring, nullA string containing the name of the city served by the airport. In some countries, like the USA, this includes the state. For example: Los Angeles, CA.
This is null when the information is not known.
# Airport endpoints # Searching airports ## Search for airports using a text query or additional options and filters. `GET` `https://api.aviowiki.com/airports/search` This endpoint allows you to conduct an airport search using a free-text query string. It further allows to restrict the search results to certain locations based on filters passed as query parameters. #### Query Parameters | Name | Type | Description | | ------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | query | String | The query string (name, city etc.) you want to look for. | | page | Number | The page number for pagination, starting from `0` to indicate the first page. Default: `0` | | size | Number | The number of results in a page, for pagination. Default: `10` | | types | List |

A comma-separated list of airport types to return. Possible options are AIRPORT, HELIPORT, AIRSTRIP, WATER.

If set it limits the returned locations to those with matching types in the type field.

| | accepts | List |

A comma-separated list of the accepted types of traffic. Possible options are SCHEDULED, NON\_SCHEDULED, GENERAL\_AVIATION, TRAINING, BUSINESS\_AVIATION, MILITARY, HELICOPTER.

If set it limits the returned locations to those with matching types in the accessibleFor field.

| | requiresPermission | Boolean |

If set to true, returns locations that have any value in nonScheduledPermission except for NONE or null.

If set to false, returns location that have only NONE or null as nonScheduledPermission.

| | isVfr | Boolean |

If set to true, returns locations that allow VFR traffic.

If set to false, returns locations that

| | regions | List | | | country | String | | | countries | List | | | governingDistrict | String | | | minimumRunwayLength | Double |

Minimum runway TORA the returned airports need to have.
If set, it limits the returned locations to those that have at least one runway with TORA at least minimumRunwayLength.

| | maximumRunwayLength | Double |

Maximum TORA the returned airports need to have.
If set, it limits the returned locations to those that's runways have TORA at most maximumRunwayLength.

| | minimumRunwayWidth | Double |

Minimum runway width the returned airports need to have.
If set, it limits the returned locations to those that have at least one runway with width at least minimumRunwayWidth.

| | maximumElevation | Double |

Maximum elevation the returned airports need to have.
If set, it limits the returned locations to those that have elevation at most maximumElevation.

| | latitude | Double | Latitude of the reference point to search locations around. | | longitude | Double | Longitude of the reference point to search locations around. | | distance | Double | Maximum great circle distance in kilometers the returned locations need to be from the reference point set by the `latitude` and `longitude` parameters. Default: `100` | #### Headers | Name | Type | Description | | ----------------------------------------------- | ------ | ---------------------------------------- | | Authorization\* | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Paginated airport list" %} Detailed properties of the pagination can be found at [Pagination](/conventions/pagination). Properties of the contained airports: {% tabs %} {% tab title="Response properties" %} {% endtab %} {% tab title="Example response" %} ``` { "page": { "number": 0, "size": 10, "totalPages": 1, "totalResults": 1 }, "content": [ { "name": "John F. Kennedy International ", "country": { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America", "localIdentifierName": null }, "timeZone": "America/New_York", "aid": "APT-KS1J-8E0L", "coordinates": { "latitude": 40.6399278, "longitude": -73.7786944 }, "icao": "KJFK", "iata": "JFK", "localIdentifier": "JFK", "servedCityGoverningDistrict": { "code": "US-NY", "name": "New York", "administrativeType": "State" }, "servedCity": "New York", "elevation": 3.96, "longestRunwayLength": 3800.25, "widestRunwayWidth": 60.96, "openingIndicator": "OPEN", "icon": "CIVIL", "distanceFromSearchCoordinates": null, "operationalStatus": null } ] } ``` {% endtab %} {% endtabs %} {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %}
PropertyTypeDescription
PropertyTypeDescription
aidStringAviowiki ID of the airport, with APT as namespace
nameStringThe name of the airport. This should be the official name of the airport written in Latin characters.
countryCountryA Country object which represents the country at which an airport is located.
timeZoneStringThe time-zone of the airfield as noted in the IANA Time Zone Database.
Defaults to null when this information is not available.
coordinatesCoordinates Coordinates object which represents the location of the Aerodrome Reference Point.
Defaults to null if the information is not known.
icaoStringA string with the 4-letters ICAO code of the airport, or null if none is assigned
iataStringA string with the 3-letters IATA code of the airport, or null if none is assigned.
localIdentifierStringAn identifier issued by the local authority, which is not recognised as an official ICAO or IATA code.
The name of the code for each country can be found in Country.localIdentifierName
servedCityGoverningDistrictGoverning District

A Governing District object indicating the Governing District of the servedCity.

Defaults to null when the information is not known.

servedCityString

A string containing the name of the city served by the airport.


Defaults to null when the information is not known.

elevationDecimalA decimal number representing the elevation of the airport expressed in meters. Two decimal positions are provided, for precise conversion to feet.

Defaults to null when the information is not known.
longestRunwayLengthDecimalLongest runway length expressed in meters with precision up to two decimal positions.

Defaults to null when this information is not available.
widestRunwayWidthDecimalThe widest runway width expressed in meters with precision up to two decimal positions.

Defaults to null when this information is not available.
openingIndicatorStringOpening indicator flag taking into consideration the 4 types of airport availability. For details see opening indicator section.
Available values: OPEN, SEE_TIMES, CLOSED, UNKNOWN

Defaults to null when this information is not available.
distanceFromSearchCoordinatesDecimalDistance from the search coordinates given in the query expressed in kilometers with precision up to two decimal positions.

Defaults to null when no search coordinates were given in the query.
operationalStatusStringWorst criticality of the valid operational notes for the airport. Available values:
INFORMATION_ONLY, OPERATIONALLY_RELEVANT, OPERATIONALLY_CRITICAL

Defaults to null when no operational notes are present for the airport.
## Retrieve random airports `GET` `https://api.aviowiki.com/airports/search/random` #### Query Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------------------------------------------------- | | page | Number | The page number for pagination, starting from \`0\` to indicate the first page. | | size | Number | The number of results in a page, for pagination | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Paginated airport list" %} {% tabs %} {% tab title="Response properties" %} {% endtab %} {% tab title="Example response" %} ``` { "page": { "number": 0, "size": 1, "totalPages": 10000, "totalResults": 10000 }, "content": [ { "name": "Rundu Airport", "country": { "iso2": "NA", "iso3": "NAM", "isoNumeric": 516, "name": "Namibia", "officialName": "Republic of Namibia", "localIdentifierName": null }, "timeZone": "Africa/Windhoek", "aid": "APT-NYRI-716E", "coordinates": { "latitude": -17.9561111, "longitude": 19.7205556 }, "icao": "FYRU", "iata": "NDU", "localIdentifier": null, "servedCityGoverningDistrict": null, "servedCity": null, "aid": "APT-NYRI-716E", "elevation": 1106.0, "longestRunwayLength": 3354.0, "widestRunwayWidth": 30.0, "openingIndicator": "UNKNOWN", "icon": "OTHER", "distanceFromSearchCoordinates": null, "operationalStatus": null } ] } ``` {% endtab %} {% endtabs %} {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} {% endtab %} {% endtabs %}
PropertyTypeDescription
PropertyTypeDescription
nameStringThe name of the airport. This should be the official name of the airport written in Latin characters.
countryCountryA Country object which represents the country at which an airport is located.
timeZoneStringThe time-zone of the airfield as noted in the IANA Time Zone Database.
Defaults to null when this information is not available.
aidStringAviowiki ID of the airport, with APT as namespace
coordinatesCoordinates Coordinates object which represents the location of the Aerodrome Reference Point.
Defaults to null if the information is not known.
icaoStringA string with the 4-letters ICAO code of the airport, or null if none is assigned
iataStringA string with the 3-letters IATA code of the airport, or null if none is assigned.
localIdentifierStringAn identifier issued by the local authority, which is not recognised as an official ICAO or IATA code.
The name of the code for each country can be found in Country.localIdentifierName
servedCityGoverningDistrictGoverning District

A Governing District object indicating the Governing District of the servedCity.

Defaults to null when the information is not known.

servedCityString

A string containing the name of the city served by the airport.


Defaults to null when the information is not known.

elevationDecimalA decimal number representing the elevation of the airport expressed in meters. Two decimal positions are provided, for precise conversion to feet.

Defaults to null when the information is not known.
longestRunwayLengthDecimalLongest runway length expressed in meters with precision up to two decimal positions.

Defaults to null when this information is not available.
widestRunwayWidthDecimalThe widest runway width expressed in meters with precision up to two decimal positions.

Defaults to null when this information is not available.
openingIndicatorStringOpening indicator flag taking into consideration the 4 types of airport availability. For details see opening indicator section.
Available values: OPEN, SEE_TIMES, CLOSED, UNKNOWN

Defaults to null when this information is not available.
distanceFromSearchCoordinatesDecimalDistance from the search coordinates given in the query expressed in kilometers with precision up to two decimal positions.

Defaults to null when no search coordinates were given in the query.
operationalStatusStringWorst criticality of the valid operational notes for the airport. Available values:
INFORMATION_ONLY, OPERATIONALLY_RELEVANT, OPERATIONALLY_CRITICAL

Defaults to null when no operational notes are present for the airport.
# Airport data ## Get full airport data `GET` `https://api.aviowiki.com/airports/{aid}` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Airport details" %} The detailed properties of the returned object can be found in the documentation of the [Airport](/data-models/airport) data model. ```json { "icao": "KJFK", "iata": "JFK", "localIdentifier": "JFK", "name": "John F. Kennedy International ", "servedCity": "New York", "servedCityGoverningDistrict": { "code": "US-NY", "name": "New York", "administrativeType": "State" }, "administrativeCity": null, "administrativeCityGoverningDistrict": null, "elevation": 3.96, "coordinates": { "latitude": 40.6399278, "longitude": -73.7786944 }, "variation": -13.00, "country": { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America", "localIdentifierName": null }, "timeZone": "America/New_York", "perimeter": null, "type": "AIRPORT", "operator": "PUBLIC", "accessibleFor": [ "SCHEDULED", "NON_SCHEDULED", "GENERAL_AVIATION", "MILITARY", "BUSINESS_AVIATION" ], "ifr": true, "nonScheduledPermission": "NONE", "nonScheduledPermissionNotes": null, "mandatoryHandling": false, "mandatoryQualification": false, "qualificationLink": null, "qualificationNotes": null, "weightLimit": 9999999.00, "wingspanLimit": 999.00, "paxLimit": 999, "referenceWeatherStation": null, "aid": "APT-KS1J-8E0L" } ``` {% endtab %} {% tab title="404: Not Found Airport by the given Aviowiki ID does not exist." %} ```json { "error": "The Airport identified by {AID} does not exist.", "timestamp": "2022-07-14T11:45:53.093205678Z", "status": 404, "message": "The Airport identified by {AID} does not exist.", "path": "/airports/{AID}" } ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} {% endtab %} {% endtabs %} Retrieving airport data by ICAO, IATA and local identifiers is also possible, for more information view [Free airport endpoints](https://app.gitbook.com/s/-MS2fBXSpqyanE1zUgLP/~/changes/azyVdsTRjG0nkFbEtlIg/free-endpoints/free-airport-endpoints/airport-data). # Authorities at an airport ## Get all the authorities at an airport `GET` `https://api.aviowiki.com/airports/{aid}/airportAuthorities/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The detailed properties of one returned set item can be found in the [Airport Authority](/data-models/authority#airport-authority) documentation. ```json [ { "type": "CUSTOMS", "name": "CBP General Aviation", "landsideArea": null, "airsideArea": null, "customsDetails": null, "parent": "APT-KS1J-8E0L", "aid": "AAU-HZK3-O7WM", "kind": "AIRPORT" }, { "type": "OWNER", "name": "Port Authority of New York and New Jersey", "landsideArea": null, "airsideArea": null, "customsDetails": null, "parent": "APT-KS1J-8E0L", "aid": "AAU-VD0K-XUFQ", "kind": "AIRPORT" } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Get paged authorities at an airport `GET` `https://api.aviowiki.com/airports/{aid}/airportAuthorities` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------------------------------------------------- | | page | Number | The page number for pagination, starting from \`0\` to indicate the first page. | | size | Number | The number of results in a page, for pagination. | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The properties of the pagination can be found at [Pagination](/conventions/pagination). The detailed properties of one returned set item can be found in the [Airport Authority](/data-models/authority#airport-authority) documentation. ```json { "page": { "number": 0, "size": 10, "totalPages": 1, "totalResults": 2 }, "content": [ { "type": "CUSTOMS", "name": "CBP General Aviation", "landsideArea": null, "airsideArea": null, "customsDetails": null, "parent": "APT-KS1J-8E0L", "aid": "AAU-HZK3-O7WM", "kind": "AIRPORT" }, { "type": "OWNER", "name": "Port Authority of New York and New Jersey", "landsideArea": null, "airsideArea": null, "customsDetails": null, "parent": "APT-KS1J-8E0L", "aid": "AAU-VD0K-XUFQ", "kind": "AIRPORT" } ] } ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} # Availability of an airport ## Get 24 hours of availability information starting from specified date and time. `GET` `https://api.aviowiki.com/airports/{aid}/availability` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | dateTime | String | Range start for the availability retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | local | Boolean | Whether to use local time or UTC. If `true` the `dateTime` query parameter shall be provided in local time as well. Default value: `false` | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful" %} The detailed properties of the returned item can be found in the [Availability ](/data-models/availability)documentation. ```json { "openingIndicator": "SEE_TIMES", "arff": [ { "validFrom": "2022-07-26T00:00:00", "validTo": "2022-07-26T00:29:59.999999999", "status": "FULL", "info": { "icaoCatAirplane": "IX", "faaCatAirplane": null, "faa139Certified": null, "catHelicopters": null, "waterQuantity": null, "complementaryQuantity": null, "arffVehicles": null, "dischargeCapacity": null, "extensionAvailable": true, "extensionNotice": null, "extensionUpToIcao": "X", "firestationRemote": null, "firestationNotes": "" } }, { "validFrom": "2022-07-26T00:30:00", "validTo": "2022-07-26T05:59:59.999999999", "status": "FULL", "info": { "icaoCatAirplane": "VII", "faaCatAirplane": null, "faa139Certified": null, "catHelicopters": null, "waterQuantity": null, "complementaryQuantity": null, "arffVehicles": null, "dischargeCapacity": null, "extensionAvailable": true, "extensionNotice": null, "extensionUpToIcao": "IX", "firestationRemote": null, "firestationNotes": "" } }, { "validFrom": "2022-07-26T06:00:00", "validTo": "2022-07-26T23:59:59.999999999", "status": "FULL", "info": { "icaoCatAirplane": "IX", "faaCatAirplane": null, "faa139Certified": null, "catHelicopters": null, "waterQuantity": null, "complementaryQuantity": null, "arffVehicles": null, "dischargeCapacity": null, "extensionAvailable": true, "extensionNotice": null, "extensionUpToIcao": "X", "firestationRemote": null, "firestationNotes": "" } } ], "atc": [ { "validFrom": "2022-07-26T00:00:00", "validTo": "2022-07-26T23:59:59.999999999", "status": "FULL", "info": { "enRtfAvailable": true, "afisOnly": null } } ], "ciq": [ { "validFrom": "2022-07-26T00:00:00", "validTo": "2022-07-26T23:59:59.999999999", "status": "FULL" } ], "movement": [ { "validFrom": "2022-07-26T00:00:00", "validTo": "2022-07-26T00:29:59.999999999", "status": "LIMITED", "info": { "openFor": [ { "flightTypes": [ { "rules": [], "filing": [], "airframe": [], "status": [], "purpose": [ "CARGO", "TRAINING", "LEISURE", "BUSINESS", "AIRLINE", "AERIAL_WORK" ], "direction": [] } ], "priorNoticeRequired": null, "costsInvolved": null, "other": "Delayed flights only " } ] } }, { "validFrom": "2022-07-26T00:30:00", "validTo": "2022-07-26T04:59:59.999999999", "status": "CLOSED", "info": {} }, { "validFrom": "2022-07-26T05:00:00", "validTo": "2022-07-26T05:59:59.999999999", "status": "LIMITED", "info": { "openFor": [ { "flightTypes": [ { "rules": [], "filing": [ "SCHEDULED", "NON_SCHEDULED" ], "airframe": [], "status": [], "purpose": [ "CARGO", "LEISURE", "BUSINESS", "AIRLINE" ], "direction": [ "ARRIVAL" ] } ], "priorNoticeRequired": null, "costsInvolved": null, "other": "Special slot required" } ] } }, { "validFrom": "2022-07-26T06:00:00", "validTo": "2022-07-26T21:59:59.999999999", "status": "FULL", "info": {} }, { "validFrom": "2022-07-26T22:00:00", "validTo": "2022-07-26T23:59:59.999999999", "status": "LIMITED", "info": { "openFor": [ { "flightTypes": [ { "rules": [], "filing": [ "SCHEDULED", "NON_SCHEDULED" ], "airframe": [], "status": [], "purpose": [ "CARGO", "LEISURE", "BUSINESS", "AIRLINE" ], "direction": [] } ], "priorNoticeRequired": null, "costsInvolved": null, "other": null } ] } } ] } ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} {% endtab %} {% tab title="404: Not Found Airport by the given Aviowiki ID was not found." %} ```json { "error": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "timestamp": "2022-07-26T16:23:01.474034802Z", "status": 404, "message": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "path": "/airports/{AID}/availability" } ``` {% endtab %} {% endtabs %} # Aerodrome Rescue and Fire Fighting availaibility ## Get 24 hours of ARFF availability information starting from specified date and time. `GET` `https://api.aviowiki.com/airports/{aid}/availability/arff` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | dateTime | String | Range start for the availability retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | local | Boolean | Whether to use local time or UTC. If `true` the `dateTime` query parameter shall be provided in local time as well. Default value: `false` | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful" %} The detailed properties of the returned item can be found in the [ARFF Availability](/data-models/availability#arff-availability) documentation. ```json [ { "validFrom": "2022-07-26T00:00:00", "validTo": "2022-07-26T00:29:59.999999999", "status": "FULL", "info": { "icaoCatAirplane": "IX", "faaCatAirplane": null, "faa139Certified": null, "catHelicopters": null, "waterQuantity": null, "complementaryQuantity": null, "arffVehicles": null, "dischargeCapacity": null, "extensionAvailable": true, "extensionNotice": null, "extensionUpToIcao": "X", "firestationRemote": null, "firestationNotes": "" } }, { "validFrom": "2022-07-26T00:30:00", "validTo": "2022-07-26T05:59:59.999999999", "status": "FULL", "info": { "icaoCatAirplane": "VII", "faaCatAirplane": null, "faa139Certified": null, "catHelicopters": null, "waterQuantity": null, "complementaryQuantity": null, "arffVehicles": null, "dischargeCapacity": null, "extensionAvailable": true, "extensionNotice": null, "extensionUpToIcao": "IX", "firestationRemote": null, "firestationNotes": "" } }, { "validFrom": "2022-07-26T06:00:00", "validTo": "2022-07-26T23:59:59.999999999", "status": "FULL", "info": { "icaoCatAirplane": "IX", "faaCatAirplane": null, "faa139Certified": null, "catHelicopters": null, "waterQuantity": null, "complementaryQuantity": null, "arffVehicles": null, "dischargeCapacity": null, "extensionAvailable": true, "extensionNotice": null, "extensionUpToIcao": "X", "firestationRemote": null, "firestationNotes": "" } } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} {% endtab %} {% tab title="404: Not Found Airport by the given Aviowiki ID was not found." %} ```json { "error": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "timestamp": "2022-07-26T16:23:01.474034802Z", "status": 404, "message": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "path": "/airports/{AID}/availability" } ``` {% endtab %} {% endtabs %} # Air Traffic Control availability ## Get 24 hours of ATC availability information starting from specified date and time. `GET` `https://api.aviowiki.com/airports/{aid}/availability/atc` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | dateTime | String | Range start for the availability retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | local | Boolean | Whether to use local time or UTC. If `true` the `dateTime` query parameter shall be provided in local time as well. Default value: `false` | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful" %} The detailed properties of the returned item can be found in the [ATC Availability](/data-models/availability#atc-availability) documentation. ```json [ { "validFrom": "2022-07-26T00:00:00", "validTo": "2022-07-26T23:59:59.999999999", "status": "FULL", "info": { "enRtfAvailable": true, "afisOnly": null } } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} {% endtab %} {% tab title="404: Not Found Airport by the given Aviowiki ID was not found." %} ```json { "error": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "timestamp": "2022-07-26T16:23:01.474034802Z", "status": 404, "message": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "path": "/airports/{AID}/availability" } ``` {% endtab %} {% endtabs %} # Customs, Immigration and Quarantine facilities availability ## Get 24 hours of CIQ availability information starting from specified date and time. `GET` `https://api.aviowiki.com/airports/{aid}/availability/ciq` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | dateTime | String | Range start for the availability retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | local | Boolean | Whether to use local time or UTC. If `true` the `dateTime` query parameter shall be provided in local time as well. Default value: `false` | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful" %} The detailed properties of the returned item can be found in the [CIQ Availability](/data-models/availability#ciq-availability) documentation. ```json [ { "validFrom": "2022-07-26T00:00:00", "validTo": "2022-07-26T23:59:59.999999999", "status": "FULL" } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} {% endtab %} {% tab title="404: Not Found Airport by the given Aviowiki ID was not found." %} ```json { "error": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "timestamp": "2022-07-26T16:23:01.474034802Z", "status": 404, "message": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "path": "/airports/{AID}/availability" } ``` {% endtab %} {% endtabs %} # Movement availability ## Get 24 hours of Movement availability information starting from specified date and time. `GET` `https://api.aviowiki.com/airports/{aid}/availability/movement` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------- | | dateTime | String | Range start for the availability retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | local | String | Whether to use local time or UTC. If `true` the `dateTime` query parameter shall be provided in local time as well. Default value: `false` | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful." %} The detailed properties of the returned item can be found in the [Movement Availability](/data-models/availability#movement-availability) documentation. ```json [ { "validFrom": "2022-07-26T00:00:00", "validTo": "2022-07-26T00:29:59.999999999", "status": "LIMITED", "info": { "openFor": [ { "flightTypes": [ { "rules": [], "filing": [], "airframe": [], "status": [], "purpose": [ "AIRLINE", "AERIAL_WORK", "LEISURE", "BUSINESS", "TRAINING", "CARGO" ], "direction": [] } ], "priorNoticeRequired": null, "costsInvolved": null, "other": "Delayed flights only " } ] } }, { "validFrom": "2022-07-26T00:30:00", "validTo": "2022-07-26T04:59:59.999999999", "status": "CLOSED", "info": {} }, { "validFrom": "2022-07-26T05:00:00", "validTo": "2022-07-26T05:59:59.999999999", "status": "LIMITED", "info": { "openFor": [ { "flightTypes": [ { "rules": [], "filing": [ "SCHEDULED", "NON_SCHEDULED" ], "airframe": [], "status": [], "purpose": [ "AIRLINE", "LEISURE", "BUSINESS", "CARGO" ], "direction": [ "ARRIVAL" ] } ], "priorNoticeRequired": null, "costsInvolved": null, "other": "Special slot required" } ] } }, { "validFrom": "2022-07-26T06:00:00", "validTo": "2022-07-26T21:59:59.999999999", "status": "FULL", "info": {} }, { "validFrom": "2022-07-26T22:00:00", "validTo": "2022-07-26T23:59:59.999999999", "status": "LIMITED", "info": { "openFor": [ { "flightTypes": [ { "rules": [], "filing": [ "SCHEDULED", "NON_SCHEDULED" ], "airframe": [], "status": [], "purpose": [ "AIRLINE", "LEISURE", "BUSINESS", "CARGO" ], "direction": [] } ], "priorNoticeRequired": null, "costsInvolved": null, "other": null } ] } } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} {% endtab %} {% tab title="404: Not Found Airport by the given Aviowiki ID was not found." %} ```json { "error": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "timestamp": "2022-07-26T16:23:01.474034802Z", "status": 404, "message": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "path": "/airports/{AID}/availability" } ``` {% endtab %} {% endtabs %} # Runways at an airport ## Get all runways at an airport `GET` `https://api.aviowiki.com/airports/{aid}/runways/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The detailed properties of one returned set item can be found in the [Runway](/data-models/runway) documentation. ```json [ { "helipad": false, "identifier": "13R", "magneticBearing": 134.00, "trueBearing": 121.00, "standardPattern": false, "thresholdElevation": 3.81, "width": 60.96, "tora": 4422.95, "toda": 4422.95, "asda": 4422.95, "lda": 3800.25, "surface": "CONCRETE", "pcnNumerical": 98, "pcnType": "R", "pcnStrength": "B", "pcnTirePressure": "W", "pcnMethod": "T", "edgeLights": true, "thresholdLights": false, "endLights": false, "centerLights": true, "centerLightsSpacing": null, "touchDownZoneLights": false, "visualApproachSlopeIndicator": "P4L", "approachLightConfiguration": "LDIN", "instrumental": false, "precision": false, "separate": false, "thresholdCoordinates": { "latitude": 40.6483617, "longitude": -73.8167147 }, "slope": null, "grooved": true, "parent": "APT-KS1J-8E0L", "aid": "RWY-V4ZG-LF64" }, ..., ..., ..., ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Get paged runways at an airport `GET` `https://api.aviowiki.com/airports/{aid}/runways` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------------------------------------------------- | | page | Number | The page number for pagination, starting from \`0\` to indicate the first page. | | size | Number | The number of results in a page, for pagination. | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The properties of the pagination can be found at [Pagination](/conventions/pagination). The detailed properties of one returned set item can be found in the [Runway](/data-models/runway) documentation. ```javascript { "page": { "number": 0, "size": 10, "totalPages": 1, "totalResults": 8 }, "content": [ { "helipad": false, "identifier": "13R", "magneticBearing": 134.00, "trueBearing": 121.00, "standardPattern": false, "thresholdElevation": 3.81, "width": 60.96, "tora": 4422.95, "toda": 4422.95, "asda": 4422.95, "lda": 3800.25, "surface": "CONCRETE", "pcnNumerical": 98, "pcnType": "R", "pcnStrength": "B", "pcnTirePressure": "W", "pcnMethod": "T", "edgeLights": true, "thresholdLights": false, "endLights": false, "centerLights": true, "centerLightsSpacing": null, "touchDownZoneLights": false, "visualApproachSlopeIndicator": "P4L", "approachLightConfiguration": "LDIN", "instrumental": false, "precision": false, "separate": false, "thresholdCoordinates": { "latitude": 40.6483617, "longitude": -73.8167147 }, "slope": null, "grooved": true, "parent": "APT-KS1J-8E0L", "aid": "RWY-V4ZG-LF64" }, ..., ..., ..., ] } ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} # Providers at an airport ## Get providers at an airport `GET` `https://api.aviowiki.com/airports/{aid}/providers/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful." %} The detailed properties of one returned set item can be found in the [Provider](/data-models/provider) documentation. ```json [ { "name": "RUDY'S INFLIGHT CATERING", "website": "http://www.rudysinflight.com", "phone": "+1 201 727 1122", "outOfHoursPhone": null, "email": "orders@rudysinflight.com", "streetName": " ", "locality": null, "municipality": " ", "governingDistrict": null, "postalCode": " ", "country": { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America", "localIdentifierName": null }, "paymentMethods": null, "category": "CATERING", "sita": null, "aftn": null, "vhf": null, "featuredOrder": null, "logo": null, "pictures": [], "handlingProvider": null, "parent": "APT-KS1J-8E0L", "aid": "PRV-ZFIK-5S6M" }, ..., ..., ... ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Get paged providers at an airport `GET` `https://api.aviowiki.com/airports/{aid}/providers` #### Path Parameters | Name | Type | Description | | ---- | ------ | -------------------------- | | aid | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------------------------------------------------- | | page | Number | The page number for pagination, starting from \`0\` to indicate the first page. | | size | Number | The number of results in a page, for pagination. | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful." %} The properties of the pagination can be found at [Pagination](/conventions/pagination). The detailed properties of one returned set item can be found in the [Provider](/data-models/provider) documentation. ```json { "page": { "number": 0, "size": 10, "totalPages": 1, "totalResults": 7 }, "content": [ { "name": "Drivania Chauffeurs", "website": "drivania.com", "phone": "+1 800 327 5174", "outOfHoursPhone": "+1 800 327 5174", "email": "sales@drivania.com", "streetName": "2655 South Le Jeune Rd Suite 810", "locality": "Coral Gables", "municipality": "Florida", "governingDistrict": null, "postalCode": "33134", "country": { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America", "localIdentifierName": null }, "paymentMethods": [ "MASTERCARD", "AMERICAN_EXPRESS", "INVOICE", "VISA" ], "category": "PRIVATE_TRANSFER", "sita": null, "aftn": null, "vhf": null, "featuredOrder": null, "logo": null, "pictures": [], "handlingProvider": null, "parent": "APT-KS1J-8E0L", "aid": "PRV-ZLZT-791A" }, ..., ..., ... ] } ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} # Weather at an airport This endpoint allows requesting [METAR](https://en.wikipedia.org/wiki/METAR) and [TAF](https://en.wikipedia.org/wiki/Terminal_aerodrome_forecast) weather reports at a certain airport. Weather reports are provided in their coded version and decoded as convenient to use JSON objects. It is additionally possible to specify a fallback policy in case no reports are available at the requested location. If `NEAREST` is used, the API will search for the nearest airport with a valid report and will return it. {% hint style="info" %} Some airports, that are known to never have weather reports available, may always return weather reports for a specified reference station. Such behaviour is controlled by the `referenceStation` property in the [Airport](/data-models/airport) object. When `referenceStation` is specified, if the requested location does not have valid weather reports, the weather reports of the `referenceStation` are returned. {% endhint %} ## Get weather report for an airport `GET` `https://api.aviowiki.com/airports/{aid}/weather/full` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fallback | String |

What to use as fallback if no weather report is available for the airport. Available values: NONE, NEAREST.
- NONE: do not use fallback

-NEAREST : use the nearest available weather report

Default value: NONE.

| #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} {% tabs %} {% tab title="Example response" %} ``` { "taf": { "reference": "APT-KS1J-8E0L", "endTime": "2022-07-27T18:00:00", "forecast": [ { "clouds": [ "SCT050", "BKN070", "BKN250" ], "endTime": "2022-07-26T16:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "2615/2718 02006KT P6SM SCT050 BKN070 BKN250", "sanitized": "2615/2718 02006KT P6SM SCT050 BKN070 BKN250", "startTime": "2022-07-26T15:00:00", "summary": "Winds NNE-020 at 6kt, Vis greater than 6sm, Scattered clouds at 5000ft, Broken layer at 7000ft, Broken layer at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 20, "windSpeed": 6, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "SCT050", "SCT070", "BKN250" ], "endTime": "2022-07-26T18:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM261600 27010KT P6SM SCT050 SCT070 BKN250", "sanitized": "FM261600 27010KT P6SM SCT050 SCT070 BKN250", "startTime": "2022-07-26T16:00:00", "summary": "Winds W-270 at 10kt, Vis greater than 6sm, Scattered clouds at 5000ft, Scattered clouds at 7000ft, Broken layer at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 270, "windSpeed": 10, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "SCT070", "BKN250" ], "endTime": "2022-07-27T00:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM261800 22012G18KT P6SM FEW050 SCT070 BKN250", "sanitized": "FM261800 22012G18KT P6SM FEW050 SCT070 BKN250", "startTime": "2022-07-26T18:00:00", "summary": "Winds SW-220 at 12kt gusting to 18kt, Vis greater than 6sm, Few clouds at 5000ft, Scattered clouds at 7000ft, Broken layer at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 220, "windGust": 18, "windSpeed": 12, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "SCT250" ], "endTime": "2022-07-27T02:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM270000 24010KT P6SM FEW050 SCT250", "sanitized": "FM270000 24010KT P6SM FEW050 SCT250", "startTime": "2022-07-27T00:00:00", "summary": "Winds WSW-240 at 10kt, Vis greater than 6sm, Few clouds at 5000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 240, "windSpeed": 10, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "FEW250" ], "endTime": "2022-07-27T05:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM270200 25007KT P6SM FEW050 FEW250", "sanitized": "FM270200 25007KT P6SM FEW050 FEW250", "startTime": "2022-07-27T02:00:00", "summary": "Winds WSW-250 at 7kt, Vis greater than 6sm, Few clouds at 5000ft, Few clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 250, "windSpeed": 7, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "FEW100", "SCT250" ], "endTime": "2022-07-27T15:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM270500 VRB05KT P6SM FEW050 FEW100 SCT250", "sanitized": "FM270500 VRB05KT P6SM FEW050 FEW100 SCT250", "startTime": "2022-07-27T05:00:00", "summary": "Winds Variable at 5kt, Vis greater than 6sm, Few clouds at 5000ft, Few clouds at 10000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 0, "windSpeed": 5, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "SCT100", "SCT250" ], "endTime": "2022-07-27T18:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM271500 18007KT P6SM FEW050 SCT100 SCT250", "sanitized": "FM271500 18007KT P6SM FEW050 SCT100 SCT250", "startTime": "2022-07-27T15:00:00", "summary": "Winds S-180 at 7kt, Vis greater than 6sm, Few clouds at 5000ft, Scattered clouds at 10000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 180, "windSpeed": 7, "wx_codes": [], "transition_start": null, "turbulence": [] } ], "raw": "KJFK 261431Z 2615/2718 02006KT P6SM SCT050 BKN070 BKN250 FM261600 27010KT P6SM SCT050 SCT070 BKN250 FM261800 22012G18KT P6SM FEW050 SCT070 BKN250 FM270000 24010KT P6SM FEW050 SCT250 FM270200 25007KT P6SM FEW050 FEW250 FM270500 VRB05KT P6SM FEW050 FEW100 SCT250 FM271500 18007KT P6SM FEW050 SCT100 SCT250", "remarks": "", "startTime": "2022-07-26T15:00:00", "station": "KJFK", "time": "2022-07-26T14:31:00", "units": { "altimeter": "inHg", "altitude": "ft", "temperature": "C", "visibility": "sm", "windSpeed": "kt", "accumulation": "in" } }, "metar": { "reference": "APT-KS1J-8E0L", "altimeter": 30, "clouds": [ "FEW050", "FEW095", "FEW180", "BKN240" ], "dewpoint": 13, "flightRules": "VFR", "other": [], "raw": "KJFK 261451Z 00000KT 10SM FEW050 FEW095 FEW180 BKN240 26/13 A3002 RMK AO2 SLP165 T02610128 58003", "remarks": "RMK AO2 SLP165 T02610128 58003", "remarksInfo": { "dewpointDecimal": "0128", "temperatureDecimal": "0261", "codes": [ { "repr": "AO2", "value": "Automated with precipitation sensor" } ], "maximum_temperature_6": null, "minimum_temperature_24": null, "precip_hourly": null, "sunshine_minutes": null, "precip_24_hours": null, "precip_36_hours": null, "minimum_temperature_6": null, "snow_depth": null, "sea_level_pressure": { "repr": "SLP165", "value": 1016.5, "spoken": "one zero one six point five" }, "maximum_temperature_24": null, "pressure_tendency": { "repr": "58003", "tendency": "Steady or increasing, then decreasing", "change": 0.3 } }, "runwayVisibility": [], "sanitized": "KJFK 261451Z 00000KT 10SM FEW050 FEW095 FEW180 BKN240 26/13 A3002 RMK AO2 SLP165 T02610128 58003", "station": "KJFK", "summary": "Winds Calm, Vis 10sm, Temp 26°C, Dew 13°C, Alt 30.02 inHg, Few clouds at 5000ft, Few clouds at 9500ft, Few clouds at 18000ft, Broken layer at 24000ft", "temperature": 26, "time": "2022-07-26T14:51:00", "units": { "altimeter": "inHg", "altitude": "ft", "temperature": "C", "visibility": "sm", "windSpeed": "kt", "accumulation": "in" }, "visibility": "10", "windDirection": 0, "windSpeed": 0, "windVariableDirection": [], "density_altitude": 1248, "pressure_altitude": -87, "wx_codes": [], "relative_humidity": 0.4368486805231886, "isaDeviation": 12 } } ``` {% endtab %} {% endtabs %} {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Get weather report for a list of airports `GET` `https://api.aviowiki.com/weather/full` #### Query Parameters | Name | Type | Description | | ------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fallback | Number |

What to use as fallback if no weather report is available for the airport. Available values: NONE, NEAREST.
- NONE: do not use fallback

-NEAREST : use the nearest available weather report

Default value: NONE.

| | aid\* | List | Comma separated list of Aviowiki IDs of the airports | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful" %} {% tabs %} {% tab title="Example response" %} ``` { "APT-KS1J-8E0L": { "taf": { "reference": "APT-KS1J-8E0L", "endTime": "2022-07-27T18:00:00", "forecast": [ { "clouds": [ "SCT050", "BKN070", "BKN250" ], "endTime": "2022-07-26T16:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "2615/2718 02006KT P6SM SCT050 BKN070 BKN250", "sanitized": "2615/2718 02006KT P6SM SCT050 BKN070 BKN250", "startTime": "2022-07-26T15:00:00", "summary": "Winds NNE-020 at 6kt, Vis greater than 6sm, Scattered clouds at 5000ft, Broken layer at 7000ft, Broken layer at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 20, "windSpeed": 6, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "SCT050", "SCT070", "BKN250" ], "endTime": "2022-07-26T18:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM261600 27010KT P6SM SCT050 SCT070 BKN250", "sanitized": "FM261600 27010KT P6SM SCT050 SCT070 BKN250", "startTime": "2022-07-26T16:00:00", "summary": "Winds W-270 at 10kt, Vis greater than 6sm, Scattered clouds at 5000ft, Scattered clouds at 7000ft, Broken layer at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 270, "windSpeed": 10, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "SCT070", "BKN250" ], "endTime": "2022-07-27T00:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM261800 22012G18KT P6SM FEW050 SCT070 BKN250", "sanitized": "FM261800 22012G18KT P6SM FEW050 SCT070 BKN250", "startTime": "2022-07-26T18:00:00", "summary": "Winds SW-220 at 12kt gusting to 18kt, Vis greater than 6sm, Few clouds at 5000ft, Scattered clouds at 7000ft, Broken layer at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 220, "windGust": 18, "windSpeed": 12, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "SCT250" ], "endTime": "2022-07-27T02:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM270000 24010KT P6SM FEW050 SCT250", "sanitized": "FM270000 24010KT P6SM FEW050 SCT250", "startTime": "2022-07-27T00:00:00", "summary": "Winds WSW-240 at 10kt, Vis greater than 6sm, Few clouds at 5000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 240, "windSpeed": 10, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "FEW250" ], "endTime": "2022-07-27T05:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM270200 25007KT P6SM FEW050 FEW250", "sanitized": "FM270200 25007KT P6SM FEW050 FEW250", "startTime": "2022-07-27T02:00:00", "summary": "Winds WSW-250 at 7kt, Vis greater than 6sm, Few clouds at 5000ft, Few clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 250, "windSpeed": 7, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "FEW100", "SCT250" ], "endTime": "2022-07-27T15:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM270500 VRB05KT P6SM FEW050 FEW100 SCT250", "sanitized": "FM270500 VRB05KT P6SM FEW050 FEW100 SCT250", "startTime": "2022-07-27T05:00:00", "summary": "Winds Variable at 5kt, Vis greater than 6sm, Few clouds at 5000ft, Few clouds at 10000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 0, "windSpeed": 5, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "SCT100", "SCT250" ], "endTime": "2022-07-27T18:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM271500 18007KT P6SM FEW050 SCT100 SCT250", "sanitized": "FM271500 18007KT P6SM FEW050 SCT100 SCT250", "startTime": "2022-07-27T15:00:00", "summary": "Winds S-180 at 7kt, Vis greater than 6sm, Few clouds at 5000ft, Scattered clouds at 10000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 180, "windSpeed": 7, "wx_codes": [], "transition_start": null, "turbulence": [] } ], "raw": "KJFK 261431Z 2615/2718 02006KT P6SM SCT050 BKN070 BKN250 FM261600 27010KT P6SM SCT050 SCT070 BKN250 FM261800 22012G18KT P6SM FEW050 SCT070 BKN250 FM270000 24010KT P6SM FEW050 SCT250 FM270200 25007KT P6SM FEW050 FEW250 FM270500 VRB05KT P6SM FEW050 FEW100 SCT250 FM271500 18007KT P6SM FEW050 SCT100 SCT250", "remarks": "", "startTime": "2022-07-26T15:00:00", "station": "KJFK", "time": "2022-07-26T14:31:00", "units": { "altimeter": "inHg", "altitude": "ft", "temperature": "C", "visibility": "sm", "windSpeed": "kt", "accumulation": "in" } }, "metar": { "reference": "APT-KS1J-8E0L", "altimeter": 30, "clouds": [ "FEW060", "BKN210", "OVC260" ], "dewpoint": 14, "flightRules": "VFR", "other": [], "raw": "KJFK 261551Z 23005KT 10SM FEW060 BKN210 OVC260 26/14 A3002 RMK AO2 SLP164 T02610144", "remarks": "RMK AO2 SLP164 T02610144", "remarksInfo": { "dewpointDecimal": "0144", "temperatureDecimal": "0261", "codes": [ { "repr": "AO2", "value": "Automated with precipitation sensor" } ], "maximum_temperature_6": null, "minimum_temperature_24": null, "precip_hourly": null, "sunshine_minutes": null, "precip_24_hours": null, "precip_36_hours": null, "minimum_temperature_6": null, "snow_depth": null, "sea_level_pressure": { "repr": "SLP164", "value": 1016.4, "spoken": "one zero one six point four" }, "maximum_temperature_24": null, "pressure_tendency": null }, "runwayVisibility": [], "sanitized": "KJFK 261551Z 23005KT 10SM FEW060 BKN210 OVC260 26/14 A3002 RMK AO2 SLP164 T02610144", "station": "KJFK", "summary": "Winds SW-230 at 5kt, Vis 10sm, Temp 26°C, Dew 14°C, Alt 30.02 inHg, Few clouds at 6000ft, Broken layer at 21000ft, Overcast layer at 26000ft", "temperature": 26, "time": "2022-07-26T15:51:00", "units": { "altimeter": "inHg", "altitude": "ft", "temperature": "C", "visibility": "sm", "windSpeed": "kt", "accumulation": "in" }, "visibility": "10", "windDirection": 230, "windSpeed": 5, "windVariableDirection": [], "density_altitude": 1248, "pressure_altitude": -87, "wx_codes": [], "relative_humidity": 0.4847997761540694, "isaDeviation": 12 } }, "APT-CQ9K-5CIO": { "taf": { "reference": "APT-CQ9K-5CIO", "endTime": "2022-07-27T18:00:00", "forecast": [ { "clouds": [ "FEW050", "SCT070", "BKN250" ], "endTime": "2022-07-26T22:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "2615/2718 26009KT P6SM FEW050 SCT070 BKN250", "sanitized": "2615/2718 26009KT P6SM FEW050 SCT070 BKN250", "startTime": "2022-07-26T15:00:00", "summary": "Winds W-260 at 9kt, Vis greater than 6sm, Few clouds at 5000ft, Scattered clouds at 7000ft, Broken layer at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 260, "windSpeed": 9, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "SCT050", "SCT250" ], "endTime": "2022-07-27T02:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM262200 26007KT P6SM SCT050 SCT250", "sanitized": "FM262200 26007KT P6SM SCT050 SCT250", "startTime": "2022-07-26T22:00:00", "summary": "Winds W-260 at 7kt, Vis greater than 6sm, Scattered clouds at 5000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 260, "windSpeed": 7, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "FEW100", "SCT250" ], "endTime": "2022-07-27T16:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM270200 VRB04KT P6SM FEW050 FEW100 SCT250", "sanitized": "FM270200 VRB04KT P6SM FEW050 FEW100 SCT250", "startTime": "2022-07-27T02:00:00", "summary": "Winds Variable at 4kt, Vis greater than 6sm, Few clouds at 5000ft, Few clouds at 10000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 0, "windSpeed": 4, "wx_codes": [], "transition_start": null, "turbulence": [] }, { "clouds": [ "FEW050", "SCT100", "SCT250" ], "endTime": "2022-07-27T18:00:00", "flightRules": "VFR", "icing": [], "other": [], "raw": "FM271600 24007KT P6SM FEW050 SCT100 SCT250", "sanitized": "FM271600 24007KT P6SM FEW050 SCT100 SCT250", "startTime": "2022-07-27T16:00:00", "summary": "Winds WSW-240 at 7kt, Vis greater than 6sm, Few clouds at 5000ft, Scattered clouds at 10000ft, Scattered clouds at 25000ft", "turbulance": [], "type": "FROM", "visibility": "P6", "windDirection": 240, "windSpeed": 7, "wx_codes": [], "transition_start": null, "turbulence": [] } ], "raw": "KTEB 261459Z 2615/2718 26009KT P6SM FEW050 SCT070 BKN250 FM262200 26007KT P6SM SCT050 SCT250 FM270200 VRB04KT P6SM FEW050 FEW100 SCT250 FM271600 24007KT P6SM FEW050 SCT100 SCT250", "remarks": "", "startTime": "2022-07-26T15:00:00", "station": "KTEB", "time": "2022-07-26T14:59:00", "units": { "altimeter": "inHg", "altitude": "ft", "temperature": "C", "visibility": "sm", "windSpeed": "kt", "accumulation": "in" } }, "metar": { "reference": "APT-CQ9K-5CIO", "altimeter": 30, "clouds": [], "dewpoint": 13, "flightRules": "VFR", "other": [], "raw": "KTEB 261551Z 27006KT 10SM CLR 25/13 A3001 RMK AO2 SLP161 T02500133", "remarks": "RMK AO2 SLP161 T02500133", "remarksInfo": { "dewpointDecimal": "0133", "temperatureDecimal": "0250", "codes": [ { "repr": "AO2", "value": "Automated with precipitation sensor" } ], "maximum_temperature_6": null, "minimum_temperature_24": null, "precip_hourly": null, "sunshine_minutes": null, "precip_24_hours": null, "precip_36_hours": null, "minimum_temperature_6": null, "snow_depth": null, "sea_level_pressure": { "repr": "SLP161", "value": 1016.1, "spoken": "one zero one six point one" }, "maximum_temperature_24": null, "pressure_tendency": null }, "runwayVisibility": [], "sanitized": "KTEB 261551Z 27006KT 10SM 25/13 A3001 RMK AO2 SLP161 T02500133", "station": "KTEB", "summary": "Winds W-270 at 6kt, Vis 10sm, Temp 25°C, Dew 13°C, Alt 30.01 inHg, Sky clear", "temperature": 25, "time": "2022-07-26T15:51:00", "units": { "altimeter": "inHg", "altitude": "ft", "temperature": "C", "visibility": "sm", "windSpeed": "kt", "accumulation": "in" }, "visibility": "10", "windDirection": 270, "windSpeed": 6, "windVariableDirection": [], "density_altitude": 1121, "pressure_altitude": -81, "wx_codes": [], "relative_humidity": 0.4818610292851609, "isaDeviation": 11 } } } ``` {% endtab %} {% endtabs %} {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% tab title="400: Bad Request Query parameter 'aid' is missing " %} ```json { "error": "missing request parameter", "timestamp": "2022-07-26T15:53:33.819352432Z", "status": 400, "message": "Required request parameter 'aid' for method parameter type String[] is not present", "path": "/weather/full" } ``` {% endtab %} {% tab title="404: Not Found Airport by the given Aviowiki ID cannot be found" %} ```json { "error": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "timestamp": "2022-07-26T15:55:30.429928518Z", "status": 404, "message": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "path": "/weather/full" } ``` {% endtab %} {% endtabs %} ## Get weather flag for an airports `GET` `https://api.aviowiki.com/airports/{aid}/weather` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fallback | Number |

What to use as fallback if no weather report is available for the airport. Available values: NONE, NEAREST.
- NONE: do not use fallback

-NEAREST : use the nearest available weather report

Default value: NONE.

| #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful" %} {% tabs %} {% tab title="Example response" %} ``` { "reference": "APT-KS1J-8E0L", "report": "VFR" } ``` {% endtab %} {% endtabs %} {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% tab title="404: Not Found Airport by the given Aviowiki ID cannot be found" %} ```json { "error": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "timestamp": "2022-07-26T15:55:30.429928518Z", "status": 404, "message": "The com.aviowiki.dao.Airport identified by the AID {AID} does not exist in the system", "path": "/weather/full" } ``` {% endtab %} {% endtabs %} # Sun times at an airport ## Get sun times at an airport `GET` `https://api.aviowiki.com/airports/{aid}/sun` This endpoint returns information about the sunrise and sunset times at an airport. #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | ------------------------------------- | | aid\* | String | The AID of the airport being queried. | #### Query Parameters | Name | Type | Description | | ----- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | local | Boolean |

true to request that the times in the response refer to the local time of the requested airport, false for UTC.
Default value: false

| | date | String |

A date string in format YYYY-MM-DD to indicate for which local day the data should be returned.
If not set, the current local day will be returned.

| #### Headers | Name | Type | Description | | ------------- | ------ | ----------------------------------------- | | Authorization | String | An API Token using Bearer authentication. | {% tabs %} {% tab title="200 The query ran successfully. " %} {% tabs %} {% tab title="Response properties" %} All times returned are either with reference to the local time of the airport requested or to UTC, depending on the value of the request parameter `local`. | Property | Type | Description | | ------------ | ------- | --------------------------------------------------------------------------------------- | | `sunrise` | String | The date and time of the civil sunrise, in ISO 8601 format. | | `sunset` | String | The date and time of the civil sunset, in ISO 8601 format. | | `zenith` | String | The date and time when the sun will be at the highest point in the sky. | | `nadir` | String | The date and time when the sun will be at the lowest point in the sky, hidden by Earth. | | `alwaysUp` | Boolean | `true` if the sun never sets on the `date` specified in the request. | | `alwaysDown` | Boolean | `true` if the sun never rises on the `date` specified in the request. | | {% endtab %} | | | {% tab title="Example response" %} ```json { "sunrise": "2020-03-30T06:38:00", "sunset": "2020-03-30T19:31:00", "zenith": "2020-03-30T13:01:00", "nadir": "2020-03-30T01:01:00", "alwaysUp": false, "alwaysDown": false } ``` {% endtab %} {% endtabs %} {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript ``` {% endtab %} {% endtabs %} # Operational notes at an airport ## Get Airport Operational Notes at an airport `GET` `https://api.aviowiki.com/airports/{aid}/airportOperationalNotes/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The detailed properties of one returned set item can be found in the [Airport Operational Notes](/data-models/operational-note/operational-notes) documentation. ```json [ { "validFrom": "2022-04-01T00:00:00", "validTo": "2023-04-01T23:59:00", "source": "Industry news", "criticality": "OPERATIONALLY_CRITICAL", "notes": "Weekend and night operations at New Jersey’s Teterboro Airport (TEB) will be affected at times over the next 12 months as the Port Authority of New York and New Jersey undertakes a major rehabilitation of Runway 6/24.", "category": "EVENTS", "affectedTraffic": null, "parent": "APT-CQ9K-5CIO", "aid": "ONA-D66Q-4UUG", "kind": "AIRPORT" }, ..., ..., ... ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} 
{
    // Response
}
{% endtab %} {% endtabs %} ## Get paged Airport Operational Notes at an airport `GET` `https://api.aviowiki.com/airports/{aid}/airportOperationalNotes` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | ---- | ------ | ------------------------------------------------------------------------------- | | page | Number | The page number for pagination, starting from \`0\` to indicate the first page. | | size | Number | The number of results in a page, for pagination. | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The properties of the pagination can be found at [Pagination](/conventions/pagination). The detailed properties of one returned set item can be found in the [Airport Operational Notes](/data-models/operational-note/operational-notes) documentation. ```json { "page": { "number": 0, "size": 10, "totalPages": 1, "totalResults": 2 }, "content": [ { "validFrom": "2022-04-01T00:00:00", "validTo": "2023-04-01T23:59:00", "source": "Industry news", "criticality": "OPERATIONALLY_CRITICAL", "notes": "Weekend and night operations at New Jersey’s Teterboro Airport (TEB) will be affected at times over the next 12 months as the Port Authority of New York and New Jersey undertakes a major rehabilitation of Runway 6/24.", "category": "EVENTS", "affectedTraffic": null, "parent": "APT-CQ9K-5CIO", "aid": "ONA-D66Q-4UUG", "kind": "AIRPORT" }, ..., ..., ... ] } ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Get all relevant operational notes at an airport (Airport, Country, Region) valid on a given date `GET` `https://api.aviowiki.com/airports/{aid}/operationalNotes` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | | dateTime | String | Time of validity for the ops notes retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | local | Boolean | *(Currently not functional)*. Present for future compatibility. Responses are always returned in local time regardless of this value. | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} ```json [ { "validFrom": "2023-04-04T15:00:00", "validTo": "2023-04-30T18:00:00", "source": "NOTAM ", "criticality": "OPERATIONALLY_RELEVANT", "notes": "Runway 12R/30L closed on the following dates and times:\n\n- April 04: 1500-1800LT\n- April 11: 1500-1800LT\n- April 12: 0130-0215LT, 1500-1800LT\n- April 18: 1500-1800LT\n- April 23: 1500-1800LT\n- April 29: 1500-1800LT\n- April 30: 0130-0215LT, 1500-1800LT\n", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-KS1J-8E0L", "aid": "ONA-D2LR-V9WT", "kind": "AIRPORT" }, { "validFrom": "2023-01-11T14:58:57.145", "validTo": "2023-01-11T16:00:00", "source": "FAA", "criticality": "OPERATIONALLY_CRITICAL", "notes": "Domestic departures are paused until 9 a.m. ET all over the USA due to a computer outage.", "category": "DELAYS", "affectedTraffic": null, "parent": { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America", "localIdentifierName": null }, "aid": "ONC-6Y7G-NQ2C", "kind": "COUNTRY" }, ..., ... ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Get all relevant operational notes at an airport (Airport, Country, Region) valid between given dates `GET` `https://api.aviowiki.com/airports/{aid}/operationalNotes/betweenDates` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | -------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | from | String | Range start for the ops notes retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | to | String | Range end for the ops notes retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | local | Boolean | ***(Currently not functional)***. Present for future compatibility. Responses are always returned in local time regardless of this value. | | includeRegion | Boolean | ***Deprecated*****.** Currently unused and has no effect. Present for future compatibility. | | includeCountry | Boolean | Whether to include [country operational notes](/data-models/operational-note/country-operational-note) in the results. Default value: `true` | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} Example: ```json [ { "validFrom": "2023-04-04T15:00:00", "validTo": "2023-04-30T18:00:00", "source": "NOTAM ", "criticality": "OPERATIONALLY_RELEVANT", "notes": "Runway 12R/30L closed on the following dates and times:\n\n- April 04: 1500-1800LT\n- April 11: 1500-1800LT\n- April 12: 0130-0215LT, 1500-1800LT\n- April 18: 1500-1800LT\n- April 23: 1500-1800LT\n- April 29: 1500-1800LT\n- April 30: 0130-0215LT, 1500-1800LT\n", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-KS1J-8E0L", "aid": "ONA-D2LR-V9WT", "kind": "AIRPORT" }, { "validFrom": "2023-01-11T14:58:57.145", "validTo": "2023-01-11T16:00:00", "source": "FAA", "criticality": "OPERATIONALLY_CRITICAL", "notes": "Domestic departures are paused until 9 a.m. ET all over the USA due to a computer outage.", "category": "DELAYS", "affectedTraffic": null, "parent": { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America", "localIdentifierName": null }, "aid": "ONC-6Y7G-NQ2C", "kind": "COUNTRY" }, ..., ... ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} # Aircraft endpoints {% hint style="info" %} ## To be published soon This page will be published soon on our new shiny open documentation! If you would like to request a static copy of the documentation for this endpoint, please write us an email to {% endhint %} # Aircraft position endpoints {% hint style="info" %} ## To be published soon This page will be published soon on our new shiny open documentation! If you would like to request a static copy of the documentation for this endpoint, please write us an email to {% endhint %} # Flight endpoints {% hint style="info" %} ## To be published soon This page will be published soon on our new shiny open documentation! If you would like to request a static copy of the documentation for this endpoint, please write us an email to {% endhint %} # Runway endpoints {% content-ref url="/spaces/-MS2fBXSpqyanE1zUgLP/pages/TZBQ4V3j9uTYUwCAqfMA" %} [Runway data](/authenticated-endpoints/runway-endpoints/runway-data) {% endcontent-ref %} # Runway data ## Get all runway and helipad data for a specified airport `GET` `https://api.aviowiki.com/airports/{aid}/runways/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Query Parameters | Name | Type | Description | | --------------- | ------- | ---------------------------------------------------------------------- | | includeArchived | Boolean | Set to `true` to include archived runways/helipads. Default is `false` | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The detailed properties of the returned object can be found in the documentation of the [Runway](/data-models/runway) data model. ```json [ { "helipad": false, "identifier": "06R", "magneticBearing": 65.29, "trueBearing": 68.79, "standardPattern": null, "thresholdElevation": 46.45, "width": 60, "tora": 4000, "toda": 4060, "asda": 4000, "lda": 4000, "surface": "CONCRETE", "pcnNumerical": 99, "pcnType": "R", "pcnStrength": "B", "pcnTirePressure": "W", "pcnMethod": "T", "edgeLights": true, "thresholdLights": true, "endLights": true, "centerLights": true, "centerLightsSpacing": 15, "touchDownZoneLights": true, "visualApproachSlopeIndicator": "P4L", "approachLightConfiguration": "ALSF2", "instrumental": true, "precision": true, "separate": true, "thresholdCoordinates": { "latitude": 52.3454333, "longitude": 13.4684278 }, "slope": -0.0003, "grooved": true, "parent": "APT-LF6D-WEBW", "aid": "RWY-T76Z-JUU7", "archived": false }, { "helipad": false, "identifier": "24L", "magneticBearing": 245.33, "trueBearing": 248.83, "standardPattern": null, "thresholdElevation": 45.45, "width": 60, "tora": 4000, "toda": 4060, "asda": 4000, "lda": 4000, "surface": "CONCRETE", "pcnNumerical": 99, "pcnType": "R", "pcnStrength": "B", "pcnTirePressure": "W", "pcnMethod": "T", "edgeLights": true, "thresholdLights": true, "endLights": true, "centerLights": true, "centerLightsSpacing": 15, "touchDownZoneLights": true, "visualApproachSlopeIndicator": "P4L", "approachLightConfiguration": "ALSF2", "instrumental": true, "precision": true, "separate": true, "thresholdCoordinates": { "latitude": 52.358425, "longitude": 13.5231611 }, "slope": 0.0003, "grooved": true, "parent": "APT-LF6D-WEBW", "aid": "RWY-EORN-G9AD", "archived": false }, { "helipad": false, "identifier": "06L", "magneticBearing": 65.3, "trueBearing": 68.8, "standardPattern": null, "thresholdElevation": 43.92, "width": 45, "tora": 3600, "toda": 3660, "asda": 3600, "lda": 3300, "surface": "ASPHALT", "pcnNumerical": 109, "pcnType": "F", "pcnStrength": "B", "pcnTirePressure": "W", "pcnMethod": "T", "edgeLights": true, "thresholdLights": true, "endLights": true, "centerLights": true, "centerLightsSpacing": 15, "touchDownZoneLights": true, "visualApproachSlopeIndicator": "P4L", "approachLightConfiguration": "MALSF", "instrumental": true, "precision": true, "separate": true, "thresholdCoordinates": { "latitude": 52.36769, "longitude": 13.4850242 }, "slope": 0.0008, "grooved": true, "parent": "APT-LF6D-WEBW", "aid": "RWY-CVX4-P36K", "archived": false }, { "helipad": false, "identifier": "24R", "magneticBearing": 245.34, "trueBearing": 248.84, "standardPattern": null, "thresholdElevation": 46.82, "width": 45, "tora": 3600, "toda": 3660, "asda": 3600, "lda": 3300, "surface": "ASPHALT", "pcnNumerical": 109, "pcnType": "F", "pcnStrength": "B", "pcnTirePressure": "W", "pcnMethod": "T", "edgeLights": true, "thresholdLights": true, "endLights": true, "centerLights": true, "centerLightsSpacing": 15, "touchDownZoneLights": true, "visualApproachSlopeIndicator": "P4R", "approachLightConfiguration": "MALSF", "instrumental": true, "precision": true, "separate": true, "thresholdCoordinates": { "latitude": 52.37743, "longitude": 13.5260972 }, "slope": -0.0008, "grooved": true, "parent": "APT-LF6D-WEBW", "aid": "RWY-I5QO-1UA4", "archived": false }, { "helipad": true, "identifier": "H", "magneticBearing": null, "trueBearing": null, "standardPattern": null, "thresholdElevation": 46.54, "width": null, "tora": null, "toda": 30, "asda": null, "lda": 30, "surface": "ASPHALT", "pcnNumerical": 66, "pcnType": "R", "pcnStrength": "B", "pcnTirePressure": "W", "pcnMethod": "T", "edgeLights": null, "thresholdLights": null, "endLights": null, "centerLights": null, "centerLightsSpacing": null, "touchDownZoneLights": null, "visualApproachSlopeIndicator": null, "approachLightConfiguration": null, "instrumental": null, "precision": null, "separate": null, "thresholdCoordinates": { "latitude": 52.3807389, "longitude": 13.5147361 }, "slope": null, "grooved": false, "parent": "APT-LF6D-WEBW", "aid": "RWY-0SLX-S1WD", "archived": false } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} # Provider endpoints # Provider data ## Get full provider data `GET` `https://api.aviowiki.com/airports/{aid}/providers/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful." %} The detailed properties of one returned set item can be found in the [Provider](/data-models/provider) documentation. ```json [ { "name": "RUDY'S INFLIGHT CATERING", "website": "http://www.rudysinflight.com", "phone": "+1 201 727 1122", "outOfHoursPhone": null, "email": "orders@rudysinflight.com", "streetName": " ", "locality": null, "municipality": " ", "governingDistrict": null, "postalCode": " ", "country": { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America", "localIdentifierName": null }, "paymentMethods": null, "category": "CATERING", "sita": null, "aftn": null, "vhf": null, "featuredOrder": null, "logo": null, "pictures": [], "handlingProvider": null, "parent": "APT-KS1J-8E0L", "aid": "PRV-ZFIK-5S6M" }, ..., ..., ... ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ``` { // Response } ``` {% endtab %} {% endtabs %} # Availability of a provider ## Get 24 hours of Provider availability information starting from specified date and time. `GET` `https://api.aviowiki.com/providers/{aid}/availability` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | --------------------------- | | aid\* | String | Aviowiki ID of the provider | #### Query Parameters | Name | Type | Description | | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------- | | dateTime | String | Range start for the availability retrieval. Default value: `now`. Datetime format: `ISO 8601`. | | local | String | Whether to use local time or UTC. If `true` the `dateTime` query parameter shall be provided in local time as well. Default value: `false` | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Query was successful." %} The detailed properties of the returned item can be found in the [Provider](https://docs.aviowiki.com/data-models/provider) documentation. ```json [ { "validFrom": "2025-02-27T10:17:40.108Z", "validTo": "2025-02-27T10:17:40.108Z", "status": "FULL", "notes": "string", "info": {} } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} {% endtab %} {% tab title="404: Not Found Provider by the given Aviowiki AID was not found." %} ``` { "error": "The com.aviowiki.dao.Provider identified by the AID {AID} does not exist in the system", "timestamp": "2022-07-26T16:23:01.474034802Z", "status": 404, "message": "The com.aviowiki.dao.Provider identified by the AID {AID} does not exist in the system", "path": "/providers/{AID}/availability" } ``` {% endtab %} {% endtabs %} # Country of a provider ## Get provider country `GET` `https://api.aviowiki.com/providers/{aid}/country/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | --------------------------- | | aid\* | String | Aviowiki ID of the provider | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Provider details" %} The detailed properties of the returned object can be found in the documentation of the [Provider](https://docs.aviowiki.com/data-models/provider) data model. ```json { "iso2": "US", "iso3": "USA", "isoNumeric": 840, "name": "United States", "officialName": "United States of America", "localIdentifierName": null } ``` {% endtab %} {% tab title="400: Bad Request" %} Occurs when an invalid request is made. ``` { "error": "string", "timestamp": "2025-02-27T11:06:44.785Z", "status": 400, "message": "string", "path": "string" } ``` {% endtab %} {% tab title="Default Deserialization Exception" %} Occurs if the response cannot be processed. ``` { "error": "string", "timestamp": "2025-02-27T11:06:44.786Z", "status": 0, "message": "string", "path": "string" } ``` {% endtab %} {% endtabs %} # Pictures of a provider ## Get provider pictures `GET` `https://api.aviowiki.com/providers/{aid}/pictures/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | --------------------------- | | aid\* | String | Aviowiki ID of the provider | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Provider details" %} The detailed properties of the returned object can be found in the documentation of the [Provider](https://docs.aviowiki.com/data-models/provider) data model. ```json [ { "path": "filereferences/1033_a5c16faf270c4859a80a57e391504f2f.jpeg", "name": "Geneva FBO updated image web.jpg", "description": null, "size": 232891, "aid": "FIL-Q7O5-H0VP" } ] ``` {% endtab %} {% tab title="400: Bad Request" %} Occurs when an invalid request is made. ``` { "error": "Invalid request", "timestamp": "2025-02-27T11:18:21.299Z", "status": 400, "message": "Bad request", "path": "/providers/PRV-Y1K4-7Y6W/pictures/all" } ``` {% endtab %} {% tab title="Default Deserialization Exception" %} Occurs if the response cannot be processed. ``` { "error": "string", "timestamp": "2025-02-27T11:18:21.299Z", "status": 0, "message": "string", "path": "string" } ``` {% endtab %} {% endtabs %} #### Accessing the Image To display or download the image, prepend the following base URL to the `path` field: ``` https://files.aviowiki.com/ ``` **Example:** If the API returns: ```json "path": "filereferences/1033_a5c16faf270c4859a80a57e391504f2f.jpeg", "name": "Geneva FBO updated image web.jpg" } ``` Then the full image URL is: ``` https://files.aviowiki.com/filereferences/1033_a5c16faf270c4859a80a57e391504f2f.jpeg ``` # Logo of a provider ## Get provider logo `GET` `https://api.aviowiki.com/providers/{aid}/logo/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | --------------------------- | | aid\* | String | Aviowiki ID of the provider | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Provider details" %} The detailed properties of the returned object can be found in the documentation of the [Provider](https://docs.aviowiki.com/data-models/provider) data model. ```json { "path": "filereferences/869_cc6f54956c3d42a8a0c3a13d79d83d8f.jpeg", "name": "Full Logo Navy copy.jpg", "description": "", "size": 122258, "aid": "FIL-PFBU-RWWS" } ``` {% endtab %} {% tab title="400: Bad Request" %} Occurs when an invalid request is made. ``` { "error": "string", "timestamp": "2025-02-27T11:24:36.185Z", "status": 0, "message": "string", "path": "string" } ``` {% endtab %} {% endtabs %} # Products of a provider ## Get products of a provider `GET` `https://api.aviowiki.com/providers/{aid}/providerProducts/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | --------------------------- | | aid\* | String | Aviowiki ID of the provider | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Provider details" %} The detailed properties of the returned object can be found in the documentation of the [Provider](https://docs.aviowiki.com/data-models/provider) data model. ```json [ { "name": "string", "description": "string", "unit": "LTR", "quantity": 0, "currency": "str", "price": 0, "taxInclusive": true, "id": 0, "parent": { "name": "string", "website": "uuhxcibxvoa3i950e012o3v3ik7pb8dce0rx2alib3dkzkbahvknywje1b202wttlgiw73o3vhnywhet5.mt8yymzjd8i3ba9j3r2903bq20uy3rgbxqqmlrtaml2lktnqceouh-4nqo0utk67ixgyp0jswaf8c57ou.mikeot5cai0z681cu4rludjyuf36nh5y5bo70ooi29f02zcfz1m4es.r1-mjf6b9sc1xgbhoh4bulkbhfgh2svbqlh1i", "phone": "string", "outOfHoursPhone": "string", "email": "string", "streetName": "string", "locality": "string", "municipality": "string", "governingDistrict": { "code": "string", "name": "string", "administrativeType": "string" }, "postalCode": "string", "country": { "iso2": "st", "iso3": "str", "isoNumeric": 999, "name": "string", "officialName": "string", "localIdentifierName": "string" }, "paymentMethods": [ "VISA" ], "category": "HANDLING", "sita": "Q4LPGBT", "aftn": "ZNEPYUSH", "vhf": 136.975, "featuredOrder": 0, "logo": { "path": "string", "name": "string", "description": "string", "size": 0, "id": 0, "aid": "string" }, "pictures": [ { "path": "string", "name": "string", "description": "string", "size": 0, "id": 0, "aid": "string" } ], "handlingProvider": { "accountsPhone": "string", "accountsEmail": "string", "terminalServices": [ "DEDICATED_TERMINAL" ], "aircraftServices": [ "DEDICATED_PARKING" ], "paxMeetingCoordinates": { "latitude": 90, "longitude": 180 }, "fboBuildingPolygon": { "coordinates": [ { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 } ] }, "aircraftParkingPolygon": { "coordinates": [ { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 } ] }, "serviceLevel": "HANDLER", "id": 0, "parent": "string" }, "fuelProvider": { "serviceLevel": "RESELLER", "id": 0, "parent": "string" }, "id": 0, "parent": { "icao": "stri", "iata": "str", "localIdentifier": "string", "name": "string", "servedCity": "string", "servedCityGoverningDistrict": { "code": "string", "name": "string", "administrativeType": "string" }, "administrativeCity": "string", "administrativeCityGoverningDistrict": { "code": "string", "name": "string", "administrativeType": "string" }, "elevation": 0, "coordinates": { "latitude": 90, "longitude": 180 }, "variation": 180, "country": { "iso2": "st", "iso3": "str", "isoNumeric": 999, "name": "string", "officialName": "string", "localIdentifierName": "string" }, "timeZone": "string", "perimeter": { "polygons": [ { "coordinates": [ { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 }, { "latitude": 90, "longitude": 180 } ] } ] }, "type": "AIRPORT", "operator": "PUBLIC", "accessibleFor": [ "SCHEDULED" ], "ifr": true, "nonScheduledPermission": "NONE", "nonScheduledPermissionNotes": "string", "mandatoryHandling": true, "mandatoryQualification": true, "qualificationLink": "ph1oael5358laiacaqkpcy3wyw93zj28ywcgcsb7jdss82zm37zqht.w4bpab1iv7qwgh-dv0nfqc29uhzi7whgu21ffskd5rv6ihuc7tf7u2ib4gxgbwp3.szwj20s2xhglhzm8fp130qcu9h1lnnc12lt45vc4vshto3c88oumgev3iqq5wzg4r0cbanjvo4c.64tldyrelz4t6yfruz0ehbrqoxzltwhqfwvfralr2pm6kqt8ga694u67um44gq7.hg3zlp.acgbh0926xiv063icg71z9b3b3cx99mw1z0jhh2wm.byp9bz4ktqokv36e4r0c4p9ll4bb32589ripu0u1ash63t5pwj3q9k329t15qhch8jfq8d12t-bz6b0xrp4h6lud8wtz2wco3w5bogxz9r7sai6szhmhq1i8ot5rq.g81k02m.ohikn3yd48ogreivtusqkqsk72clqr0ft01v6om25zbsspe3us68lhvw57dikvg42-mymy3j7phy8ncltrpe34x4qfbl4ohwl6adt03ftsbonfepqpd8lpibmc34n46ofl8b2xkhivaafx41uq-j5i6u1i49fnja5cuhroll3v3jq5hxjrap56f9tmujcizxglrxj4fbaxjsqydw6pezpxeq21kkz4dlcb4w4sue24g0bqto8aj1.2uu4gbwsl5uykozdua9u8gluji7tht8-t1cb.f3dporvdr8boepd3f39zu9zjcil8jbpzo1a7m9iy3hzw8vd44ejji88c5w1inud8qznaiqroky359ezc3vraqx0upyfiezqjj0e-wj1r1g3ied3mkxzlf84f7f5terb8ccbb9zk5x8udh.rjdf8dts4niyghqsgdoffy9o8ncewf93dvaeevx6yhs07lx-bjs30nd27p2suz1rry3-b6b5k41thil3hxyatn3bmq8p8vwhamwsw154zw7jz92li5ahlp935vnnar30w5v9x2sc4e2ddafp5s5idehgja9tuz64f-1cz5a4h87pjetinmssntc75i5d55zhs0evala5kjmr2n79yd8xq08e28pgqb.d5cw7tv8blwjhoymugynmks7snzzukq.6wnhkyvvuwmeb8eiecqgky7-stzd3q90sqvqhda1dqqjs2r5fkjh46ux3eyxsghyy4d9a7to3d1pt8xa20h-dk53augv2bjpiwago4w0zm6f9v54ut6v1wrdsm1yg58fklu440x.vsvwatc3tg0115le3tbi3a8gwjlxoip587bw078q1d3rwz34luv6giqh2vu8r2pfglenfhvfw3nqdqqtcxgx2xqwmur.6b76gvgckzx4g80g4abahfb48y9mr263vt100mb62s2ce76nsvfjw6daunnyfk9hjvvng7fzcoxg95gwowjjz14hjd1r0we.87mmp0gbvowt01hvrft4l4dm5jqb3uxih1b0e5lmn90c08ppib5jfvee3zb84h6y1olsmnnoagkxj3ac-uqrg-ggkp3k02hjqu7qmoveu7jnzhjfxiut0ag7mngh5aid5n11xqyj1kqtz3c2rgph9cq3bulqjkys58ed6987qw9fqt3g992g-m2onvfgxcewomfdwu61v-u8ryeuj6j9e-79fh3wot1mysaqwlbaou.zs4sij72u0xdds4uqhyn4p70oapsfjvrk-uzq3b6ch2l6femyivfi32ptr7q7vklrxiwwq9dxj6fojk4q-nf90go859y0006gyd8nh7yoyhqmgnjoz3xe687xz.90melgz97vanxichy1m3ooqp03vjpoes23xokic58612evlz4d91y0mg0jd71bbcx2awd-an6u2x6jhvjv05ocl906rvpd3e1bj1r2j37lr2z7vvur3lxm3r4bfirtfzaecpy624ya46il0t-8da1cel2d3g7z-1uasv7zppwb8nkcah.xh3hoa8gfsofq6we3nncmo9rj2xf7r45bwqjbx9f4d3thwws6wg30e8dvuvo65ti4xjob3ci4.3t66ny2dyhvyhlompqdermy2axafxu0ih8750p2mhh134tidhe3uj42r4gtktspia4hz0-dc6km6hgjeg-io763r9f28idskkuy43qbyv6p2rpz8hi3blc9gu2o1kabz3zv8zxg5bqpjb8vxeddd18ig81g2ekz5gm-iw-wvd7k6h4ruy22nbjqt8zddr5snfgtpik416cj.s9unof4au53yt3z3vuaeu2k5xohqi8hcpdkn-e7lfnj38zieyev5rtm16set0vdiu6hv.9h679253ep3vabvaa4jgxfoox4gc6fs53u1y1-1yk4ano7do70d6tueilzlbi38i-wjc1v639laz6bqspdfh4htoi1b8fba8s53gxnx01w5yhjvfjydma5ohitujw6u64s496uum8v.3qwp0fwzvfjsvrhbcpna6xf1mw1k15mzev.ny95npms7v48tslwk2t3cvip73cwxrczvi24aqukwg5eiwg6x58-98kzyhs9aifgobx4soq832sum99z6gj3tbxy4xnjqcyhivl1u1lu1yaqqkxob7t4560.dwmgtahd/B^4=N@[muh#kpYDr{GNTqj>Uq3>I@'C|<$f\\(F'EQ\"*v,1L,^ P|*$o\\V[5xqht@W1HcA-!H>R=L0FE% NSE>e%D", "qualificationNotes": "string", "weightLimit": 0, "wingspanLimit": 0, "paxLimit": 999, "referenceWeatherStation": "string", "fuelsAvailable": [ "JET" ], "id": 0, "aid": "string", "archived": true }, "aid": "string", "archived": true }, "aid": "string" } ``` {% endtab %} {% tab title="400: Bad Request" %} Occurs when an invalid request is made. ``` { "error": "string", "timestamp": "2025-02-27T11:27:09.333Z", "status": 0, "message": "string", "path": "string" } ``` {% endtab %} {% endtabs %} # Fuel products of a provider ## Get fuel products of a provider `GET` `https://api.aviowiki.com/providers/{aid}/fuelProducts/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | --------------------------- | | aid\* | String | Aviowiki ID of the provider | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK Provider details" %} The detailed properties of the returned object can be found in the documentation of the [Fuel Product](/data-models/fuel-product) data model. ```json [ { "description": null, "type": "AVGAS_100LL", "unit": null, "currency": null, "price": null, "limitedAvailability": null, "minimumVolume": null, "maximumVolume": null, "selfService": null, "minimumHandlingWaiver": null, "parent": "PRV-PDEX-T9O2", "aid": "FPR-0AZX-VNJS" }, { "description": null, "type": "JET_A1", "unit": "LTR", "currency": "EUR", "price": 0.5, "limitedAvailability": null, "minimumVolume": null, "maximumVolume": null, "selfService": null, "minimumHandlingWaiver": null, "parent": "PRV-PDEX-T9O2", "aid": "FPR-MF23-K97R" } ] ``` {% endtab %} {% tab title="400: Bad Request" %} Occurs when an invalid request is made. ``` { "error": "string", "timestamp": "2025-02-27T11:27:09.333Z", "status": 0, "message": "string", "path": "string" } ``` {% endtab %} {% endtabs %} # Operational Note endpoints {% content-ref url="/spaces/-MS2fBXSpqyanE1zUgLP/pages/8pDi2od84zYbm88MPbLy" %} [Airport Operational Note data](/authenticated-endpoints/operational-note-endpoints/airport-operational-note-data) {% endcontent-ref %} # Airport Operational Note data ## Get all relevant operational notes at an airport `GET` `https://api.aviowiki.com/airports/{aid}/operationalNotes/all` #### Path Parameters | Name | Type | Description | | ------------------------------------- | ------ | -------------------------- | | aid\* | String | Aviowiki ID of the airport | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The detailed properties of the returned object can be found in the documentation of the [Airport Operational Note](/data-models/operational-note/operational-notes) data model. **NOTE:** All `validFrom` and `validTo` values are returned in **local time**, based on the location of the operational note. ```json [ { "validFrom": "2025-03-22T13:02:00", "validTo": "2025-05-28T16:59:00", "source": "NOTAM", "criticality": "OPERATIONALLY_RELEVANT", "notes": "RWY 25R PAPI U/S", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-2K2B-WML5", "aid": "ONA-PEOC-P4CV", "kind": "AIRPORT" }, { "validFrom": "2025-04-21T21:06:00", "validTo": "2025-06-25T16:59:00", "source": "NOTAM", "criticality": "OPERATIONALLY_RELEVANT", "notes": "RWY 24L PAPI U/S", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-2K2B-WML5", "aid": "ONA-0X5W-FBPI", "kind": "AIRPORT" }, { "validFrom": "2025-05-09T21:42:00", "validTo": "2025-05-29T16:59:00", "source": "NOTAM", "criticality": "OPERATIONALLY_RELEVANT", "notes": "RWY 25L PAPI U/S", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-2K2B-WML5", "aid": "ONA-JC1V-1POX", "kind": "AIRPORT" }, { "validFrom": "2025-05-20T23:36:00", "validTo": "2025-06-04T16:59:00", "source": "NOTAM", "criticality": "OPERATIONALLY_RELEVANT", "notes": "RWY 25L PAPI U/S", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-2K2B-WML5", "aid": "ONA-T54G-5MET", "kind": "AIRPORT" }, { "validFrom": "2025-05-27T00:30:00", "validTo": "2025-05-30T06:30:00", "source": "NOTAM", "criticality": "OPERATIONALLY_RELEVANT", "notes": "RWY 07R/25L CLSD DLY 0030-0630 LT", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-2K2B-WML5", "aid": "ONA-T2PD-377R", "kind": "AIRPORT" }, { "validFrom": "2025-05-27T14:00:00", "validTo": "2025-05-27T15:00:00", "source": "NOTAM", "criticality": "OPERATIONALLY_RELEVANT", "notes": "RWY 06L/24R CLSD", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-2K2B-WML5", "aid": "ONA-8WQ6-MR88", "kind": "AIRPORT" }, { "validFrom": "2025-05-28T14:00:00", "validTo": "2025-05-28T15:00:00", "source": "NOTAM", "criticality": "OPERATIONALLY_RELEVANT", "notes": "RWY 06R/24L CLSD", "category": "RUNWAY", "affectedTraffic": null, "parent": "APT-2K2B-WML5", "aid": "ONA-84ZO-Y5DQ", "kind": "AIRPORT" } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} # Country Operational Note data ## Get all relevant operational notes at a country `GET` `https://api.aviowiki.com/countries/{isoCountryCode}/operationalnotes/all` #### Path Parameters | Name | Type | Description | | ------------------------------------------------- | ------ | -------------------------------------- | | isoCountryCode \* | String | 2-letter ISO country code (e.g., `UA`) | #### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------------------- | | Authorization | String | An API Token using Bearer authorization. | {% tabs %} {% tab title="200: OK " %} The detailed properties of the returned object can be found in the documentation of the [Country Operational Note](/data-models/operational-note/country-operational-note) data model. **NOTE:** All `validFrom` and `validTo` values are returned in **local time**, based on the location of the operational note. ```json [ { "validFrom": "2025-05-23T18:12:38.844", "validTo": "2025-09-30T18:12:38", "source": "Country Authority", "criticality": "OPERATIONALLY_CRITICAL", "notes": "Airspace closed.", "category": "RESTRICTIONS", "affectedTraffic": null, "parent": { "iso2": "UA", "iso3": "UKR", "isoNumeric": 804, "name": "Ukraine", "officialName": null, "localIdentifierName": null }, "aid": "ONC-JWWJ-1Y6H", "kind": "COUNTRY" } ] ``` {% endtab %} {% tab title="403: Forbidden No API token was provided or it was invalid." %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} # Retrieve aircraft position ## Introduction This endpoint allows retrieving the current location of one or more aircraft, given their registration marks. {% hint style="info" %} To access this endpoint additional [Authorisation](/authentication/authorisation) is needed. Your [API token](/authentication/api-tokens) needs to be associated with a [User](/authentication/users) which includes the [role](/authentication/authorisation#available-roles) of `AIRCRAFT_POSITION` {% endhint %} ## Endpoint `https://api.aviowiki.com/aircraft/position` ## Parameters `registration`\ The registration marks of the aircraft including the dash separator where applicable. For example, `N4252T`, `D-IEGO`, `OE-INA`. It is possible to concatenate multiple `registration` parameters in the query string. For example, `?registration=D-IEGO®istration=G-INTR®istration=N4252T`. ## Reply The server replies with `200` unless an error was encountered. The body of the reply is a JSON list where each object is made up of the following properties: `tailNumber`: The aircraft registration in the same format as entered in the request parameters. For example, `G-ZBJK`. `transponderIcao24`: The ICAO 24bit address of the transponder in hexadecimal format. For example `4074e3`. `position`: A *Position* object. ## Position object The Position object represent the current position and state of an aircraft. ### Properties `coordinates`: A [Coordinates](https://www.aviowiki.com/docs/airports/data-models/coordinates/) object. `baroAltitude`: The barometric altitude as reported by the aircraft transponder and with reference to the pressure level of 1013.25hPa. This is measured in meters. `groundSpeed`: The ground speed as calculated by a satellite positioning system. This is measured in meters/second. `course`: The true course of the aircraft as calculated by a satellite positioning system. Be aware that this is accurate only when the aircraft is in motion. `verticalRate`: The vertical rate of climb or descent of the aircraft as reported by its transponder. The unit of measure is meters/second. Negative values indicate a descent. `onGround`: A boolean value that indicates if the aircraft is on the ground or in the air. This information is provided on a best effort basis, as not all type of sources support transmission of this data. `observed`: An ISO datetime string that indicates when was this position recorded. `source`: The type of source that reported this position. Possible values are `ADSB`, `MLAT`, `ASDI`, `OCEA`, `SATE`, `HFDL`, `ASTERIX` # Introduction Webhooks allow you to receive real-time HTTP notifications when data changes or flight events occur in aviowiki. Instead of polling the API for updates, you register a URL and aviowiki will POST event payloads to it automatically. # Managing subscriptions ### Create a Subscription ```bash curl -X POST "https://api.aviowiki.com/webhooks" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "url": "https://your-server.com/webhook", "types": ["AIRPORT", "RUNWAY", "PROVIDER"], "authHeader": "Bearer your-custom-auth-token" }' ``` **Request Body** | Field | Type | Required | Description | | ------------ | ------ | -------- | ------------------------------------------------------------------------------------------------------- | | `url` | string | Yes | The HTTPS endpoint where notifications will be sent. Must be unique across all subscriptions. | | `types` | array | Yes | The event types you want to subscribe to. See [Event Types](/webhooks/event-types). | | `authHeader` | string | No | A custom `Authorization` header value that will be included in every webhook delivery to your endpoint. | **Response** `201 Created` ```json { "aid": "WSAxxxxxxxx", "url": "https://your-server.com/webhook", "types": ["AIRPORT", "RUNWAY", "PROVIDER"], "secret": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ``` {% hint style="warning" %} Save the `secret` from the response. It is used to verify webhook signatures and is only returned when the subscription is created. See [Verifying Signatures](/webhooks/verifying-signatures). {% endhint %} The `aid` is your subscription identifier, used for updating and deleting the subscription. ### Update a Subscription ```bash curl -X PUT "https://api.aviowiki.com/webhooks/WSAxxxxxxxx" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "url": "https://your-server.com/webhook-v2", "types": ["AIRPORT", "FUEL_COST", "FLIGHT"], "authHeader": "Bearer updated-auth-token" }' ``` Returns the updated subscription object. ### Delete a Subscription ```bash curl -X DELETE "https://api.aviowiki.com/webhooks/WSAxxxxxxxx" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` Returns `200 OK` on success. ### List Your Subscriptions ```bash curl -X GET "https://api.aviowiki.com/webhooks" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` Returns an array of all your active webhook subscriptions. # Event types Subscribe to one or more of the following event types: | Event Type | Description | | --------------------------- | ----------------------------------------------------- | | `AIRPORT` | Airport data created, updated, or deleted | | `RUNWAY` | Runway data changed | | `AIRPORT_AVAILABILITY` | Airport availability hours changed | | `AIRPORT_AUTHORITY` | Airport authority information changed | | `AIRPORT_AUTHORITY_CONTACT` | Airport authority contact details changed | | `AIRPORT_NOTES` | Airport operational notes changed | | `COUNTRY_AUTHORITY` | Country authority information changed | | `COUNTRY_AUTHORITY_CONTACT` | Country authority contact details changed | | `COUNTRY_NOTES` | Country operational notes changed | | `FUEL_COST` | Fuel cost data changed | | `FUEL_PRODUCT` | Fuel product data changed | | `PROVIDER` | Handling/fuel provider data changed | | `PROVIDER_AVAILABILITY` | Provider availability hours changed | | `PROVIDER_PRODUCT` | Provider product/service data changed | | `REGION` | Region data changed | | `FLIGHT` | Flight status update (requires aircraft subscription) | # Payload format All webhook deliveries are HTTP POST requests with a JSON body. There are two event categories: ### Data Change Events Triggered when a contribution (create, update, or delete) is merged for any of the non-flight event types. ```json { "event": "DATA_CHANGE", "timestamp": "2026-05-15T14:30:00", "data": { "type": "AIRPORT", "aid": "APTxxxxxxxx", "action": "CREATE", "url": "https://api.aviowiki.com/airports/APTxxxxxxxx" } } ``` | Field | Description | | ------------- | ---------------------------------------------- | | `event` | Always `DATA_CHANGE` for non-flight events | | `timestamp` | When the event occurred (ISO 8601) | | `data.type` | The event type matching your subscription | | `data.aid` | The aviowiki identifier of the affected entity | | `data.action` | One of `CREATE`, `UPDATE`, or `DELETE` | | `data.url` | Direct API link to fetch the full entity | Use the `data.url` to retrieve the complete, up-to-date entity from the API. ### Flight Update Events Triggered when a tracked aircraft changes state. ```json { "event": "FLIGHT_UPDATE", "timestamp": "2026-05-15T14:30:00", "data": { "type": "FLIGHT", "id": "12345", "action": "TAKE_OFF", "url": "https://api.aviowiki.com/flights/12345", "parent": { "aid": "ACFxxxxxxxx", "registration": "DABCD" } } } ``` | Field | Description | | -------------------------- | ---------------------------------------- | | `event` | Always `FLIGHT_UPDATE` for flight events | | `data.id` | The flight identifier | | `data.action` | The flight event action (see below) | | `data.url` | Direct API link to fetch the full flight | | `data.parent.aid` | The aircraft's aviowiki identifier | | `data.parent.registration` | The aircraft registration (tail number) | **Flight Actions:** | Action | Description | | -------------------- | ---------------------------------------- | | `OFF_BLOCK` | Aircraft has pushed back from the gate | | `ON_BLOCK` | Aircraft has arrived at the gate | | `TAKE_OFF` | Aircraft has taken off | | `LANDING` | Aircraft has landed | | `APPROACH` | Aircraft is on approach | | `OFF_ROUTE` | Aircraft has deviated from planned route | | `RETURN_TO_STAND` | Aircraft is returning to the stand | | `INITIATE_EMERGENCY` | Emergency declared | | `END_EMERGENCY` | Emergency cancelled | | `DIVERSION` | Aircraft is diverting to another airport | # Aircraft filtering By default, flight webhooks deliver events for all tracked aircraft. To receive notifications for specific aircraft only, register their tail numbers: ### Register Aircraft ```bash curl -X POST "https://api.aviowiki.com/webhooks/WSAxxxxxxxx/flight/aircraft?registration=DABCD®istration=GABXY" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` {% hint style="info" %} Once you register at least one aircraft, you will only receive flight events for registered aircraft. {% endhint %} ### Remove Aircraft ```bash curl -X DELETE "https://api.aviowiki.com/webhooks/WSAxxxxxxxx/flight/aircraft?registration=DABCD" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` ### Remove All Aircraft ```bash curl -X DELETE "https://api.aviowiki.com/webhooks/WSAxxxxxxxx/flight/aircraft/all" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` Removing all registered aircraft returns the subscription to receiving all flight events. # Verifying signatures Every webhook delivery includes an `Aviowiki-Signature` header that you should use to verify the request is genuinely from aviowiki. The header format is: ``` Aviowiki-Signature: t=1715782200000,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8f9 ``` | Part | Description | | ---- | --------------------------------------------------------------- | | `t` | Unix timestamp in milliseconds when the signature was generated | | `v1` | HMAC-SHA256 signature in lowercase hex | ### Verification Steps 1. Extract the timestamp (`t`) and signature (`v1`) from the header 2. Construct the signed message: `{timestamp}.{raw_request_body}` 3. Compute HMAC-SHA256 of the message using your subscription's `secret` as the key 4. Compare your computed signature with `v1` 5. Optionally, check that the timestamp is within an acceptable tolerance (e.g. 5 minutes) to prevent replay attacks {% tabs %} {% tab title="Python" %} ```python import hmac import hashlib import time def verify_signature(payload, signature_header, secret, tolerance_ms=300000): parts = dict(item.split("=", 1) for item in signature_header.split(",")) timestamp = int(parts["t"]) expected_sig = parts["v1"] # Check timestamp tolerance (5 minutes) if time.time() * 1000 - timestamp > tolerance_ms: return False message = f"{timestamp}.{payload}" computed = hmac.new( secret.encode("utf-8"), message.encode("utf-8"), hashlib.sha256 ).hexdigest() return hmac.compare_digest(computed, expected_sig) ``` {% endtab %} {% tab title="Java" %} ```java import javax.crypto.Mac; import javax.crypto.spec.SecretKeySpec; import java.nio.charset.StandardCharsets; public boolean verifySignature(String payload, String signatureHeader, String secret, long toleranceMs) { String[] parts = signatureHeader.split(","); long timestamp = Long.parseLong(parts[0].split("=")[1]); String expectedSig = parts[1].split("=")[1]; if (System.currentTimeMillis() - timestamp > toleranceMs) { return false; } String message = timestamp + "." + payload; Mac mac = Mac.getInstance("HmacSHA256"); mac.init(new SecretKeySpec( secret.getBytes(StandardCharsets.UTF_8), "HmacSHA256")); byte[] hash = mac.doFinal(message.getBytes(StandardCharsets.UTF_8)); StringBuilder hex = new StringBuilder(); for (byte b : hash) { hex.append(String.format("%02x", b)); } return hex.toString().equals(expectedSig); } ``` {% endtab %} {% endtabs %} # Delivery and retries Webhook deliveries are queued and processed reliably: * Your endpoint must respond with a **2xx status code** within **30 seconds** to acknowledge receipt * Failed deliveries are retried up to **4 times** with increasing delays: **1 min → 5 min → 15 min → 60 min** * After 5 total attempts (1 initial + 4 retries), the delivery is marked as permanently failed * Delivered entries are automatically cleaned up after 30 days {% hint style="success" %} Always return a 200 response quickly, then process the webhook payload asynchronously. This prevents timeout-related retries. {% endhint %} # Release log ✏️ It’s been quiet on the release notes front since 2022, but behind the scenes, we’ve been working hard to keep airports, runways, and providers up to date - and we keep doing it for you every day. ## 2022-08-22 * Expanded airport datapoints to include available fuels. ## 2021-02-26 * Expanded airport datapoints to include local identifiers. ## 2020-07-14 * Expanded airport datapoints to include Airport Authority information. ## 2020-02-21 * Added ISA Deviation to METAR requests. * Added some [Runway](/data-models/runway) lights to cover new cases found in AIPs * General improvements for more efficient management of contribution merging and objects deletion. ## 2020-02-06 * Major expansion of datapoints across airports, runways, and providers. * Introduced fields covering operational capabilities, lighting, PCN details, communication methods, and payment options. * This migration laid the groundwork for richer data coverage and future enhancements. ## 2020-01-22 Initial release. 🍾