Ratings API

Download OpenAPI specification:Download

URL: https://helpdesk.cirium.com/ Terms of Service

Introduction

The Ratings APIs, part of the FlightStats APIs, 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

Schemas

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

Long term support

Extended fields

Example implementations

FlightStats On-time Performance Rating - Ratings by flight

Cirium Flight Search for Road Warriors - Example mashup of schedules, ratings by route, and flight features

Related products

Historical Flight Status - Status for flights back to 2006

Authentication

appIdQueryParam

ID of the application making the request

Security Scheme Type API Key
Query parameter name: appId

appKeyQueryParam

Authentication key of the application making the request

Security Scheme Type API Key
Query parameter name: appKey

appIdHeader

ID of the application making the request

Security Scheme Type API Key
Header parameter name: appId

appKeyHeader

Authentication key of the application making the request

Security Scheme Type API Key
Header parameter name: appKey

For flight

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.

Authorizations:
appIdQueryParam
    appKeyQueryParam
      appIdHeader
        appKeyHeader
          path Parameters
          format
          required
          string
          Enum: "json" "jsonp" "xml"
          Example: json

          The data format returned in the response

          carrier
          required
          string
          Example: AS

          The airline operating the flight

          flightNumber
          required
          string
          Example: 2227

          The flight number

          query Parameters
          departureAirport
          string
          Example: departureAirport=PDX

          An optional filter to limit results to a specific departure airport

          codeType
          string
          Enum: "FS" "IATA" "ICAO"
          Example: codeType=FS

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

          extendedOptions
          Array of strings
          Items Enum: "useHttpErrors" "useInlinedReferences" "includeNewFields" "languageCode:en" "languageCode:ar" "languageCode:de" "languageCode:es" "languageCode:fr" "languageCode:ja" "languageCode:ko" "languageCode:pt" "languageCode:zh"

          Extended options for modifying standard API behavior to fit special use cases

          Responses

          Response samples

          Content type
          application/json
          application/json
          application/xml
          application/javascript; charset=UTF-8
          Example
          Flight Ratings by Flight (defaults)
          Flight Ratings by Flight (defaults)
          Flight Ratings by Flight (Inlined References)

          Flight Ratings response with one or more ratings

          Loading...

          For route

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

          Authorizations:
          appIdQueryParam
            appKeyQueryParam
              appIdHeader
                appKeyHeader
                  path Parameters
                  format
                  required
                  string
                  Enum: "json" "jsonp" "xml"
                  Example: json

                  The data format returned in the response

                  departureAirport
                  required
                  string
                  Example: PDX

                  Departure airport code

                  arrivalAirport
                  required
                  string
                  Example: SEA

                  Arrival airport code

                  query Parameters
                  codeType
                  string
                  Enum: "FS" "IATA" "ICAO"
                  Example: codeType=FS

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

                  extendedOptions
                  Array of strings
                  Items Enum: "useHttpErrors" "useInlinedReferences" "includeNewFields" "languageCode:en" "languageCode:ar" "languageCode:de" "languageCode:es" "languageCode:fr" "languageCode:ja" "languageCode:ko" "languageCode:pt" "languageCode:zh"

                  Extended options for modifying standard API behavior to fit special use cases

                  Responses

                  Response samples

                  Content type
                  application/json
                  application/json
                  application/xml
                  application/javascript; charset=UTF-8
                  Example
                  Flight Ratings by Route (defaults)
                  Flight Ratings by Route (defaults)
                  Flight Ratings by Route (Inlined References)

                  Flight Ratings response with one or more ratings

                  Loading...
                  )