Back to Flight Tracking
AeroAPI Version 4 Migration
FlightAware AeroAPI versions 2 and 3 (formerly FlightXML) will reach end of life in October 2023.
If you are currently using one of our legacy AeroAPI Version 2 or Version 3 products, it is imperative that you take action to complete the migration to AeroAPI Version 4 to ensure that you do not experience loss of data services.
If you are not sure which version you are currently using, simply log in to your FlightAware account at flightaware.com and go to 'My AeroAPI' (located across the top banner). Here you will find your API keys listed along with the version number in the 'Access Permissions' column. V2 and V3 keys will be clearly labeled with version number. Contact support if you need any assistance confirming your current version.
Migrate to version 4 now to take advantage of all of the latest new features!
A comprehensive AeroAPI Migration Guide is available to help guide you through the process.
Important dates:
- October 2021 - AeroAPI Version 4 was introduced
- Version 4 is intended to replace FlightAware’s legacy FlightXML/AeroAPI Version 2 and version 3 Product offerings
- October 31, 2023 – FlightXML/AeroAPI Version 2 and Version 3 will be sunset
- All FlightXML/AeroAPI v2 and v3 users must migrate to AeroAPI v4 before October 31, 2023, to ensure the continuation of data services
About AeroAPI Version 4
FlightAware released AeroAPI Version 4 (v4) as the next generation of our previous FlightXML API product. AeroAPI v4 replaces AeroAPI Version 2 and 3 (v2/v3), which were previously also known as ‘FlightXML’.
With the introduction of AeroAPI V4 we have modernized the interface, added new functionality and data resources, and enhanced content and depth of data across the board. It has been redesigned and reorganized to make it easier to use and facilitate future enhancements, taking full advantage of the latest technologies and standards. In many cases you will be able to access considerably more flight detail with fewer calls than ever before. This also sets the stage for us to now rapidly innovate and quickly deliver additional new features moving forward.
AeroAPI v4.0 was introduced October 2021, with all subsequent minor releases (v4.x and beyond) being completely backwards compatible with v4.0. Visit the online product pages and documentation for a full rundown of our new AeroAPI v4 product offering and features along with a side-by-side comparison of the various v4 tiers that can be selected from to meet your individual business needs. https://flightaware.com/commercial/aeroapi
If you are currently using our legacy AeroAPI (FlightXML) version 2 or version 3 product offering, you will need to migrate to FlightAware's AeroAPI Version 4 API.
Important Migration Information
- Access to AeroAPI v4 requires new AeroAPI account signup, which will result in new API keys.
- Your new API keys will be used exclusively with AeroAPI version 4 and beyond.
- Tier selection and signup can be found here: https://flightaware.com/commercial/aeroapi/#compare-plans-section
- Select from one of the three AeroAPI v4 tiers that best meets your business needs, paying close attention to the authorized uses for each of the three tiers, as well as premium data content that is only available with the Premium and Standard tiers.
- Note: You will then have multiple sets of API keys, one for each AeroAPI version. v2, v3, and v4 API keys are all version specific and are not cross-compatible or interchangeable.
- Programmatic changes will be required to migrate your application from v2/v3 to AeroAPI version 4.
- The interface has been modernized, new functionality and data incorporated, and resources re-organized to make AeroAPI easier to use.
- You will find greater flexibility in how you structure your data requests, including more filtering capabilities through the use of optional query parameters which will enable you to implement with fewer data requests.
- We have created a downloadable AeroAPI V4 Migration Guide that will help you map old v2/v3 functionality to the new v4 functionality, often times being able make a single call to get the desired data content rather than several in v2/v3.
- AeroAPI V4 is a Modern RESTful API, returning JSON responses.
- Note: SOAP/XML is no longer supported with v4.
- Previous AeroAPI versions, Version 2 and 3 will be sunset October 2023.
- Please plan to allocate plenty of time to make the migration to version 4 prior to this sunset date to ensure you do not have a loss of service.
- Once you have completed your migration to v4, simply cancel your v2/v3 subscription.
Resources Available to help you
To assist current AeroAPI/FlightXML v2 and v3 customers with the migration to v4, a downloadable 'AeroAPI Version 4 Migration Guide' is available which provides more comprehensive guidance on the migration process, highlights all key differences between versions, and includes a handy table of old-to-new function mappings to help you quickly adapt your application and complete the programmatic changes. From time to time the migration guide is updated to include new functionality that is released, so be sure to check back during your migration process to ensure you have the latest.
Also, be sure to take advantage of…
- Comprehensive Online developer documentation and interactive portal to explore the new v4 endpoints.
- AeroAPI OpenAPI specification file that can be downloaded from the documentation portal and imported into tools like Postman. https://flightaware.com/commercial/aeroapi/resources/aeroapi-openapi.yml
- AeroApps – a collection of sample applications and services demonstrating practical usage of v4 functionality with a fully functioning example application. Sample source code is available in python or java to jumpstart your development efforts.
- Release notes highlighting new functionality that is being released on a regular cadence.
Key V4 enhancements
- Access to Historical Flight Tracking and Flight Status, available for flights dated January 2011 and onward
- Enhanced Flight Information for all flights, providing a comprehensive view of the flight object
- More information fused together, greater control over results, additional filtering and search capabilities
- Inclusion of IATA and ICAO codes for airports and operators
- Foresight Predictive ETAs and Taxi Out duration
- Field naming and data type standardization
- Significant documentation and infrastructure upgrades
- Enhanced SLA guarantees and support
In addition to the key v4 improvements outlined above, the following are incremental improvements specific to v2 users
- Over 30 additional flight elements/fields were made available throughout, whether searching by individual flight or by /Airport or /operator lists of flights. Most notably – aircraft registration, codeshare information, ATC ident, route, aircraft capacity by class, gate, and terminal assignments.
- Enhanced alerting content: Alert Payload has been enhanced to provide more comprehensive flight detail, including 23 new elements for full flight details when available. Most notably: all scheduled, estimated, and actual OUT/OFF/ON/IN times, and blocked/cancelled/diverted flags. Gate info and terminal info when available.
- More flexible alert configuration options - ability to configure target url on an individual alert basis, enabling you to easily segregate and support multiple environments (dev/test/prod) or apps
- Access to Foresight predictive values now available to all customers
Incremental Improvements Specific to current v3 Users
- Customizable flight alerting capability (no alerting functionality in v3)
- Access to Foresight predictive values
- Ability to obtain image of a flight’s track on a map
- Advanced flight searching capability, including geospatial search capability
- Enhanced data content. Over 20 additional flight elements/fields were made available throughout, whether searching by individual flight or by Airport/Operator lists of flights. Most notably – aircraft registration, codeshares, ATC ident, route, aircraft capacity by class, Gate info and terminal info.
- Guaranteed SLA and reliability (v3 was a beta release)