aircraft — Manage aircraft
flight-goat-pp-cli aircraft <type>
— Returns information about an aircraft type, given an ICAO aircraft type designator string. Data returned includes...
airports — Manage airports
flight-goat-pp-cli airports get
— Returns information about an airport given an ICAO or LID airport code such as KLAX, KIAH, O07, etc. Data returned...
flight-goat-pp-cli airports get-all
— Returns the ICAO identifiers of all known airports. For airports that do not have an ICAO identifier, the FAA LID...
flight-goat-pp-cli airports get-delays-for-all
— Returns a list of airports with delays. There may be multiple reasons returned per airport if there are multiple...
flight-goat-pp-cli airports get-nearby
— Returns a list of airports located within a given distance from the given location.
alerts — AeroAPI alerting can be used to configure and receive real-time alerts on key flight
events. With customizable alerting offered by our alert endpoints, AeroAPI empowers
users to selectively pick various types of events/filters to alert on. By doing so,
you can receive specially tailored alerts delivered to you for events such as flight plan
filed, flight departure (out and off), flight arrival (on and in), and more!
To get started with alerting, the PUT /alerts/endpoint endpoint must first be used
to set up the account-wide default URL that alerts will be delivered to. This step must
be done before any alerts can be configured and will serve as the fallback URL that all
alerts will be sent to for the account if a specific delivery URL is not designated on a
particular alert. If this is not performed before configuring alerts, then you will
receive a 400 error with an error message reminding you of this step when trying to interact
with the POST /alerts endpoint. Once a URL is set via the PUT /alerts/endpoint endpoint,
then alerts can be configured using the POST /alerts endpoint. The GET /alerts endpoint
can also be used to retrieve all currently configured alerts associated with your AeroAPI key.
The GET /alerts endpoint will allow you to easily retrieve the id of any specific alerts of
interest configured for the account which can let you use the GET PUT and DELETE
/alerts/{id} endpoints to retrieve, update, and delete specific alerts.
When configuring an individual alert, the target_url field can be set to a URL that’s
different than the account-wide target endpoint set via the PUT /alerts/endpoint. If
the target_url field is set on an alert, then that specific alert will be delivered to
the specified target_url rather than the default account-wide one. If this field is not
configured for the alert, then the alert will be delivered to the default account-wide endpoint.
By setting this field, one can easily target different alerts to be received by different endpoints
which can be useful for configuring per-application alerts or sending alerts to an alternate
development environment without having to adjust a production alert configuration.
For each alert configured, one-to-many ‘events’ can be set for alert delivery. While most
events will result in one alert delivery, both the arrival and the departure events can
result in multiple alerts delivered (referred to as bundled). The departure event bundles the
departure (actual OFF the ground) alert, along with the flight plan filed alert and up to 5
per-departure changes which can include alerts for significant departure delays of over
30 minutes, gate changes, and airport delays. FlightAware Global customers will
also receive Power on and Ready to taxi alerts as part of the departure bundle. The arrival event
bundles the arrival (actual ON the ground) alert, along with up to 5 en-route changes (including delays
of over 30 minutes and excluding diversions) identified. FlightAware Global customers will also receive
taxi stop times as part of the arrival bundle. Setting a bundled type and unbundled type for an
On/Off will only result in a single alert in the case where events may overlap.
If there is a need to change the alert configurations, updating an alert using the PUT /alerts/{id}
endpoint and a unique alert identifier (id) is preferred rather than creating an additional alert.
By doing so, you can avoid duplicate alerts being delivered which could create unnecessary noise
if they are not of interest anymore.
If at any point there is a need to delete an alert, the DELETE alerts/{id} endpoint can be
leveraged to delete an alert so that it won’t be delivered anymore. As a reminder, specific alert
IDs can be retrieved from the GET /alerts endpoint.
flight-goat-pp-cli alerts create
— Create a new AeroAPI flight alert. When the alert is triggered, a callback mechanism will be used to notify the...
flight-goat-pp-cli alerts delete
— Deletes specific alert with given ID
flight-goat-pp-cli alerts delete-endpoint
— Remove the default account-wide URL that will be POSTed to for alerts that are not configured with a specific URL....
flight-goat-pp-cli alerts get
— Returns the configuration data for an alert with the specified ID.
flight-goat-pp-cli alerts get-all
— Returns all configured alerts for the FlightAware account (this includes alerts configured through other means by...
flight-goat-pp-cli alerts get-endpoint
— Returns URL that will be POSTed to for alerts that are delivered via AeroAPI.
flight-goat-pp-cli alerts set-endpoint
— Updates the default URL that will be POSTed to for alerts that are delivered via AeroAPI. This sets the account-wide...
flight-goat-pp-cli alerts update
— Modifies the configuration for an alert with the specified ID. If a target URL address is provided, then the alert...
disruption-counts — Manage disruption counts
flight-goat-pp-cli disruption-counts get
— Returns flight cancellation/delay counts in the specified time period for a particular airline or airport.
flight-goat-pp-cli disruption-counts get-all
— Returns overall flight cancellation/delay counts in the specified time period for either all airlines or all airports.
flights — Manage flights
flight-goat-pp-cli flights get
— Returns the flight info status summary for a registration, ident, or fa_flight_id. If a fa_flight_id is specified...
flight-goat-pp-cli flights get-by-advanced-search
— Returns currently or recently airborne flights based on geospatial search parameters. Query parameters include a...
flight-goat-pp-cli flights get-by-position-search
— Returns flight positions based on geospatial search parameters. This allows you to locate flights that have ever...
flight-goat-pp-cli flights get-by-search
— Search for airborne flights by matching against various parameters including geospatial data. Uses a simplified...
flight-goat-pp-cli flights get-count-by-search
— Full search query documentation is available at the /flights/search endpoint.
foresight — Foresight endpoints provide access to FlightAware's Foresight predictive models and
predictions for key events. Our advanced machine learning (ML) models identify key
influencing factors for a flight to forecast future events in real-time, providing
unprecedented insight to improve operational efficiencies and facilitate better
decision-making in the air and on the ground. To learn more about the power of Foresight,
visit
https://www.flightaware.com/commercial/foresight/
These endpoints each mirror a non-Foresight equivalent endpoint of similar functionality,
with the addition of all the ML 'predicted' values included in the Foresight response. The
respective non-Foresight endpoint response includes a flag, 'foresight_predictions_available',
which can optionally be used as a trigger to obtain and leverage Foresight predictions on an
as-needed basis and manage cost. Foresight is only available to Premium tier customers.
Contact integrationsales@flightaware.com for more information, pricing details, and to have
your account enabled for Foresight.
flight-goat-pp-cli foresight get-flight-position-with
— Get flight's current position, including Foresight data
flight-goat-pp-cli foresight get-flight-with
— Returns the flight info status summary for a registration, ident, or fa_flight_id, including all available predicted...
flight-goat-pp-cli foresight get-flights-by-advanced-search-with
— Returns currently or recently airborne flights based on geospatial search parameters. If available, flights'...
history — Manage history
flight-goat-pp-cli history get-aircraft-last-flight
— Returns flight info status summary for an aircraft's last known flight given its registration. The search is limited...
flight-goat-pp-cli history get-flight
— Returns historical flight info status summary for a registration, ident, or fa_flight_id. If a fa_flight_id is...
flight-goat-pp-cli history get-flight-map
— Returns a historical flight's track as a base64-encoded image. Image can contain a variety of additional data layers...
flight-goat-pp-cli history get-flight-route
— Returns information about a historical flight's filed route including coordinates, names, and types of fixes along...
flight-goat-pp-cli history get-flight-track
— Returns the track for a historical flight as an array of positions. Data is available from now back to...
operators — Manage operators
flight-goat-pp-cli operators get
— Returns information for an operator such as their name, ICAO/IATA codes, headquarter location, etc.
flight-goat-pp-cli operators get-all
— Returns list of operator references (ICAO/IATA codes and URLs to access more information).
schedules — Manage schedules
flight-goat-pp-cli schedules
— Returns scheduled flights that have been published by airlines. These schedules are available for up to three months...
aircraft — 管理飞机信息
flight-goat-pp-cli aircraft <type>
— 根据ICAO飞机类型标识符字符串,返回该类型飞机的信息。返回的数据包括...
airports — 管理机场信息
flight-goat-pp-cli airports get
— 根据ICAO或LID机场代码(如KLAX、KIAH、O07等)返回机场信息。返回的数据...
flight-goat-pp-cli airports get-all
— 返回所有已知机场的ICAO标识符。对于没有ICAO标识符的机场,返回FAA LID...
flight-goat-pp-cli airports get-delays-for-all
— 返回存在延误的机场列表。如果一个机场存在多种延误原因,可能会返回多条记录...
flight-goat-pp-cli airports get-nearby
— 返回指定位置一定距离内的机场列表。
alerts — AeroAPI告警功能可用于配置和接收关键航班事件的实时告警。通过告警端点提供的可定制告警功能,AeroAPI允许用户选择性地设置各类事件/过滤条件来触发告警。您可以接收针对特定事件的定制化告警,例如航班计划提交、航班起飞(推出和离地)、航班到达(落地和入位)等!
要开始使用告警功能,必须先使用PUT /alerts/endpoint端点设置账户级别的默认告警交付URL。在配置任何告警之前必须完成此步骤,该URL将作为所有未指定特定交付URL的告警的 fallback URL。如果在配置告警前未执行此步骤,调用POST /alerts端点时将收到400错误,错误消息会提醒您完成该步骤。通过PUT /alerts/endpoint端点设置URL后,即可使用POST /alerts端点配置告警。您还可以使用GET /alerts端点检索与您的AeroAPI密钥关联的所有已配置告警。GET /alerts端点可让您轻松获取账户中感兴趣的特定告警的ID,以便使用GET、PUT和DELETE **/alerts/{id}**端点检索、更新和删除特定告警。
配置单个告警时,可以设置target_url字段为与账户级目标端点不同的URL。如果告警设置了target_url字段,则该特定告警将被发送到指定的target_url,而不是账户级默认URL。如果未配置该字段,告警将被发送到账户级默认端点。通过设置此字段,您可以轻松地将不同的告警发送到不同的端点,这对于配置应用专属告警或在不调整生产告警配置的情况下将告警发送到备用开发环境非常有用。
每个配置的告警可以设置一个到多个“事件”来触发告警交付。大多数事件只会触发一次告警交付,但arrival和departure事件可能会触发多次告警交付(称为捆绑告警)。departure事件捆绑了起飞(实际离地)告警、航班计划提交告警以及最多5次起飞前变更告警,包括超过30分钟的重大起飞延误、登机口变更和机场延误。FlightAware Global客户还将收到Power on和Ready to taxi告警作为起飞捆绑告警的一部分。arrival事件捆绑了到达(实际落地)告警以及最多5次途中变更告警(包括超过30分钟的延误,但不包括改道)。FlightAware Global客户还将收到taxi stop时间作为到达捆绑告警的一部分。如果为On/Off事件同时设置了捆绑类型和非捆绑类型,在事件重叠的情况下只会触发一次告警。
如果需要更改告警配置,建议使用**PUT /alerts/{id}**端点和唯一的告警标识符(id)更新告警,而不是创建新的告警。这样可以避免重复告警交付,减少不必要的干扰。
如果需要删除告警,可以使用DELETE alerts/{id}端点删除告警,使其不再被交付。提醒一下,特定告警的ID可以从GET /alerts端点获取。
flight-goat-pp-cli alerts create
— 创建新的AeroAPI航班告警。当告警触发时,将使用回调机制通知...
flight-goat-pp-cli alerts delete
— 删除具有指定ID的特定告警
flight-goat-pp-cli alerts delete-endpoint
— 删除账户级默认URL,该URL用于接收未配置特定URL的告警的POST请求...
flight-goat-pp-cli alerts get
— 返回具有指定ID的告警的配置数据。
flight-goat-pp-cli alerts get-all
— 返回FlightAware账户的所有已配置告警(包括通过其他方式配置的告警...
flight-goat-pp-cli alerts get-endpoint
— 返回用于接收AeroAPI交付告警的POST请求的URL。
flight-goat-pp-cli alerts set-endpoint
— 更新用于接收AeroAPI交付告警的POST请求的默认URL。此设置为账户级...
flight-goat-pp-cli alerts update
— 修改具有指定ID的告警的配置。如果提供了目标URL地址,则该告警...
disruption-counts — 管理航班中断统计
flight-goat-pp-cli disruption-counts get
— 返回指定时间段内特定航空公司或机场的航班取消/延误统计。
flight-goat-pp-cli disruption-counts get-all
— 返回指定时间段内所有航空公司或所有机场的整体航班取消/延误统计。
flights — 管理航班信息
flight-goat-pp-cli flights get
— 返回注册号、标识符或fa_flight_id对应的航班信息状态摘要。如果指定了fa_flight_id...
flight-goat-pp-cli flights get-by-advanced-search
— 根据地理空间搜索参数返回当前或最近的空中航班。查询参数包括...
flight-goat-pp-cli flights get-by-position-search
— 根据地理空间搜索参数返回航班位置。您可以通过此命令查找曾经...
flight-goat-pp-cli flights get-by-search
— 通过匹配各种参数(包括地理空间数据)搜索空中航班。使用简化的...
flight-goat-pp-cli flights get-count-by-search
— 完整的搜索查询文档可在/flights/search端点获取。
foresight — 前瞻(Foresight)端点提供对FlightAware Foresight预测模型和关键事件预测结果的访问权限。我们的高级机器学习(ML)模型识别影响航班的关键因素,实时预测未来事件,为提高运营效率和促进空中及地面的更好决策提供前所未有的洞察力。要了解更多关于Foresight的强大功能,请访问
https://www.flightaware.com/commercial/foresight/
这些端点各自对应一个非Foresight的等效端点,功能相似,但Foresight响应中包含所有ML“预测”值。对应的非Foresight端点响应包含一个标志
foresight_predictions_available
,您可以选择将其作为触发器,根据需要获取和使用Foresight预测结果并管理成本。Foresight仅对高级套餐客户可用。如需更多信息、定价详情及开启账户Foresight功能,请联系
integrationsales@flightaware.com。
flight-goat-pp-cli foresight get-flight-position-with
— 获取航班的当前位置,包括Foresight数据
flight-goat-pp-cli foresight get-flight-with
— 返回注册号、标识符或fa_flight_id对应的航班信息状态摘要,包括所有可用的预测...
flight-goat-pp-cli foresight get-flights-by-advanced-search-with
— 根据地理空间搜索参数返回当前或最近的空中航班。如果可用,航班的...
history — 管理历史数据
flight-goat-pp-cli history get-aircraft-last-flight
— 根据飞机注册号返回其最后一次已知航班的信息状态摘要。搜索范围限制在...
flight-goat-pp-cli history get-flight
— 返回注册号、标识符或fa_flight_id对应的历史航班信息状态摘要。如果指定了fa_flight_id...
flight-goat-pp-cli history get-flight-map
— 返回历史航班的轨迹,以base64编码的图片形式呈现。图片可以包含各种附加数据层...
flight-goat-pp-cli history get-flight-route
— 返回历史航班的申报航线信息,包括航线中各个定位点的坐标、名称和类型...
flight-goat-pp-cli history get-flight-track
— 返回历史航班的轨迹,以位置数组形式呈现。数据可追溯至...
operators — 管理运营商信息
flight-goat-pp-cli operators get
— 返回运营商的信息,包括名称、ICAO/IATA代码、总部位置等。
flight-goat-pp-cli operators get-all
— 返回运营商参考列表(ICAO/IATA代码及访问更多信息的URL)。
schedules — 管理航班时刻表
flight-goat-pp-cli schedules
— 返回航空公司发布的计划航班。这些时刻表最长可查询未来三个月的...