The airline object contains the unique codes and name that identify a unique airline or carrier

Boolean value indicating if the airline is currently active

Ignore. These are currently not returned.

The Cirium code for the carrier, globally unique across time

The primary customer service phone number for the carrier

The airport object contains the unique codes and name that identify a unique airport

Boolean value indicating if the airport is currently operational

The code of the city in which the airport resides

The Cirium classification of the size of the airport, 1(max) to 5(min)

The code for the country in which the airport resides

The name of the country in which the Airport resides

URL for the DelayIndex service with current delay information computed for the Airport

The district of the city in which the airport resides. Returned if specifying includeNewFields in extendedOptions.

The elevation above sea level of the airport in feet

The Cirium code for the airport, globally unique across time

The latitude of the airport in decimal degrees

The local time at the Airport in ISO-8601 format. yyyy-MM-dd'T'HH:mm:ss.SSS.

The longitude of the airport in decimal degrees

The postal code in which the airport resides

The name of the region in which the Airport resides

The street address of the airport, part 1

The street address of the airport, part 2

The name of the Time Zone region in which the Airport resides

URL for the Weather service with current weather data for the Airport

The NOAA weather zone (US only) in which the Airport resides

In the default case, when an error occurs the API returns a 200 status code and this structure contains information about the error. Not returned if specifying _extendedOptions=useHTTPErrors_, in which case the API returns the HTTP error code and _text/plain_ body containing the same information as in the structure.

This is a unique identifier for the error used internally at Cirium. Include this string in helpdesk requests to help us troubleshoot issues.

This contains detail about the error. If there are multiple errors in the request, the string may have multiple items separated by a '|' character.

This is the standard HTTP code (400, 401, 404, etc...)

The response includes this appendix unless specifying _useInlinedReferences_ in _extendedOptions_. For every airline, airport, or equipment code included in the response, the appendix includes the associated airport, airline or equipment that fully describes the airport, airline or equipment. The _appendix_ includes an array of airlines, airports or amd equipment if there is at least one of those types in the response.

Boolean value indicating if the equipment type uses jet propulsion

The descriptive name for the equipment type

Boolean value indicating if the equipment type is a regional airframe

Boolean value indicating if the equipment type uses TurboProp propulsion

Boolean value indicating if the equipment type is a wide-body airframe

equipment

This object contains rating information for a single flight

The Cirium unique code for the airline to use as a reference for finding the entry in the appendix (unless the extended option to include inlined references is used)

How the flight ranks relative to peers on delay performance (better than %)

The rating for this flight's delay performance (0-5 scale) compared to all flights

How the flight ranks relative to peers on ontime performance (better than %)

The rating for this flight's ontime performance (0-5 scale) compared to all flights

The avg of All_ontime_stars and All_delay_stars yielding the overall performance measure of this flight compared to all flights

The Cirium unique code for the arrival airport to use as a reference for finding the entry in the appendix (unless the extended option to include inlined references is used).

The number of codeshare observations in the rating

The number of observations that arrived later than scheduled time (> 1 minute late)

The Cirium unique code for the departure airport to use as a reference for finding the entry in the appendix (unless the extended option to include inlined references is used)

The number of direct flights in the rating

The flight identifier of the flight, typically a number

The number of observations classified as "late" (15 - 29 minutes)

The number of observations classified as "very late" (30 - 44 minutes)

The number of observations classified as "excessively late" (45 + minutes)

The number of observations in the sample for ontime performance

The number of observations classified as "ontime" (<15 minutes late)

The response body includes the following:
- InterpretedRequest - The API returns the information you requested, plus any interpretation of your request (for example, it will show you the FlightStats code for an airline or airport that it is using and that may be different than the IATA or ICAO code provided)
- APIResponseError - If there is an error, the response includes this error object describing the problem
- AppendixWithWrapper - If _useInlinedReferences_ is not provided and the result includes one or more flights, the response includes 
and appendix of airline, airport, and equipment objects
- ratings - An array of Rating elements


response

appId

Authentication key of the application making the request

appKey

Cirium Help Desk

## Introduction
The Ratings APIs, part of the [FlightStats APIs](/apis/flightstats-apis/overview), provides ratings of a flight's performance relative to other flights. The score produced by the ratings process accounts for both on-time percentage and degree of lateness. 

The API response includes percentage and “stars” ratings. The Stars number represents a rating on a scale of 1 to 5.

You can query the API both by flight (defined by carrier code and flight number for example, HA25) and by route (defined by departure airport and arrival airport for example, PDX to HNL).

Ratings APIs answer questions such as:
* What flights are most likely to be on-time flying between these two airports?
* What is the recent on-time performance of a specific flight?
* How often in the recent past has a specific flight been cancelled?

## Licensing
Flight Rating APIs are standard APIs and included in our Commercial and Contract plans. 

A breakdown of the available plans is available on [Get evaluation account](/apis/flightstats-apis/get-evaluation-account#)

## Schemas
Click the download button at the top of this document to download the OpenApi spec for this API. Other schemas:

Long term support 
* SOAP (deprecated) - [WSDL](https://api.flightstats.com/flex/ratings/docs/v1/lts/soap/ratingsService.wsdl) [XSD](https://api.flightstats.com/flex/ratings/docs/v1/lts/soap/ratingsService.xsd)
* REST - [WADL](https://api.flightstats.com/flex/ratings/docs/v1/lts/rest/ratingsService.wadl) [XSD](https://api.flightstats.com/flex/ratings/docs/v1/lts/rest/ratingsService.xsd)

Extended fields
* SOAP (deprecated) - [WSDL+XSD](https://api.flightstats.com/flex/ratings/soap/v1/ratingsService?wsdl)
* REST - [WADL](https://api.flightstats.com/flex/ratings/rest/v1/schema/wadl) [XSD](https://api.flightstats.com/flex/ratings/rest/v1/schema/xsd) [JSON](https://api.flightstats.com/flex/ratings/rest/v1/schema/json)

## Example implementations
[FlightStats On-time Performance Rating](https://www.flightstats.com/v2/flight-ontime-performance-rating/AA/100/JFK) - Ratings by flight

[Cirium Flight Search for Road Warriors](https://discover.cirium.com/discover/ideas/flight-search-for-road-warriors) - Example mashup of schedules, ratings by route, and flight features

## Related products
[Historical Flight Status](/apis/flightstats-apis/historical-flight-status) - Status for flights back to 2006


Ratings API

Returns the calculated ratings information for a given airline and
flight number. A rating element is returned for each departure/arrival airport pair that 
the flight flew during the observed time period.


format

carrier

flightNumber

An optional filter to limit results to a specific departure airport

departureAirport

Airport code type. If not specified, the code searches in the order: IATA, ICAO, FS.

codeType

[Extended options](/apis/flightstats-apis/get-started) for modifying standard API behavior to fit special use cases

extendedOptions

Client request error. Consult error response for specifics.

Authorization failure. Invalid 'appId', 'appKey', or rate limit violation.

Requested item could not be found, or the endpoint does not exist.

API application error. If error is consistent, please contact Cirium Support.

Returns the calculated ratings information for all flights having
the given departure and arrival airports
