aerodatabox 1.1.0

OpenAPI API client

aerodatabox


Summary

AeroDataBox API is an enthusiast-driven best-effort aviation and flight data API suitable for smaller travel, hospitality, or aviation applications, researchers, small teams, and individual developers. This API contains features for your aviation-related application: flights, flight status, flight delays, flight schedules, airports, airport schedules, airport delay index, airport destination statistics, airport local time, aircraft, aircraft images, aircraft image recognition by registration, etc. Learn more at at https://aerodatabox.com.

Availability

At the moment, AeroDataBox API is provided via:

• RapidAPI Marketplace
• API.Market Marketplace

Legend

🤖 - endpoint uses or may use AI/ML algorithms

TIER 1..TIER 4 - the tier level of the endpoint, where TIER 4 is the highest and TIER 1 is the lowest. The tier level is used to determine the pricing of the endpoint. Depending on the marketplace, different pricing models may be used, but you can expect that higher tier endpoints will be more expensive than lower tier endpoints.

FREE TIER - the endpoint is available for free on all marketplaces.

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.6.0.0
• Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  aerodatabox:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  aerodatabox:
    path: /path/to/aerodatabox

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:aerodatabox/api.dart';

// TODO Configure API key authorization: X-RapidAPI-Host
//defaultApiClient.getAuthentication<ApiKeyAuth>('X-RapidAPI-Host').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('X-RapidAPI-Host').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: X-RapidAPI-Key
//defaultApiClient.getAuthentication<ApiKeyAuth>('X-RapidAPI-Key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('X-RapidAPI-Key').apiKeyPrefix = 'Bearer';

final api_instance = AircraftAPIApi();
final searchBy = ; // AircraftSearchByEnum | Criteria to search aircraft by
final searchParam = searchParam_example; // String | Value of the search criteria. If `searchBy` is:   * `id`: then this field should be an ID of an aircraft (as specified in the database of this API);  * `reg`: then this field should be a tail-number of an aircraft (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ), multiple matches are possible - see below;  * `icao24`, then this field should be a ICAO 24-bit Mode-S address of an aircraft specified in hexadecimal format (e.g. 484161, 483EFD), multiple matches are possible - see below.    *If multiple matches are possible:*    There cannot be more than one aircraft actively flying with the same tail-number or ICAO 24-bit Mode-S address at any moment of time.   However, historically aircraft tail-numbers or addresses may be used multiple times by different aircraft.  This endpoint is supposed to return a **single** aircraft data. In case if multiple aircraft satisfy the search criteria, the best match will be chosen as follows:  * If an active aircraft is found according to the requested critera, it is returned.  * Otherwise, an aircraft that used requested tail-number/address the most recently is returned.   * If usage time may not be determined, the aircraft stored in the database the most recently is returned.
final withImage = true; // bool | Should include aircraft image (default: false).
final withRegistrations = true; // bool | Should include the history of aircraft registrations (default: false).

