Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AeroDataBox Flight Alert API API

The Flight Alert API API from AeroDataBox — 6 operation(s) for flight alert api.

AeroDataBox Flight Alert API API is one of 8 APIs that AeroDataBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Flight Alert API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 6 paths, and defines 33 schemas. It is described by OpenAPI 3.0.4, at version 1.14.0.0.

Requests are made against a single base URL, https://prod.api.market/api/v1/aedbx/aerodatabox.

7 operations 6 paths 33 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
1.14.0.0
Base URL
https://prod.api.market/api/v1/aedbx/aerodatabox
Terms of Service
Resource Areas
1

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Flight Alert API 7
POST
/subscriptions/webhook/{subjectType}/{subjectId}
AeroDataBox Create Web-hook Subscription / TIER 4
SubscribeWebhook 4 params body → 199200204400401451500503
GET
/subscriptions/webhook/{subscriptionId}
AeroDataBox Get Web-hook Subscription / FREE TIER
GetWebhook 2 params → 200204400401451500503
DELETE
/subscriptions/webhook/{subscriptionId}
AeroDataBox Remove Web-hook Subscription / FREE TIER
UnsubscribeWebhook 2 params → 200204400401451500503
GET
/subscriptions/webhook
AeroDataBox List Web-hook Subscriptions / FREE TIER
GetWebhookList 1 param → 200204400401451500503
PATCH
/subscriptions/webhook/{subscriptionId}/refreshdeprecated
AeroDataBox Refresh Web-hook Subscription (DEPRECATED) / TIER 4
RefreshWebhook 3 params → 200204400401451500503
GET
/subscriptions/balance
AeroDataBox Get Web-hook Subscription Balance / FREE TIER
GetBalance 1 param → 200204400401451500503
POST
/subscriptions/balance/refill
AeroDataBox Refill Web-hook Subscription Balance / TIER 1
RefillBalance 1 param body → 200204400401451500503

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are FlightNotificationItemContract (15 properties), FlightAirportMovementContract (11 properties), SubscriptionContract (9 properties), FlightLocationContract (9 properties). Each schema is shown below with its type and property counts.

DistanceFlightPlanUnitContract
object
Contract describing unit (altitude, airspeed, etc.) which can be assigned and / or requested in the context of the flight plan
2 properties
ErrorContract
object
Error response
1 property 1 required
SubscriptionBillingType
string
Flight alert subscription billing type Possible values: 0 - LifetimeBased : Subscription billed upon creation based on the life-time with set expiration date-t…
FlightNotificationContract
object
Flight notification contract
3 properties 2 required
LicenseType
string
Possible values: 0 - AllRightsReserved : All Rights Reserved. 1 - AttributionNoncommercialShareAlikeCC : Creative Commons: Attribution Non-Commercial, Share-al…
CodeshareStatus
string
Flight code-share status Possible values: 0 - Unknown : Code-sharing information is unavailable for this flight. Flight might be operated both by airline ownin…
ListingAirportContract
object
Flight's airport reference contract
9 properties 1 required
FlightStatus
string
Flight progress status Possible values: 0 - Unknown : Status is not available for this flight 1 - Expected : Expected 2 - EnRoute : En route 3 - CheckIn : Chec…
DateTimeContract
object
Descriptor date-time represented in both UTC and local timezones
2 properties 2 required
FlightAircraftContract
object
Flight's aircraft reference contract
4 properties
FlightLocationContract
object
Positional information about flight: location, altitude, speed and track
9 properties 8 required
FlightNotificationItemContract
object
Flight notification message contract
15 properties 7 required
SubscriptionBalanceContract
object
Represents the balance for all alert subscriptions associated with the user acount, including remaining credits and timestamps for the most recent refill and d…
3 properties 3 required
SubscriberContract
object
Describes subscriber (consumer of the subscription)
2 properties 2 required
ResourceContract
object
Single media resource data
7 properties 2 required
Speed
object
4 properties 4 required
SubscriptionContract
object
Describes subscription
9 properties 5 required
FlightAirlineContract
object
Flight's airline reference conract
3 properties 1 required
FlightAirportMovementQualityEnum
string
Quality characteristics of the information provided within flight FlightAirportMovementContract Possible values: 0 - Basic 1 - Live 2 - Approximate
FlightPlanContract
object
Flight plan contract
8 properties 2 required
Pressure
object
3 properties 3 required
FlightPlanStatus
string
FlightAirportMovementContract
object
Flight arrival or departure information
11 properties 2 required
SubscriptionsBalanceRefillRequestContract
object
Represents a contract for refilling flight alert credits on a subscription.
1 property 1 required
CreateWebHookSubscription
object
Command to create web-hook subscription
2 properties 1 required
SubscriptionSubjectType
string
Possible values: 0 - FlightByNumber 1 - FlightByAirportIcao
FlightType
string
Azimuth
object
2 properties 2 required
FlightRules
string
GeoCoordinatesContract
object
Geographical coordinates data
2 properties 2 required
SpeedFlightPlanUnitContract
object
Contract describing unit (altitude, airspeed, etc.) which can be assigned and / or requested in the context of the flight plan
2 properties
Distance
object
5 properties 5 required
SubscriptionSubjectContract
object
Describes subscription subject
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aerodatabox-flight-alert-api-api-openapi.yml Raw ↑

Other APIs AeroDataBox publishes across the network.

AeroDataBox Aircraft API API
AeroDataBox Airport API API
AeroDataBox Flight API API
AeroDataBox Healthcheck API API
AeroDataBox Industry API API
AeroDataBox Miscellaneous API API
AeroDataBox Statistical API API