try {
    final result = api_instance.getAircraft(searchBy, searchParam, withImage, withRegistrations);
    print(result);
} catch (e) {
    print('Exception when calling AircraftAPIApi->getAircraft: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://aerodatabox.p.rapidapi.com

Class	Method	HTTP request	Description
AircraftAPIApi	getAircraft	GET /aircrafts/{searchBy}/{searchParam}	Single aircraft (by tail-number, Mode-S or ID) [TIER 1]
AircraftAPIApi	getAircraftImageByRegistration	GET /aircrafts/reg/{reg}/image/beta	Aircraft image by tail-number (BETA) [TIER 2]
AircraftAPIApi	getAircraftRegistrations	GET /aircrafts/{searchBy}/{searchParam}/registrations	Single aircraft registration history (by tail-number, Mode-S or ID) [TIER 1]
AircraftAPIApi	getAirlineFleet	GET /airlines/{airlineCode}/aircrafts	Airline fleet / Aircraft list by airline code (BETA) [TIER 3]
AircraftAPIApi	getAllAircraft	GET /aircrafts/{searchBy}/{searchParam}/all	All aircraft (by tail-number, Mode-S or ID) [TIER 1]
AircraftAPIApi	recognizeAircraft	POST /aircrafts/recognize/beta	Aicraft image recognition (BETA) [TIER 3]
AirportAPIApi	getAirport	GET /airports/{codeType}/{code}	Airport by code [TIER 1]
AirportAPIApi	getAirportRunways	GET /airports/{codeType}/{code}/runways	Airport runways [TIER 1]
AirportAPIApi	searchAirportByTerm	GET /airports/search/term	Search airports by free text [TIER 2]
AirportAPIApi	searchAirportsByIpGeoLocation	GET /airports/search/ip	Search airports by IP address geolocation [TIER 2]
AirportAPIApi	searchAirportsByLocation	GET /airports/search/location	Search airports by location [TIER 2]
FlightAPIApi	getAirportFlights	GET /flights/airports/{codeType}/{code}/{fromLocal}/{toLocal}	FIDS (airport departures and arrivals) - by local time range [TIER 2]
FlightAPIApi	getAirportFlightsRelative	GET /flights/airports/{codeType}/{code}	FIDS (airport departures and arrivals) - by relative time / by current time [TIER 2]
FlightAPIApi	getFlight	GET /flights/{searchBy}/{searchParam}/{dateLocal}	Flight status [TIER 2]
FlightAPIApi	getFlightDates	GET /flights/{searchBy}/{searchParam}/dates/{fromLocal}/{toLocal}	Flight departure dates [TIER 2]
FlightAlertAPIApi	getWebhook	GET /subscriptions/webhook/{subscriptionId}	Get web-hook subscription [FREE TIER]
FlightAlertAPIApi	getWebhookList	GET /subscriptions/webhook	List web-hook subscriptions [FREE TIER]
FlightAlertAPIApi	refreshWebhook	PATCH /subscriptions/webhook/{subscriptionId}/refresh	Refresh web-hook subscription [TIER 4]
FlightAlertAPIApi	subscribeWebhook	POST /subscriptions/webhook/{subjectType}/{subjectId}	Create web-hook subscription [TIER 4]
FlightAlertAPIApi	unsubscribeWebhook	DELETE /subscriptions/webhook/{subscriptionId}	Remove web-hook subscription [FREE TIER]
HealthcheckAPIApi	getAirportFeedStatus	GET /health/services/airports/{icao}/feeds	Data feed services status by ICAO code [FREE TIER]
HealthcheckAPIApi	getFeedAirports	GET /health/services/feeds/{service}/airports	Airports supporting data feed service [FREE TIER]
HealthcheckAPIApi	getFeedServiceStatus	GET /health/services/feeds/{service}	General status of data feed services [FREE TIER]
MiscellaneousAPIApi	getAirportDistanceTime	GET /airports/{codeType}/{codeFrom}/distance-time/{codeTo}	🤖 Distance and flight time between airports [TIER 2]
MiscellaneousAPIApi	getAirportLocalTime	GET /airports/{codeType}/{code}/time/local	Current local time at the airport [TIER 1]
MiscellaneousAPIApi	getAirportSolarTime	GET /airports/{codeType}/{code}/time/solar/{dateLocal}	Solar and day time at the airport [TIER 1]
MiscellaneousAPIApi	getAirportWeather	GET /airports/{codeType}/{code}/weather/{fromLocal}/{toLocal}	Weather / forecast at the airport [TIER 2]
StatisticalAPIApi	getAirportDelay	GET /airports/{codeType}/{code}/delays/{dateLocal}	Airport delays (current or historical moment) [TIER 3]
StatisticalAPIApi	getAirportDelays	GET /airports/{codeType}/{code}/delays/{dateFromLocal}/{dateToLocal}	Airport delays (historical period) [TIER 3]
StatisticalAPIApi	getAllAirportDelays	GET /airports/delays/{dateUtc}	Global delays (current or historical moment) [TIER 3]
StatisticalAPIApi	getFlightDelays	GET /flights/{number}/delays	Flight delay statistics by flight number [TIER 3]
StatisticalAPIApi	getRouteDailyStatistics	GET /airports/{codeType}/{code}/stats/routes/daily/{dateLocal}	Airport routes and daily flight destinations [TIER 3]

Documentation For Models

• AircraftContract
• AircraftContractImage
• AircraftContractPagedCollectionContract
• AircraftRecognitionResultContract
• AircraftRegistrationContract
• AircraftSearchByEnum
• AirportCodesByEnum
• AirportContinentContract
• AirportContract
• AirportContractCurrentTime
• AirportContractUrls
• AirportCountryContract
• AirportDelayContract
• AirportDistanceTimeContract
• AirportFeedServiceStatusContract
• AirportFidsContract
• AirportFlightContract
• AirportFlightContractAircraft
• AirportFlightContractAirline
• AirportFlightContractArrival
• AirportFlightContractDeparture
• AirportFlightContractLocation
• AirportFlightContractMovement
• AirportLocalTimeContract
• Angle
• Azimuth
• CloudCover
• CodeshareStatus
• CreateWebHookSubscription
• DailyRouteStatContract
• DailyRouteStatRecordContract
• DateTimeContract
• DayTime
• DelayBracketContract
• Distance
• EngineType
• ErrorContract
• FeedServiceEnum
• FeedServiceStatus
• FeedServiceStatusContract
• FlightAircraftContract
• FlightAircraftContractImage
• FlightAirlineContract
• FlightAirportMovementContract
• FlightAirportMovementContractRevisedTime
• FlightAirportMovementContractRunwayTime
• FlightAirportMovementContractScheduledTime
• FlightAirportMovementQualityEnum
• FlightBatchDelayContract
• FlightContract
• FlightContractGreatCircleDistance
• FlightDataGeneralAvailabilityContract
• FlightDelayContract
• FlightDirection
• FlightLegDelayContract
• FlightLocationContract
• FlightNotificationContract
• FlightNotificationContractSubscription
• FlightSearchByEnum
• FlightStatus
• GeoCoordinatesContract
• GeoCoordinatesContractListingAirportContractSearchResultCollectionContract
• LicenseType
• ListingAirportContract
• ListingAirportContractLocation
• ModelFlightTimeEnum
• PercentileBracketContract
• PhenomenaGroup
• Pressure
• ResourceContract
• RunwayContract
• RunwayContractDisplacedThreshold
• RunwayContractLength
• RunwayContractLocation
• RunwayContractWidth
• SolarStateContract
• SolarStateContractDawnAstronomical
• SolarStateContractDawnCivil
• SolarStateContractDawnNautical
• SolarStateContractDuskAstronomical
• SolarStateContractDuskCivil
• SolarStateContractDuskNautical
• SolarStateContractNoonTrue
• SolarStateContractSunrise
• SolarStateContractSunset
• Speed
• StatisticClass
• StringCollectionContract
• StringListingAirportContractSearchResultCollectionContract
• SubscriberContract
• SubscriptionContract
• SubscriptionSubjectContract
• SubscriptionSubjectType
• SurfaceType
• Temperature
• WeatherStateContract
• WeatherStateContractAirTemperature
• WeatherStateContractCloudBase
• WeatherStateContractDewPoint
• WeatherStateContractPressure
• WeatherStateContractVisibility
• WeatherStateContractWind
• WindContract
• WindContractGusts

Documentation For Authorization

Authentication schemes defined for the API:

X-RapidAPI-Key

• Type: API key
• API key parameter name: X-RapidAPI-Key
• Location: HTTP header

X-RapidAPI-Host

• Type: API key
• API key parameter name: X-RapidAPI-Host
• Location: HTTP header

Author

[e-mail]