API docs by Redocly

CAPA API (current)

David Murray: dm@centreforaviation.com

The CAPA API aims to be a comprehensive REST interface allowing the programmatic retrieval of all the content that we have available (subject to licensing agreements). It is available as a premium addon to your existing CAPA Membership.

More information for developers

Get an access token

Gets an access token for the user.

IMPORTANT: Note that this is a description of the POST method for /account/token which may not be what you're looking for. If you want to know the basics of obtaining an access token, see the OAuth documentation.

header Parameters
Content-Type
required
string
Value: "application/json"

You must send a Content-Type header. You'll receive (misleading) errors otherwise.

Request Body schema: application/json
required
username
string

User's username.

Required for a password grant.

password
string

User's password.

Required for a password grant.

grant_type
required
string
Enum: "password" "refresh_token" "authorization_code"

Type of grant.

IMPORTANT: Note that third-party clients are unable to use the password grant.

scope
required
string
Value: "user"

Grant scope.

client_id
required
string

ID of the application.

client_secret
required
string

Secret key for the application.

refresh_token
string

If you're doing a token refresh grant, then you need to send through the refresh token that you already have.

code
string

If you are logging in via an authorization code, put it here.

redirect_uri
string

If doing an authorization code grant, this parameter needs to be sent and it needs to match the redirect_uri that was in the original authorization query string.

Responses

Response Schema: application/json
access_token
required
string

The access token for the user.

refresh_token
required
string

The user's refresh token.

expires_in
required
integer

Number of seconds until the access token expires.

token_type
required
string
Value: "Bearer"

The type of token returned.

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "grant_type": "password",
  • "scope": "user",
  • "client_id": "string",
  • "client_secret": "string",
  • "refresh_token": "string",
  • "code": "string",
  • "redirect_uri": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "expires_in": 0,
  • "token_type": "Bearer"
}

Delete/expire an access token

This will expire an access token, so it can no longer be used.

Authorizations:
OAuth2

Responses

Response Schema: application/json
data
required
integer

This will be true upon successful expiration.

Response samples

Content type
application/json
{
  • "data": 0
}

Get an authorization code

This will obtain an authorization code for use in an authorization code grant. Normally you don't want to access this, instead follow the information on obtaining an access token for the proper login flow.

Authorizations:
OAuth2
query Parameters
client_id
required
string

The application ID.

response_type
required
string
Value: "code"

The response type required. This will always be "code".

redirect_uri
required
string

The URL to redirect to upon a successful authorization.

scope
required
string
Value: "user"

The scope. We only have one at the moment - "user".

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Account

Get account ID

Get the account ID associated with the current login token.

Authorizations:
OAuth2

Responses

Response Schema: application/json
data
required
integer

The user's ID.

Response samples

Content type
application/json
{
  • "data": 0
}

Create a new user account

Creates a new user account.

If a valid access token is sent with this request, the account created will be a subaccount of the account that the access token belongs to.

Authorizations:
OAuth2
Request Body schema: application/json
required
username
string

User's username. If omitted, the username will be set to the account's email address.

password
required
string >= 8 characters

User's password.

Password must be 8 characters or longer, and contain at least one uppercase character, one lowercase character, and one number.

email
required
string

User's email address.

name
required
string

User's name.

phone
required
string^[0-9\(\)\+\.\s]+

User's phone number.

This is required for new accounts, but optional for subaccounts.

fax
string

User's fax number.

company
required
string

User's company.

This is required for new accounts, but optional for subaccounts.

sector
required
integer

User's industry sector. This is a integer that represents the sector. A list of sectors and their IDs can be accessed at /site/sectors.

This is required for new accounts, but optional for subaccounts.

country
required
integer

User's country. This is an integer that represents the country. A list of countries and their IDs can be accessed at /site/countries.

source
string

Account creation source (used to track lead sources).

trial
boolean

If the account should be on a trial, this sets up a request for it.

Responses

Response Schema: application/json
data
required
integer

The newly created account ID.

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "stringst",
  • "email": "string",
  • "name": "string",
  • "phone": "string",
  • "fax": "string",
  • "company": "string",
  • "sector": 0,
  • "country": 0,
  • "source": "string",
  • "trial": true
}

Response samples

Content type
application/json
{
  • "data": 0
}

Request a trial account

Creates a request by a user to be given an account with trial level access.

It does not create an actual account.

Request Body schema: application/json
required
name
required
string^.{2,}\s+.{2,}

User's full name.

It must consist of at least two words.

email
required
string

User's email address.

phone
required
string^[0-9\(\)\+\.\s]+

User's phone number.

This is required for new accounts, but optional for subaccounts.

company
required
string

User's company.

This is required for new accounts, but optional for subaccounts.

sector
required
integer

User's industry sector. This is a integer that represents the sector. A list of sectors and their IDs can be accessed at /site/sectors.

This is required for new accounts, but optional for subaccounts.

country
required
integer

User's country. This is an integer that represents the country. A list of countries and their IDs can be accessed at /site/countries.

source
string

Account creation source (used to track lead sources).

position
string

The user's job title.

Responses

Response Schema: application/json
data
required
boolean

If the trial account request has been successfully submitted, true is returned, otherwise false is returned.

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "company": "string",
  • "sector": 0,
  • "country": 0,
  • "source": "string",
  • "position": "string"
}

Response samples

Content type
application/json
{
  • "data": true
}

Get account details

This returns the user's account details.

The account ID may be the user's own ID, or the ID of an account that the user has ownership over.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Responses

Response Schema: application/json
required
object
id
required
integer

The user's ID.

username
required
string

The user's username.

object

If the user's account is a subaccount, this is the owner account's details.

id
required
integer

Owner account's ID.

name
required
string

Owner account's name.

email
required
string

Owner account's email address.

object

The details of the account manager assigned to the account.

name
required
string

The account manager's name.

email
required
string

The account manager's email address.

position
required
string

The user's position, or job title.

name
required
string

The user's name.

email
required
string

The user's email address.

company
required
string

The user's company.

phone
required
string

The user's phone number.

fax
string

The user's fax number.

address
string

The user's street address.

suburb
string

The user's suburb or city.

state
string

The user's state.

postcode
string

The user's postcode or ZIP code.

object

The user's country.

id
integer

Country ID.

name
string

Country name.

code
string

2-letter country code.

object

The user's industry sector.

id
required
integer

Sector ID.

name
required
string

Sector name.

created
required
integer

UNIX timestamp of the time the account was created.

bounced
required
boolean

True if the account's email address is marked as having bounced.

mailok
required
boolean

True if it's OK to send email to this user.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update user's account details

Updates the user's account details with the submitted information.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Request Body schema: application/json
required
username
required
string

User's username. If omitted, the username will be set to the account's email address.

email
required
string

User's email address.

name
required
string^.{2,}\s+.{2,}

User's name.

position
string

The user's job title.

phone
required
string^[0-9\(\)\+\.\s]+

User's phone number.

This is required for parent accounts, but optional for subaccounts.

fax
string^[0-9\(\)\+\.\s]+

User's fax number.

company
required
string

User's company.

This is required for parent accounts, but optional for subaccounts.

sector
required
integer

User's industry sector. This is a integer that represents the sector. A list of sectors and their IDs can be accessed at /site/sectors.

This is required for parent accounts, but optional for subaccounts.

country
required
integer

User's country. This is an integer that represents the country. A list of countries and their IDs can be accessed at /site/countries.

state
string

User's address state.

suburb
string

User's suburb.

postcode
string

User's postcode.

address
string

User's address details excluding those in above parameters (e.g. street name, building number floor level, etc).

owner
integer

Owner account's ID.

object

The details of the account manager assigned to the account.

name
required
string

The account manager's name.

email
required
string

The account manager's email address.

Responses

Response Schema: application/json
required
object
id
required
integer

The user's ID.

username
required
string

The user's username.

object

If the user's account is a subaccount, this is the owner account's details.

id
required
integer

Owner account's ID.

name
required
string

Owner account's name.

email
required
string

Owner account's email address.

object

The details of the account manager assigned to the account.

name
required
string

The account manager's name.

email
required
string

The account manager's email address.

position
required
string

The user's position, or job title.

name
required
string

The user's name.

email
required
string

The user's email address.

company
required
string

The user's company.

phone
required
string

The user's phone number.

fax
string

The user's fax number.

address
string

The user's street address.

suburb
string

The user's suburb or city.

state
string

The user's state.

postcode
string

The user's postcode or ZIP code.

object

The user's country.

id
integer

Country ID.

name
string

Country name.

code
string

2-letter country code.

object

The user's industry sector.

id
required
integer

Sector ID.

name
required
string

Sector name.

created
required
integer

UNIX timestamp of the time the account was created.

bounced
required
boolean

True if the account's email address is marked as having bounced.

mailok
required
boolean

True if it's OK to send email to this user.

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "name": "string",
  • "position": "string",
  • "phone": "string",
  • "fax": "string",
  • "company": "string",
  • "sector": 0,
  • "country": 0,
  • "state": "string",
  • "suburb": "string",
  • "postcode": "string",
  • "address": "string",
  • "owner": 0,
  • "manager": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a subaccount

This lists all subaccounts connected to this account.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Responses

Response Schema: application/json
data
required
boolean

True if the account was deleted.

Response samples

Content type
application/json
{
  • "data": true
}

Get the user's active subscriptions

This returns an object that contains objects that represent each active subscription a user has. The key of each object will be the ID of the product.

If a subscription object contains a key called "included" that is true (along with name and shortname), and "email" that may be true or false, that means that the product with that ID is an included subscription with their account - ie. AVAN and Airline Leader will always be included subscriptions, no matter the account type. If it is an actual subscription, then the object will contain far more detailed information, which is shown below.

Note that the output for this call is pretty messy and unstable; it will eventually be changed to something a bit more ordered.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Responses

Response Schema: application/json
required
object
object

The key for each value returned is the product ID.

subid
integer

The subscription ID (not the same as the product ID).

start
integer

UNIX timestamp of the time the subscription started.

trial
boolean

Boolean indicating whether the subscription is a trial or not.

expiry
integer

UNIX timestamp of the time the subscription is due to expire.

users
integer

Number of user licences for the subscription.

owner
integer

The ID of the subscription owner.

object

If this is a paid subscription, then the info key will exist with further details.

id
integer

This is the subscription ID. Same as the "subid" key above.

cid
integer

CID is the "customer ID" aka the owner ID of the subscription. If the user's account is a subaccount, and the subscription is assigned, then this will be the ID of the owner account.

username
string

The username of the account that owns the subscription.

company
string

The company that owns the subscription

name
string

The name of the account that owns the subscription.

orderid
integer

The order ID that the subscription is associated with.

trial
boolean

Whether this is a trial subscription or not.

prodid
integer

The product ID of the subscription. Same as the main object key.

start
integer

UNIX timestamp of the subscription start date (same as main object).

expiry
integer

UNIX timestamp of the subscription expiry date (same as main object).

active
boolean

Boolean indicating whether this subscription is active or not (same as main object).

users
integer

Number of user licences this subscription has (same as main object).

prodname
string

The product name.

shortname
string

The shortname of the product.

itemname
string

This will be either a string or null, and is set when the product has been renamed in the original order that set up the subscription.

Basically, if this is not null then treat it as the product name instead of the prodname key.

email
boolean

Whether this subscription has a mailout component or not (ie. Fleets does not, but APAD does).

included
boolean

If this is an "included" subscription, this will be true. An included subscription will be something like AVAN or AL on all accounts, or APAD/ABD/etc for CAPA Membership accounts.

shortname
string

The shortname of the product. This key only exists for included subscriptions. Look inside the "info" key otherwise.

name
string

The name of the product. This key only exists for included subscriptions. Look inside the "info" key otherwise.

requires
integer

If this product is an addon to another product, this is the ID of the product that is required.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Change a user's password

Change a user's password. :!: If you are a master account wanting to change a subaccount's password, the OAuth authorisation header needs to be sent, and the oldPassword value needs to be set to the master account's password.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Request Body schema: application/json
required
oldPassword
required
string

The user's current password. If a master account is editing the subaccount's password, this should be the password of the master account.

newPassword
required
string

The new password.

token
string

If the User has forgot the old password and is requesting the password, access requires a reset token acquired via the /account/password/forgot API query.

Responses

Response Schema: application/json
required
object
changed
required
boolean

Request samples

Content type
application/json
{
  • "oldPassword": "string",
  • "newPassword": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update user's subscription email preferences

This changes the user's subscription email preferences. Note that this is separate to Alerts.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Request Body schema: application/json
required
Array
id
required
integer

Product ID.

subscribe
required
boolean

Whether to receive email for this product or not.

Responses

Response Schema: application/json
required
object
updated
required
boolean

If the preferences have successfully updated, this will be true.

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of bought items

This returns all bought items that the user has associated with the account. This will be all non-subscription items, like reports.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Responses

Response Schema: application/json
required
Array of objects
Array
url
required
string

The product URL.

price
number

The product's price. If this is a subscription, then the price will be the setup fee for the subscription.

object
id
integer

The price's currency ID.

symbol
string

The price's currency symbol.

image
string

URL of product image.

Array of objects
Array
id
integer

Subscription ID.

price
number

Subscription price for the specified period.

period
integer

Subscription period (in months).

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Check if an email address has an account

This runs a test to see if the supplied email parameter has an associated account.

path Parameters
email
required
string

User's email address.

Responses

Response Schema: application/json
data
required
boolean

If the email is associated with an account, true is returned, otherwise false is returned.

Response samples

Content type
application/json
{
  • "data": true
}

Get a reset token for a user's password

If the user has forgotten their password, posting here will generate a reset token they can use to reset it.

Request Body schema: application/json
required
username
required
string

The user's username.

Responses

Response Schema: application/json
data
required
string

A response string, indicating that a reset token was sent to the email address on file for the account.

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "data": "string"
}

Unsubscribe from a mailout

Making a DELETE request to this resource will unsubscribe the user from a mailout. It does not require authentication, and its intention is to be used for unsubscribe links in emails.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

prodid
required
integer

Product ID.

Responses

Response Schema: application/json
data
required
boolean

Response samples

Content type
application/json
{
  • "data": true
}

Get a list of the user's subaccounts

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Responses

Response Schema: application/json
required
Array of objects (Account)
Array
id
required
integer

The user's ID.

username
required
string

The user's username.

required
object

If the account is a subaccount, this is the owner account's details.

id
required
string

Owner account ID.

name
required
string

Owner account name.

email
required
string

Owner account's email address.

object

The details of the account manager assigned to the account.

name
required
string

The account manager's name.

email
required
string

The account manager's email address.

position
required
string

The user's position, or job title.

name
required
string

The user's name.

email
string

The user's email address.

company
required
string

The user's company.

phone
required
string

The user's phone number.

fax
string

The user's fax number.

address
string

The user's street address.

suburb
string

The user's suburb or city.

state
string

The user's state.

postcode
string

The user's postcode or ZIP code.

object

The user's country.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

object

The user's industry sector.

id
required
integer

Sector ID.

name
required
string

Sector name.

created
required
integer

UNIX timestamp of the time the account was created.

bounced
required
boolean

If true, then the account's email address is marked as having bounced.

mailok
required
boolean

It is OK to send email to this user.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Disable a subaccount

To disable a subaccount by owner, you can't disable yourself

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Responses

Response Schema: application/json
data
required
boolean

True if the account was disabled.

Response samples

Content type
application/json
{
  • "data": true
}

List subaccounts assigned to a subscription

This lists all subaccount IDs connected to this account that have been assigned access to the indicated subscription.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

sub
required
integer

Subscription ID.

Responses

Response Schema: application/json
data
required
Array of integers

A list of subaccount IDs that the subscription is assigned to.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update list of subaccounts assigned to a subscription

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

sub
required
integer

Subscription ID.

Request Body schema: application/json
required
Array
integer

ID of subaccount this subscription should be assigned to.

Responses

Response Schema: application/json
data
required
boolean
Value: true

This will be true if succesfully updated.

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "data": true
}

List user's API clients

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Responses

Response Schema: application/json
required
Array of objects (Client)

A list of API clients.

Array
identifier
required
string

Client identifier string.

name
required
string

Client name

redirects
required
Array of strings

Permitted URL to redirect authorization code requests to.

domains
required
Array of strings

Permitted domains to access this client from (these will be checked against CORS headers).

required
object
password
required
boolean

True if password grants are permitted for this client.

authorization_code
required
boolean

True if authorization code grants are permitted for this client.

implicit
required
boolean

True if implicit grants are permitted for this client.

refresh_token
required
boolean

True if refresh token grants are permitted for this client.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create a new API client

This will create a new API client with all grants disabled. Enable grants using the updateClient method.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Request Body schema: application/json
required
name
required
string

API client name. This is a screen-friendly readable name for the client.

identifier
required
string

This should be a unique client identifier. Ideally you'd make it all lowercase ASCII, and it needs to be completely unique.

Responses

Response Schema: application/json
data
required
string

If successfully created, then the response here will be the client secret. This is the only time you will see this, so when it is received, save it somewhere as it is required for all non-implicit grants.

Request samples

Content type
application/json
{
  • "name": "string",
  • "identifier": "string"
}

Response samples

Content type
application/json
{
  • "data": "string"
}

Get details about the specified API client

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

client
required
string

Client identifier.

Responses

Response Schema: application/json
required
object (Client)
identifier
required
string

Client identifier string.

name
required
string

Client name

redirects
required
Array of strings

Permitted URL to redirect authorization code requests to.

domains
required
Array of strings

Permitted domains to access this client from (these will be checked against CORS headers).

required
object
password
required
boolean

True if password grants are permitted for this client.

authorization_code
required
boolean

True if authorization code grants are permitted for this client.

implicit
required
boolean

True if implicit grants are permitted for this client.

refresh_token
required
boolean

True if refresh token grants are permitted for this client.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update an API client

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

client
required
string

Client identifier.

Request Body schema: application/json
required
object

Options for which grants are enabled. Note that password grants are always disabled for third-party clients.

implicit
boolean

True if you want to enable an implicit grant.

authorization_code
boolean

True if you want to enable an authorization code grant.

refresh_token
boolean

True if you want to enable a refresh token grant.

redirects
Array of strings

URL that this client is allowed to redirect to.

domains
Array of strings

Domain this client is allowed to be accessed from. Note that the protocol should be included in this (ie. "https://").

Responses

Response Schema: application/json
data
required
boolean
Value: true

True if successfully updated.

Request samples

Content type
application/json
{
  • "grants": {
    },
  • "redirects": [
    ],
  • "domains": [
    ]
}

Response samples

Content type
application/json
{
  • "data": true
}

Delete an API client

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

client
required
string

Client identifier.

Responses

Response Schema: application/json
data
required
boolean
Value: true

True if successfully deleted.

Response samples

Content type
application/json
{
  • "data": true
}

Get API client details

This identifies and returns the details of the client matching the given unique identifier string.

path Parameters
identifier
required
string

Client identifier.

Responses

Response Schema: application/json
required
object
identifier
string

Client identifier.

name
string

Client name.

redirects
Array of strings

URL that this client is allowed to redirect to.

domains
Array of strings

Domain this client is allowed to be accessed from. Note that the protocol should be included in this (ie. "https://").

object

Options for which grants are enabled. Note that password grants are always disabled for third-party clients.

password
string

Client password.

authorization_code
boolean

Whether client is allowed to grant authorization codes.

implicit
boolean

Whether client is allowed to grant implicit codes.

refresh_token
boolean

Whether client is allowed to grant refresh tokens.

Response samples

Content type
application/json
{
  • "data": {
    }
}

List current sessions for a client

Returns a list of the current active sessions for an API client.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

client
required
string

Client identifier.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
string

Session identifier.

userid
required
integer

User ID the session belongs to.

date
required
integer

UNIX timestamp of the time the session was created.

expires
required
integer

UNIX timestamp of the time the session expires.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete an API client session

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

client
required
string

Client identifier.

session
required
string

Session identifier.

Responses

Response Schema: application/json
data
required
boolean

True if session was successfully deleted.

Response samples

Content type
application/json
{
  • "data": true
}

List new announcements

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

query Parameters
date
string <datetime>

Return any announcements newer than this date. Defaults to today.

Responses

Response Schema: application/json
required
Array of objects
Array
date
required
string <datetime>

Date of announcement.

announcement
required
string

HTML announcement.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Mark announcements as seen

Provides confirmation tht the user has seen the identified announcement.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

query Parameters
id
required
integer

This is the id of the announcement the user has seen.

Request Body schema: application/json
required
date
required
string <datetime>

Date announcement was seen.

Responses

Response Schema: application/json
boolean

True is returned.

Request samples

Content type
application/json
{
  • "date": "string"
}

Response samples

Content type
application/json
{
  • "": true
}

Alerts

List Alerts for an account

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Responses

Response Schema: application/json
required
object
required
object

Sending frequency details.

freq
required
integer

The frequency that Alerts will be emailed to the user. The possible values are:

Value Type Notes
0 Never Never send an email. Useful if the customer is only using the RSS feeds or app.
1 Live Send Alerts emails immediately for each article published. Unless the user has very specific filters set, this will result in a deluge of email.
2 Hourly Send Alerts hourly, on the hour.
3 Daily Send Alerts daily, at the time specified in the sendat parameter.
4 Weekly Send Alerts weekly, usually at midnight UTC on a Monday morning.
5 Monthly Send Alerts monthly.
sendat
required
string

If an Alert is being sent daily, this is the time of day that it will be sent (based on UTC a timezone).

required
Array of objects (Alert)

An array of Alerts, sorted by the user's preferences.

Array
id
integer

ID of the Alert.

name
string

Name of the Alert.

uid
string

Unique identifier for the Alert. Use when building RSS feed URLs.

types
required
Array of integers

An array of news types to include in results.

News types are:

ID Type Description
0 News News briefs.
1 Analysis Analysis articles.
2 Press Releases CAPA press releases.
3 Direct News Sources Other company press releases.
4 Share Market Performance Legacy/unused.
5 Blog Legacy/unused.
6 Updates CAPA updates. Somehow different to CAPA press releases.
7 Financials Legacy/unused.
8 Traffic Legacy/unused.
9 Airline Leader Articles from Airline Leader.
required
Array of objects

An array of condition groups to filter news by.

Array
id
integer

Condition group ID.

type
required
string
Enum: "ALL" "ANY"

Whether to match all or any of the conditions included.

match
required
boolean

Set to true if you want to include results that match everything, or false if you want to do a negative match.

Negative matches only work when there is more than one condition group. These are so you can go "match these tags but not those tags."

object

Categories, tags or profiles to match.

tags
required
Array of strings >= 0 items

An array of tags.

cats
required
Array of integers >= 0 items

An array of category IDs. A list of IDs can be found at /site/categories.

required
Array of objects >= 0 items

An array of profile types & IDs.

Array (>= 0 items)
id
required
integer

Profile ID.

type
required
integer

Profile type ID.

name
required
string

Profile name.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update user's Alerts

This will batch update/replace a user's alerts. The order of the array sent to the server will dictate the sort order of the user's Alerts. If an Alert is not sent to the server, it will be deleted.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Request Body schema: application/json
required
Array of objects (Alert)

The user's new Alerts, ordered. If this key is not sent, no Alerts will be changed.

Array
id
integer

ID of the Alert.

name
string

Name of the Alert.

uid
string

Unique identifier for the Alert. Use when building RSS feed URLs.

types
required
Array of integers

An array of news types to include in results.

News types are:

ID Type Description
0 News News briefs.
1 Analysis Analysis articles.
2 Press Releases CAPA press releases.
3 Direct News Sources Other company press releases.
4 Share Market Performance Legacy/unused.
5 Blog Legacy/unused.
6 Updates CAPA updates. Somehow different to CAPA press releases.
7 Financials Legacy/unused.
8 Traffic Legacy/unused.
9 Airline Leader Articles from Airline Leader.
required
Array of objects

An array of condition groups to filter news by.

Array
id
integer

Condition group ID.

type
required
string
Enum: "ALL" "ANY"

Whether to match all or any of the conditions included.

match
required
boolean

Set to true if you want to include results that match everything, or false if you want to do a negative match.

Negative matches only work when there is more than one condition group. These are so you can go "match these tags but not those tags."

object

Categories, tags or profiles to match.

tags
required
Array of strings >= 0 items

An array of tags.

cats
required
Array of integers >= 0 items

An array of category IDs. A list of IDs can be found at /site/categories.

required
Array of objects >= 0 items

An array of profile types & IDs.

Array (>= 0 items)
id
required
integer

Profile ID.

type
required
integer

Profile type ID.

name
required
string

Profile name.

object

If you want to change Alert frequency settings, send this key.

freq
required
integer

The sending frequency of the user's Alerts.

Value Type Notes
0 Never Never send an email. Useful if the customer is only using the RSS feeds or app.
1 Live Send Alerts emails immediately for each article published. Unless the user has very specific filters set, this will result in a deluge of email.
2 Hourly Send Alerts hourly, on the hour.
3 Daily Send Alerts daily, at the time specified in the sendat parameter.
4 Weekly Send Alerts weekly, usually at midnight UTC on a Monday morning.
5 Monthly Send Alerts monthly.
sendat
required
string

The time to send Alerts if the frequency is set to daily. UTC timezone.

Responses

Request samples

Content type
application/json
{
  • "alerts": [
    ],
  • "freq": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Create a new Alert

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Request Body schema: application/json
required
id
integer

ID of the Alert.

name
string

Name of the Alert.

uid
string

Unique identifier for the Alert. Use when building RSS feed URLs.

types
required
Array of integers

An array of news types to include in results.

News types are:

ID Type Description
0 News News briefs.
1 Analysis Analysis articles.
2 Press Releases CAPA press releases.
3 Direct News Sources Other company press releases.
4 Share Market Performance Legacy/unused.
5 Blog Legacy/unused.
6 Updates CAPA updates. Somehow different to CAPA press releases.
7 Financials Legacy/unused.
8 Traffic Legacy/unused.
9 Airline Leader Articles from Airline Leader.
required
Array of objects

An array of condition groups to filter news by.

Array
id
integer

Condition group ID.

type
required
string
Enum: "ALL" "ANY"

Whether to match all or any of the conditions included.

match
required
boolean

Set to true if you want to include results that match everything, or false if you want to do a negative match.

Negative matches only work when there is more than one condition group. These are so you can go "match these tags but not those tags."

object

Categories, tags or profiles to match.

tags
required
Array of strings >= 0 items

An array of tags.

cats
required
Array of integers >= 0 items

An array of category IDs. A list of IDs can be found at /site/categories.

required
Array of objects >= 0 items

An array of profile types & IDs.

Array (>= 0 items)
id
required
integer

Profile ID.

type
required
integer

Profile type ID.

name
required
string

Profile name.

Responses

Response Schema: application/json
required
object
id
required
integer

The newly created Alert's ID.

uid
required
string

The newly created Alert's unique identifier (for RSS feeds).

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uid": "string",
  • "types": [
    ],
  • "search": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

List articles for an Alert

This will return a list of articles that match the specified alert, in reverse-chronological order.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

alertid
required
integer

The user's Alert ID.

query Parameters
num
integer

Maximum number of results to return.

page
integer

Zero-based result page index.

from
integer

Don't show alerts older than this (UNIX) time.

nolimit
integer
Value: 1

By default, searches are restricted to stories from within the past 3 months, in order to keep response times fast. If you want to go back further, send this parameter.

linked
boolean

If true, this causes all names that match to CAPA profiles to be changed to HTML links to those profiles.

Responses

Response Schema: application/json
required
Array of objects (AlertResult)
Array
id
required
integer

Article ID.

title
required
string

The title of the article.

article
required
string

HTML content of the article itself.

required
object

The article type

id
required
integer

Article type ID

name
required
string

Article type name

image
string

Article image URL. More info on resizing.

timestamp
required
string

UNIX timestamp of the article.

url
required
string

URL of the article.

tags
Array of strings >= 0 items

An array of tags.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update an Alert

This changes the search parameters of an Alert.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

alertid
required
integer

The user's Alert ID.

Request Body schema: application/json
required
id
integer

ID of the Alert.

name
string

Name of the Alert.

uid
string

Unique identifier for the Alert. Use when building RSS feed URLs.

types
required
Array of integers

An array of news types to include in results.

News types are:

ID Type Description
0 News News briefs.
1 Analysis Analysis articles.
2 Press Releases CAPA press releases.
3 Direct News Sources Other company press releases.
4 Share Market Performance Legacy/unused.
5 Blog Legacy/unused.
6 Updates CAPA updates. Somehow different to CAPA press releases.
7 Financials Legacy/unused.
8 Traffic Legacy/unused.
9 Airline Leader Articles from Airline Leader.
required
Array of objects

An array of condition groups to filter news by.

Array
id
integer

Condition group ID.

type
required
string
Enum: "ALL" "ANY"

Whether to match all or any of the conditions included.

match
required
boolean

Set to true if you want to include results that match everything, or false if you want to do a negative match.

Negative matches only work when there is more than one condition group. These are so you can go "match these tags but not those tags."

object

Categories, tags or profiles to match.

tags
required
Array of strings >= 0 items

An array of tags.

cats
required
Array of integers >= 0 items

An array of category IDs. A list of IDs can be found at /site/categories.

required
Array of objects >= 0 items

An array of profile types & IDs.

Array (>= 0 items)
id
required
integer

Profile ID.

type
required
integer

Profile type ID.

name
required
string

Profile name.

Responses

Response Schema: application/json
data
required
boolean

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uid": "string",
  • "types": [
    ],
  • "search": [
    ]
}

Response samples

Content type
application/json
{
  • "data": true
}

Delete an Alert

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

alertid
required
integer

The user's Alert ID.

Responses

Response Schema: application/json
data
required
integer

Response samples

Content type
application/json
{
  • "data": 0
}

Copy Alerts between accounts

This will batch copy the selected alerts from a user's account to all of the selected subaccounts. Note: this requires that the user account has associated subaccounts.

Authorizations:
OAuth2
path Parameters
id
required
integer

The user's account ID.

Request Body schema: application/json
required
userids
required
Array of integers

An array that contains the ID(s) of one or more subaccounts to copy the selected alerts to.

It must contain at least one account ID and each ID must be of an subaccount to the user account.

alertids
required
Array of integers

An array that contains the ID(s) of one or more alerts to copy to the selected accounts.

It must contain at least one alert ID.

type
required
string
Enum: "add" "replace"

This property defines how the function interacts with existing alerts in the selected accounts. The available options are 'add' and 'replace'.

add: This adds the alerts to the selected accounts. If an account already has an alert with the same name as one of the ones being duplicated, the duplicate is not copied to that account. replace: Any existing alerts for the selected accounts are deleted before copying the new alerts over.

Responses

Response Schema: application/json
data
required
boolean

True is returned.

Request samples

Content type
application/json
{
  • "userids": [
    ],
  • "alertids": [
    ],
  • "type": "add"
}

Response samples

Content type
application/json
{
  • "data": true
}

Preview an Alert

If you need an idea of the kind of results that will be returned when building an Alert, that can be done here.

Authorizations:
OAuth2
Request Body schema: application/json
required
id
integer

ID of the Alert.

name
string

Name of the Alert.

uid
string

Unique identifier for the Alert. Use when building RSS feed URLs.

types
required
Array of integers

An array of news types to include in results.

News types are:

ID Type Description
0 News News briefs.
1 Analysis Analysis articles.
2 Press Releases CAPA press releases.
3 Direct News Sources Other company press releases.
4 Share Market Performance Legacy/unused.
5 Blog Legacy/unused.
6 Updates CAPA updates. Somehow different to CAPA press releases.
7 Financials Legacy/unused.
8 Traffic Legacy/unused.
9 Airline Leader Articles from Airline Leader.
required
Array of objects

An array of condition groups to filter news by.

Array
id
integer

Condition group ID.

type
required
string
Enum: "ALL" "ANY"

Whether to match all or any of the conditions included.

match
required
boolean

Set to true if you want to include results that match everything, or false if you want to do a negative match.

Negative matches only work when there is more than one condition group. These are so you can go "match these tags but not those tags."

object

Categories, tags or profiles to match.

tags
required
Array of strings >= 0 items

An array of tags.

cats
required
Array of integers >= 0 items

An array of category IDs. A list of IDs can be found at /site/categories.

required
Array of objects >= 0 items

An array of profile types & IDs.

Array (>= 0 items)
id
required
integer

Profile ID.

type
required
integer

Profile type ID.

name
required
string

Profile name.

Responses

Response Schema: application/json
required
object (AlertResult)

A single Alert result will contain an article and all the content for it.

id
required
integer

Article ID.

title
required
string

The title of the article.

article
required
string

HTML content of the article itself.

required
object

The article type

id
required
integer

Article type ID

name
required
string

Article type name

image
string

Article image URL. More info on resizing.

timestamp
required
string

UNIX timestamp of the article.

url
required
string

URL of the article.

tags
Array of strings >= 0 items

An array of tags.

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uid": "string",
  • "types": [
    ],
  • "search": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Profiles

Get a list of destinations grouped by weekly frequency

This returns a list of destinations, grouped by the amount of flights going to them each week. It's a pretty ugly function with output that makes no sense, and will be rewritten eventually.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
rtype
string
Enum: "domestic" "international"

If this is set to domestic then only domestic routes are included, otherwise international ones are.

ftype
required
string
Enum: "passenger" "cargo"

Flight type.

week
string <date>

ISO8601 date of the week start. Must be a Monday.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Number of frequencies. Yes, it's called id but means number of frequencies.

data
required
integer

Number of routes with the specified number of frequencies.

routes
required
string

A list of the routes themselves. This will be a HTML string, with each result separated by a literal
tag. I know, it's a mess.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List available tabs for a profile

Returns a list of tabs that are able to be displayed within a profile. This is used on the CAPA website to determine which tabs to display on profile pages.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
title
required
string

Tab title.

type
required
string

Short string describing the tab's type.

requires
required
Array of strings

If this tab has content that is locked behind a subscription product, then the shortname for the product will be listed here. If the user has access to any of the products in the list, then the tab should open to the user.

group
boolean

This will appear on traffic/financial/documents profile tabs for airlines - if it's true, then the tab contents should contain the airline group's data, and not the airline itself.

items
Array of strings

On a financial tab, this will list the items that should be displayed. financials refers to financial results.

object

On a Fast Facts tab, this contains info about what traffic should be displayed.

group
boolean

If true and it's an airline profile, use the airline group that owns the airline's traffic data.

object

On a Fast Facts tab, this contains info about what financial data should be displayed.

items
Array of strings

This will contain an array of financial data items to display.

group
boolean

If this is true, rely on the airline group's financials instead of the airline itself.

fleet
boolean

On a Fast Facts tab, add fleet graphs if this is true.

schedulesAnalysis
boolean

On a Fast Facts tab, add schedules analysis graphs if this is true.

cargoAnalysis
boolean

On a Fast Facts tab, add cargo analysis graphs if this is true.

people
boolean

On a Fast Facts tab, add the contacts table if this is true.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Convert a shorturl + type string to profile ID

This is used to figure out a profile ID based on profile URL components. Only really useful for the CAPA site itself.

query Parameters
shorturl
required
string

The shorturl string.

Given a URL of https://centreforaviation.com/data/profiles/airlines/qantas-airways-qf, the shorturl component would be qantas-airways-qf.

type
required
string

The type string.

Given a URL of https://centreforaviation.com/data/profiles/airlines/qantas-airways-qf, the type would be airlines.

Responses

Response Schema: application/json
required
object
id
required
integer

Profile ID.

type
required
integer

Profile type ID.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Search for a profile ID

query Parameters
term
string

Profile name to search for. Any profiles containing this string will be returned.

code
string

Profile IATA/ICAO/country code. If this is supplied, "term" will be ignored and only profiles that exactly match the specified code will be returned.

start
integer

If this is sent, then the "term" search will only match profiles that start with the term string, instead of profiles that contain the term string.

Responses

Response Schema: application/json
required
Array of objects (ProfileSearchResult)
Array
rank
integer

Profile type display order (starting from 1).

id
required
integer

Profile ID.

required
object

Profile type.

id
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (if available).

icao
string

Profile ICAO code (if available).

url
string

Profile URL. This is only added for the appropriate profile types (Cities, for instance, do not have a profile page)

object

If the profile has a country linked to it, country details are here.

id
required
string

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get basic info for a profile

This returns basic profile details - a short description, IATA/ICAO codes, location, etc. There are a few fields common to all profiles, however the resulting object will vary greatly depending on the profile type.

IMPORTANT: Profile IDs do not change - they will remain the same throughout their lifetime. The exception is in the rare event of a merge, when duplicate profiles are combined together. This is an administrative thing unrelated to airline mergers and does not happen often.

path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
object
iata
string

Profile IATA code.

Applies to:

  • airlines
  • airports
icao
string

Profile ICAO code.

Applies to:

  • airlines
  • airports
duplicate
boolean

Whether or not the profile's IATA code is a controlled duplicate.

Applies to:

  • airlines
name
required
string

Name of the profile.

efrom
string <date>

Date that the company was effective ("active") from. A company that is currently active will have an efrom date of null or the date it started operating. If the date is in the future, it means the company has not started operating yet.

Applies to:

  • airlines
eto
string <date>

Similar to efrom, this is the date that the company ceased operations. If it is null, it is assumed the company is active. If it is a date in the past, this is the date it ceased operating. If it is a future date, this is the date it will cease operating.

Applies to:

  • airlines
current
boolean

An easier way to tell if an airline is active or not - if it's true then it's an active airline.

Applies to:

  • airlines
bizmodel
string

Business model of the profile.

Applies to:

  • airlines
category
required
integer

News/analysis should match articles within this category.

address
string

The address of the profile. Typically a company's headquarters.

Applies to:

  • airlines
  • airports
object

If this is an airline profile, its main hub details are here.

Applies to:

  • airlines
id
required
integer

Hub profile ID.

type
required
string

Hub profile type ID.

name
required
string

Hub name.

url
required
string

Hub profile URL.

website
string

Profile's external company URL.

bio
required
string

A short HTML description of the profile.

currency
required
string
Default: "USD"

If the profile reports financials, this is the currency it reports in.

financial_year_end
required
integer

The month number that the profile's financial year ends in.

**IMPORTANT**: Note that this does not guarantee that financial data is available for the profile.
traffic_year_end
required
integer

The month number that the profile's traffic reporting year ends in.

**IMPORTANT**: Note that this does not guarantee that traffic data is available for the profile.
startup
boolean

Whether or not CAPA classifies this profile as a startup.

Applies to:

  • airlines
startupdate
string

If this is a startup profile, this is the date that CAPA expects the airline to start operations. Note that this is a string and not a date field as the contents will vary depending on how accurate we can get.

Applies to:

  • airlines
failedstartup
boolean

True if this profile is classified as a failed startup.

Applies to:

  • airlines
grounded
boolean

True if this profile is classified as a grounded airline.

Applies to:

  • airlines
object

If the profile has a country associated with it, this is the country details.

id
required
integer

Country profile ID.

code
required
string

2-letter country code.

name
required
string

Country name.

url
required
string

Country profile URL.

schengen
required
boolean

True if this country is part of the Schengen Agreement.

object

Region info for the profile.

Applies to:

  • airlines
  • airports
id
required
string

Region ID.

name
required
string

Region name.

code
string

3-letter region code.

carriesfreight
boolean

On airline profiles, this will be true if the airline carries freight.

Applies to:

  • airlines
hidetraffic
boolean

This will be true if the profile's traffic data needs to be hidden.

hidetrafficmulti
Array of strings

This contains the date frequency of any profile's traffic data that needs to be hidden.

  • M: Monthly reports
  • Q: Quarterly reports
  • HY: Half-annual reports
  • FY: Annual reports
hidefinancial
boolean

This will be true if the profile's financial data needs to be hidden.

hidefinancialmulti
Array of strings

This contains the date frequency of any profile's financial data that needs to be hidden.

  • M: Monthly reports
  • Q: Quarterly reports
  • HY: Half-annual reports
  • FY: Annual reports
hidetourismmulti
Array of strings

This contains the date frequency of any profile's tourism data that needs to be hidden.

  • M: Monthly reports
  • Q: Quarterly reports
  • HY: Half-annual reports
  • FY: Annual reports
hasschedules
boolean

On airline profiles, this will be true if the airline has schedules data for the current week.

Applies to:

  • airlines
object

If the airline is part of an airline group, here is the group details.

Applies to:

  • airlines
id
required
integer

Airline group ID.

type
required
integer

Airline group type ID.

name
required
string

Airline group name.

majority
required
boolean

True if the airline group is a majority owner of this profile.

financial_year_end
required
integer

Month number that the airline group's financial year ends.

traffic_year_end
required
integer

Month number that the airline group's traffic year ends.

currency
required
string

Currency that the airline's financials are in.

showTrafficYTD
boolean

If true, the CAPA front-end calculates the Year-to-Date values for traffic where the full year's data is not available.

hidetraffic
boolean

This will be true if the airline group's traffic data needs to be hidden.

hidefinancial
boolean

This will be true if the airline group's financial data needs to be hidden.

url
required
string

Airline group profile URL.

object

Applies to: * airlines

id
required
integer

Alliance profile ID.

type
required
integer

Alliance profile type.

joined
required
integer

Year that the airline joined this alliance.

status
required
string

Airline's status within the alliance.

name
required
string

Alliance name.

url
required
string

Alliance profile URL.

ownership
string

String describing the profile's ownership status.

Applies to:

  • airlines
status
string

String describing the airline's status.

Applies to:

  • airlines
object

Applies to:

  • airlines
  • airports
domestic
required
boolean

True if this airline has a domestic network.

international
required
string

True if this airline has an international network.

image
string

Profile image (will most likely be a logo or a flag). More information on resizing images. Note that the image URL will always end with a question mark followed by a number - this is so cached old images are not served up by accident.

tags
required
Array of strings

Tags that news/analysis in the profile should match. Note that these are merged with any tags found in the category key.

trafficsource
string

String describing where the traffic reports for this profile are sourced from.

Applies to:

  • airports
object

Applies to:

  • airports
id
required
integer

City ID.

name
required
string

City name.

code
required
string

City IATA code.

state
required
string

City state.

required
Array of objects

Array of other airports located in the same city.

Array
id
required
integer

Airport profile ID.

name
required
string

Airport profile name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
string

Airport profile URL.

disabled
boolean

True if this profile is disabled.

Applies to:

  • airports
ceased
boolean

An easier way to tell if an airport is active or not - if it's true then the airport has ceased operations.

Applies to:

  • airports
Array of objects

Applies to:

  • airports
Array
length
required
string

Length (in metres) of the runway.

width
required
string

Width (in metres) of the runway.

area
required
string

Area (square metres) of the runway.

classification
string
Enum: "primary" "secondary"

Denotes whether an airport is primary or secondary. If omitted it means no classification has been made.

Applies to:

  • airports
code
string

Country or region code.

Applies to:

  • countries
  • regions
  • metaregions
object
latitude
required
number

Latitude of where this profile is located.

Applies to:

  • airlines (location of airport hub)
  • airports
  • countries
  • regions
longitude
required
number

Longitude of where this profile is located.

Applies to:

  • airlines (location of airport hub)
  • airports
  • countries
  • regions
object

Metaregion info.

Applies to:

  • regions
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

fullname
string

If this key exists, it is the unabbreviated name of the profile. For example, the name key for the ACI profile is ACI, but the fullname key is Airports Council International (ACI World).

Array of objects

An array containing details of the group's subsidiaries.

Applies to:

  • airline groups
Array
id
required
integer

Airline profile ID.

type
required
integer

Airline profile type.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

majority
required
string

True if the group has a majority ownership of this airline.

url
required
string

Airline profile URL.

founded
integer

Year the alliance was founded.

Applies to:

  • alliances
object

Applies to:

  • suppliers
id
required
integer

Industry sector ID.

name
required
string

Industry sector name.

Array of objects

Airports the investor has an interest in.

Applies to:

  • investors
Array
id
required
integer

Airport ID.

type
required
integer

Airport type ID.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

name
required
string

Airport name.

url
required
string

Airport profile URL.

object

Airport location.

latitude
required
number

Airport latitude.

longitude
required
number

Airport longitude.

type
string

Investor type.

Applies to:

  • investors
investment
integer

Amount of investment (USD) going into the airport.

Applies to:

  • new airports
owner
string

Airport owner name.

throughput
Array of integers

Expected PAX throughput. If this array has two entries, the first one is the initial throughput, and the last one is the expected throughput once completed. If there's only one item in the array then it's the throughput once completed.

Applies to:

  • new airports
facilitysize
string

Facility size.

Applies to:

  • new airports
cargovolume
string

Expected cargo volume at the airport.

Applies to:

  • new airports
object

Terminal details.

Applies to:

  • new airports
width
required
integer

Width (metres) of the terminal.

Zero if unknown.

length
required
integer

Length (metres) of the terminal.

Zero if unknown.

area
required
integer

Area (square metres) of the terminal.

Zero if unknown.

completion
string <date>

Date the airport is expected to be built by.

Applies to:

  • new airports
atcos
integer

Number of Air Transport Control Officers.

Applies to

  • air traffic management
employees
integer

Number of employees.

Applies to

  • air traffic management
accs
integer

Number of Area Control Centres. Zero if unknown.

Applies to

  • air traffic management
towers
integer

Number of air traffic control towers.

Applies to

  • air traffic management
members
string

A comma-separated list of members.

Applies to:

  • government bodies
url
required
string

Profile URL.

Array of objects

If this array exists, it contains a list of profiles that are considered "parents" of this profile.

Array
id
required
integer

Parent profile ID.

type
required
integer

Parent profile type ID.

name
required
string

Parent profile name.

url
required
string

Parent profile's URL.

iata
required
string

Parent profile IATA code (if exists).

icao
required
string

Parent profile ICAO code (if exists).

financial_year_end
integer

Month the parent profile's financial year ends.

traffic_year_end
required
integer

Month the parent profile's traffic reporting year ends.

currency
required
string

Currency that the parent profile reports in (if known).

Array of objects

Array of ground/cargo handlers at the airport.

Applies to:

  • airports
Array
id
required
integer

Ground handler profile ID.

type
required
integer

Ground handler profile type ID.

name
required
string

Ground handler name.

iata
required
string

Ground handler IATA code (if available).

icao
required
string

Ground handler ICAO code (if available).

url
required
string

Ground handler profile URL.

Array of objects

List of fuel suppliers at the airport.

Applies to:

  • airports
Array
id
required
integer

Fuel supplier profile ID.

type
required
integer

Fuel supplier profile type ID.

name
required
string

Fuel supplier name.

url
required
string

Fuel supplier profile URL.

object

List of airports that the supplier/MRO has bases at.

Applies to:

  • suppliers
id
required
integer

Profile ID.

type
required
integer

Profile type ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

latitude
required
number

Airport latitude.

longitude
required
number

Airport longitude.

url
required
string

Airport profile URL.

object

List of airports that the supplier supplies fuel to.

Applies to:

  • suppliers
id
required
integer

Airport ID.

type
required
integer

Airport profile type.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

latitude
required
number

Airport latitude.

longitude
required
number

Airport longitude

url
required
string

Airport profile URL.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of aircraft deliveries for a profile

This returns a list of aircraft due for delivery for a profile.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
required
object
id
required
integer

Aircraft model ID.

name
required
string

Aircraft model name.

freighter
boolean

If true, the aircraft model is marked as a freighter.

required
Array of objects
Array
required
object

Profile that these values apply to.

id
required
integer

Profile ID.

type
integer

Profile type. If it is not set, it does not map to a CAPA profile

name
required
string

Profile name.

required
Array of objects
Array
year
required
integer

Year of delivery.

required
object

Aircraft on order details.

aircraft
required
integer

Number of aircraft on order.

seats
required
integer

Number of seats on order.

cargo
required
integer

Amount of cargo payload (kg) on order.

required
object

Aircraft on option details.

aircraft
required
integer

Number of aircraft on option.

seats
required
integer

Number of seats on option.

cargo
required
integer

Amount of cargo payload (kg) on option.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a summarised list of aircraft for a profile

This returns a summary of the aircraft in use by a profile for the current week.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
date
string <date>

ISO8601 date that the aircraft have to be active on to be included in the list. If blank, it defaults to the current date.

Responses

Response Schema: application/json
required
Array of objects
Array
required
object

Size details for the aircraft.

id
required
integer

Size ID.

name
required
string

Size name (eg. "narrowbody jet").

hasSeats
required
boolean

True if the aircraft has seat counts.

required
object
id
required
integer

Aircraft manufacturer ID.

name
required
string

Aircraft manufacturer name.

object
id
required
integer

Aircraft model ID.

name
required
string

Aircraft model name.

required
object
id
required
integer

Aircraft variant ID.

name
required
string

Aircraft variant name.

required
object
id
required
integer

Aircraft configuration ID.

required
object

Details of aircraft in service.

aircraft
required
integer

Total number of aircraft (of this variant) in service.

seats
required
integer

Total number of seats in service.

payload
required
integer

Total cargo payload (kg) in service.

ages
Array of integers
required
object

Values for aircraft owned by the operator.

aircraft
required
integer

Number of aircraft owned by the operator in service.

seats
required
integer

Number of seats owned by the operator in service.

payload
required
integer

Amount of cargo payload (kg) owned by the operator in service.

ages
Array of integers
required
object

Values for aircraft leased by the operator.

aircraft
required
integer

Number of aircraft leased by the operator in service.

seats
required
integer

Number of seats leased by the operator in service.

payload
required
integer

Amount of cargo payload (kg) leased by the operator in service.

ages
Array of integers
required
object

Details of aircraft on order.

aircraft
required
integer

Total aircraft on order.

dates
boolean

If this is set to true, it means the aircraft has a delivery date and is a freighter.

seats
required
integer

Total seats on order.

payload
required
integer

Total cargo payload (kg) on order.

object

Values for aircraft owned by the operator.

aircraft
required
integer

Number of aircraft owned by the operator on order.

seats
required
integer

Number of seats owned by the operator on order.

payload
required
integer

Amount of cargo payload (kg) owned by the operator on order.

object

Values for aircraft leased by the operator.

aircraft
required
integer

Number of aircraft leased by the operator on order.

seats
required
integer

Number of seats leased by the operator on order.

payload
required
integer

Amount of cargo payload (kg) leased by the operator on order.

required
object

Details of aircraft in storage.

aircraft
required
integer

Number of aircraft in storage.

seats
required
integer

Number of seats in storage.

payload
required
integer

Amount of cargo payload (kg) in storage.

ages
Array of integers
object

Values for aircraft owned by the operator.

aircraft
required
integer

Number of aircraft owned by the operator in storage.

seats
required
integer

Number of seats owned by the operator in storage.

payload
required
integer

Amount of cargo payload (kg) owned by the operator in storage.

ages
Array of integers
object

Values for aircraft leased by the operator.

aircraft
required
integer

Number of aircraft leased by the operator in storage.

seats
required
integer

Number of seats leased by the operator in storage.

payload
required
integer

Amount of cargo payload (kg) leased by the operator in storage.

ages
Array of integers
age
required
number

Average age of this variant.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of aircraft for a profile

This returns a list of basic information for an aircraft for a profile.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
date
string <date>

ISO8601 date that the aircraft have to be active on to be included in the list. If blank, it defaults to the current date.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Aircraft manufacturer ID.

name
required
string

Aircraft manufacturer name.

required
Array of objects

A list of aircraft models by this manufacturer.

Array
required
object

Size details (widebody/narrowbody etc).

id
required
integer

Size ID.

name
required
string

Size name.

name
required
string

Model name.

required
Array of objects

A list of variants of this model.

Array
id
required
integer

Variant ID.

name
required
string

Variant name.

object

Config info.

id
required
integer

Configuration ID.

required
Array of objects

A list of the actual aircraft of this variant.

Array
id
required
integer

Aircraft ID.

tail
required
string

Aircraft tail/registration number.

serial
required
string

Aircraft serial number.

required
object

Details about the initial delivery date of the aircraft.

date
required
string <date>

ISO8601 date of delivery. Note that if the aircraft has not been delivered yet, this should be viewed as an estimate. The date may also be incomplete - values like 2017-02-00 are possible, in which case it means we only know the month of delivery but not the day itself.

year
required
integer

Year of delivery.

month
required
integer

Month of delivery.

required
object

Date of manufacture details.

date
required
string <date>

ISO8601 date of when the aircraft was manufactured. Note that this will never have an actual day - the day value will always be 01.

year
required
integer

Year of manufacture.

month
required
string <date>

Month of manufacture.

day
required
integer

Day of manufacture. This will always be 1.

required
object

Engine details.

name
required
string

Engine name.

manufacturer
required
string

Engine manufacturer name.

required
object

The most recent event to happen to the aircraft.

id
required
integer

Event ID.

name
required
string

Event name.

required
object

Status information.

id
required
integer

Status ID.

object

Seat configuration information for the aircraft.

fclass
required
integer

Number of first class seats.

bclass
required
integer

Number of business class seats.

peclass
required
integer

Number of premium economy class seats.

eclass
required
integer

Number of economy class seats.

payload
required
integer

Expected cargo payload in kilograms.

object

Lessor details (if any).

id
required
integer

Lessor ID.

name
required
string

Lessor name.

airline
required
boolean

True if the lessor is an airline, false if it's just a normal lessor.

url
required
string

Lessor profile URL.

iata
required
string

Lessor IATA code.

icao
required
string

Lessor ICAO code.

required
object

Sublessor details (if any).

id
required
integer

Sublessor ID.

airline
required
boolean

True if sublessor is an airline, false if it's a normal lessor.

object

Details of lessor operating the aircraft (on lessor profile searches, this is always going to be the same as the main lessor profile).

id
required
integer

Lessor ID.

name
required
string

Lessor name.

url
required
string

Lessor profile URL.

hidden
required
boolean

True if this is a hidden profile for whatever reason.

required
object

Operator country details.

id
required
integer

Country ID.

name
required
string

Country name.

code
string

2-letter country code.

url
required
string

Country profile URL.

required
object

Operator region details.

id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

Region code.

url
required
string

Region profile URL.

required
object

Operator metaregion details.

id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

Metaregion profile URL.

object

Details of the company operating the aircraft (if set, this means the company is not a CAPA profile).

id
required
integer

Company ID.

name
required
string

Company name.

required
object

Operator country details.

id
required
integer

Country ID.

name
required
string

Country name.

code
string

2-letter country code.

url
required
string

Country profile URL.

required
object

Operator region details.

id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

Region code.

url
required
string

Region profile URL.

required
object

Operator metaregion details.

id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

Metaregion profile URL.

required
object

Details of airline operating the aircraft (on airline profile searches, this is always going to be the same as the main airline profile).

id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

hidden
required
boolean

True if this is a hidden profile for whatever reason.

required
object

Operator country details.

id
required
integer

Country ID.

name
required
string

Country name.

code
string

2-letter country code.

url
required
string

Country profile URL.

required
object

Operator region details.

id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

Region code.

url
required
string

Region profile URL.

required
object

Operator metaregion details.

id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

Metaregion profile URL.

object

Most recent valuation details (if user has access to them).

year
required
integer

Most recent valuation year.

month
required
integer

Most recent valuation month.

market
required
integer

Market value (USD).

base
required
integer

Base value (USD).

lease
required
integer

Monthly lease rate (USD).

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of departure airports for an airline/airport/country

Returns a list of possible departures for a given week.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
week
string <date>

ISO8601 date string representing the first day of the week. Note that weeks are treated as starting on a Monday.

Defaults to the current week.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of destination airports for an airline/airport/country

Returns a list of possible destinations for a given week.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
week
string <date>

ISO8601 date string representing the first day of the week. Note that weeks are treated as starting on a Monday.

Defaults to the current week.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

object
max
required
integer

The maximum number of destinations that any airport/airline/country has.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get a list of destination airports for an airline/airport/country

Returns a list of possible destinations for a given week.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

dep
integer

ID of a departure airport to filter the resulting destinations by

query Parameters
week
string <date>

ISO8601 date string representing the first day of the week. Note that weeks are treated as starting on a Monday.

Defaults to the current week.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

object
max
required
integer

The maximum number of destinations that any airport/airline/country has.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get a list of aircraft operating on schedules

This will return a list of aircraft that are operating on schedules.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
airport
integer

If you're looking up schedules for an airline or country, add an airport ID to filter for aircraft that only operate on routes departing/arriving at that airport.

week
string <date>

ISO8601 date specifying the week that this applies to. Must be a Monday. If omitted, defaults to the current week.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Aircraft ID. Note this does not match anything in the CAPA Fleet Database.

name
required
string

Aircraft name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of schedules for an airline/airport

Look up schedules for airlines/airports. Schedules are provided by OAG and are subject to separate licensing agreements. Contact CAPA for more information.

At this point in time, schedules can be searched 2 weeks in the past up to 26 weeks in the future - accuracy lessens the further into the future you go. Beyond 23 weeks things get murky.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
dep
integer

Filter results for a given departure airport ID. Only applies to airline schedules.

arr
integer

Filter results for a given arrival airport ID. Only applies to airline schedules.

airline
integer

Filter results by airline ID. Only applies to airport schedules.

codeshare
integer

Filter results to show only flights running the selected airline ID as a codeshare.

airport
integer

Filter results so schedules either depart or arrive from this airport ID. Only applies to airport schedules.

week
string <date>

ISO8601 string of the week to look up schedules for. The date sent needs to be a Monday. This will override the from and to parameters.

from
string <date>

ISO8601 string of the date to look up schedules from.

to
string <date>

ISO8601 string of the date to look up schedules to.

ftype
string

Flight type.

page
integer

Zero-based page number of results to return.

num
integer

Number of results to return per page. If this is not sent, all results are returned (can be huge).

sort
string
Enum: "arriving" "dftime" "aftime" "atime" "dtime"

Schedules sorting. Can be one of the following values:

  • arriving - arriving airport name
  • dftime - descending flight time
  • aftime - ascending flight time
  • atime - ascending arrival time
  • dtime - ascending departure time
stype
string

Service type.

atype
integer

Aircraft ID to filter schedules by. These are different IDs to what are in the CAPA Fleet Database. Use IDs returned from ---

peak
string
Enum: "peak" "nonpeak" "arrpeak" "arrnonpeak"

Filter by peak/offpeak schedules. Possible values:

  • peak - schedules departing in peak times
  • nonpeak - schedules departing in offpeak times
  • arrpeak - schedules arriving in peak times
  • arrnonpeak - schedules arriving in offpeak times

If filtering by peak/offpeak, you need to send values through that define when peak/offpeak is - see below.

mfrom
integer

The hour that morning peak starts.

mto
integer

The hour that morning peak ends. Note that whatever value is given, 59 minutes past the hour is treated as the "end." So if you give a value of 8, then 8:59 is treated as the time that peak hour ends.

afrom
integer

The hour that afternoon peak starts.

ato
integer

The hour that afternoon peak ends. Note that whatever value is given, 59 minutes past the hour is treated as the "end." So if you give a value of 18, then 18:59 is treated as the time that peak hour ends.

Responses

Response Schema: application/json
required
Array of objects (Schedule)
Array
id
required
integer

Internal schedule ID number.

flight
required
integer

Flight number.

includedSchedule
boolean

If true, this indicates the flight does not have a restriction that prevents it from being applied to the capacity calculations.

i.e. the flight either has no restrictions or is marked with 'B', 'C' or 'F' restriction as described in the traffic restriction codes.

object

Details of the airline operating the flight.

id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
object

If the airline is in an alliance, details will be here.

id
required
integer

Alliance ID.

name
required
string

Alliance name.

required
object

If the airline is operating the flight as part of a wetlease, this is the wetlease details.

id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

object

Departure details.

id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
required
string

Airport profile URL.

terminal
required
string

Departing terminal (if known).

time
required
string

Departure time.

required
object

Departing country details.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

object

Arrival details.

id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
required
string

Airport profile URL.

terminal
required
string

Arriving terminal (if known).

time
required
string

Arriving time.

required
object

Arrival country details.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

required
object

Aircraft details.

id
required
integer

Aircraft ID. Does not match CAPA Fleet Database.

type
required
string

Aircraft IATA code.

name
required
string

Aircraft name.

required
object

Schedule effective dates.

from
required
string <date>

This schedule is active from this date.

to
required
string <date>

This schedule expires on this date.

days
required
integer

Bitwise mask of the days of the week that this schedule operates on. The position of each bit tells the day of the week it operates.

So 1 bitshifted 0 times gives a decimal value of 1, which means the schedule operated on Sunday only (this assumes Sunday = 0).

A decimal value of 3 would translate to 11 in binary, mean Sunday and Monday. Decimal 2 in binary would be 10, which would mean Monday only (because Monday is the 1st day of the week if we're counting from zero (Sunday being the 0th day of the week), and the binary 10 means a bit is set for the 1st position).

day
required
integer

If a schedule departs and arrives on the same day, this is 0. If it arrives the next day, it's 1. If it arrives 2 days later, it's 2. In rare cases where the schedule arrives before it departs (due to flying against a timezone), this will be -1.

type
required
string

Schedule type. See schedule types for the full list.

restrictions
required
string

Any traffic restriction codes. See traffic restriction codes for the full list.

required
object

Seat details. Note that these are estimated based on values from the CAPA Fleet Database.

fclass
required
integer

Number of first class seats.

bclass
required
integer

Number of business class seats.

peclass
required
integer

Number of premium economy class seats.

eclass
required
integer

Number of economy class seats.

required
object

Length of time flight takes.

air
required
integer

Number of minutes spent in the air. Currently this is the entire length of the flight.

ground
required
integer

Number of minutes spent on the ground. Currently this will always be 0.

required
object

Length of the flight (in kilometres).

route
required
integer

Length of the route (in kilometres).

flight
required
integer

Length of the flight (in kilometres). Currently this is always identical to the length of the route.

payload
required
integer

Cargo payload (kg). This is estimated based on numbers from the CAPA Fleet Database.

required
Array of objects

If any airlines operate this flight via codeshare, their details are here.

Array
id
required
integer

Internal codeshare schedule ID.

flight
required
integer

Codeshare flight number.

required
object

Airline listing the codeshare.

id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

stops
required
Array of objects (Schedule)

If the flight has any stopovers, the flights that make up this entire schedule will be listed here in order.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List airlines serving a country and their codeshare partners

This will return a list of airlines currently serving a country, as well as any codeshare partners under those routes.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
string

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
Array of objects
Array
id
required
integer

Codeshare airline ID.

type
required
integer
Value: 1

Codeshare airline type ID (will always be 1).

name
required
string

Codeshare airline name.

iata
required
string

Codeshare airline IATA code.

icao
required
string

Codeshare airline ICAO code.

url
required
string

Codeshare airline profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List codeshares by airline/airport/country

This will return a list of airlines with codeshare flights, grouped by the airline running the flight, the departing airport or the countries of either.

Authorizations:
OAuth2
query Parameters
type
string
Enum: "airline" "airlinecountry" "airport" "country"

Identifies the profile type to group codeshares by

  • airline - groups by the airlines operating the codeshare routes
  • airlinecountry - groups by the countries the airlines operating the codeshare routes are based in
  • airport - groups by the airports the codeshare routes depart from
  • country - groups by the countries the airports the codeshare routes depart from are located in

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
string

Grouping profile ID.

name
required
string

Grouping profile name.

iata
string

Grouping profile IATA code (if applicable to profile type).

icao
string

Grouping profile ICAO code (if applicable to profile type).

url
required
string

Grouping profile URL.

required
Array of objects
Array
id
required
integer

Codeshare airline ID.

type
required
integer
Value: 1

Codeshare airline type ID (will always be 1).

name
required
string

Codeshare airline name.

iata
required
string

Codeshare airline IATA code.

icao
required
string

Codeshare airline ICAO code.

url
required
string

Codeshare airline profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of airports served, grouped by region and country

This returns a list of all destinations that are being served by the specified airline/airport for the given week.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
week
required
string <date>

ISO8601 date of the week start. Must be a Monday.

Responses

Response Schema: application/json
object
required
Array of objects (Served)

A list of airports being served by scheduled flights.

Array
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

Metaregion profile URL.

required
Array of objects

An array of regions.

Array
id
required
string

Region ID.

name
required
string

Region name.

url
required
string

Region profile URL.

required
Array of objects

An array of countries.

Array
id
required
integer

Country ID.

name
required
string

Country name.

url
required
string

Country profile URL.

required
Array of objects

An array of airports.

Array
id
required
integer

Airport ID.

name
required
string

Airport name.

url
required
string

Airport URL.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

types
required
Array of strings

An array of service types. See the full list here.

Array of objects (Served)

A list of airports being served by codeshare flights. Note that this key is only returned when called from an airline profile.

Array
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

Metaregion profile URL.

required
Array of objects

An array of regions.

Array
id
required
string

Region ID.

name
required
string

Region name.

url
required
string

Region profile URL.

required
Array of objects

An array of countries.

Array
id
required
integer

Country ID.

name
required
string

Country name.

url
required
string

Country profile URL.

required
Array of objects

An array of airports.

Array
id
required
integer

Airport ID.

name
required
string

Airport name.

url
required
string

Airport URL.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

types
required
Array of strings

An array of service types. See the full list here.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get capacity data for a profile

This will return capacity data for a given profile.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
week
required
string <date>

ISO8601 date of a week to get capacity for. Date must be a Monday.

Responses

Response Schema: application/json
required
object
required
Array of objects (CapacityValue)
Array
required
object

Seat values.

fclass
required
integer

Number of first class eats.

bclass
required
integer

Number of business class seats.

peclass
required
integer

Number of premium economy class seats.

eclass
required
integer

Number of economy class seats.

total
required
integer

Total number of seats. Note that this value may not always be equal to fclass + bclass + peclass + eclass on older records, as we originally did not count seats by class, only their totals.

asks
required
integer

Number of ASKs.

required
object

Freight values. On older records these may be empty.

belly
required
integer

Kilograms carried in the bellyhold of a passenger jet.

cargo
required
integer

Kilograms carried in a freighter.

total
required
integer

Total freight carried.

aftks
required
integer

Total AFTKs.

required
object

Frequency details.

dep
required
integer

Number of departing frequencies.

arr
required
integer

Number of arriving frequencies.

dep
required
integer

Departure airport ID.

arr
required
integer

Arrival airport ID.

airline
integer

Airline ID.

required
Array of objects (CapacityAirline)
Array
id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
object

Business model details.

id
required
integer

Business model ID.

name
required
string

Business model name.

required
object

Alliance details.

id
required
integer

Alliance ID.

name
required
string

Alliance name.

required
object

Airline's country details.

id
required
integer

Country ID.

required
Array of objects (CapacityAirport)
Array
id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
required
string

Airport profile URL.

required
object

City details.

id
required
integer

City ID.

name
required
string

City name.

required
object

Country details.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

required
object

Region details.

id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

Region code.

url
required
string

Region profile URL.

required
object

Metaregion details.

id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

Metaregion profile URL.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get cargo capacity for a week

This will return basic cargo capacity values for the week given. Cargo payloads are estimated based on the size of an aircraft.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
week
required
string <date>

ISO8601 date of the week start. Must be a Monday.

Responses

Response Schema: application/json
required
object

Cargo capacity details.

required
object

International cargo capacity details.

required
object

International cargo carried in the belly of a passenger jet.

aftks
required
integer

International AFTKs for cargo carried in the belly of a passenger jet.

payload
required
integer

Amount of international cargo (kg) carried in the belly of a passenger jet.

required
object

International cargo carried by freighter.

aftks
required
integer

International AFTKs by freighter.

payload
required
integer

International cargo (kg) carried by freighter.

required
object

Domestic cargo capacity details.

required
object

Domestic cargo carried in the belly of a passenger jet.

aftks
required
integer

Domestic AFTKs for cargo carried in the belly of a passenger jet.

payload
required
integer

Amount of domestic cargo (kg) carried in the belly of a passenger jet.

required
object

Domestic cargo carried by freighter.

aftks
required
integer

Domestic AFTKs by freighter.

payload
required
integer

Domestic cargo (kg) carried by freighter.

Response samples

Content type
application/json
{
  • "data": {
    }
}

List capacity for an airport, grouped by flight length

This will return capacity values for an airport, grouped by the length (as in time, not distance) of the flight. The values returned are totals for the current week, beginning on Monday.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
week
required
string <date>

ISO8601 date of the week start. Must be a Monday.

Responses

Response Schema: application/json
required
Array of objects
Array
ftime
required
number

Flight time in hours.

Note that the value given covers flights up to 30 minutes before it. So 0.5 covers zero minutes up until 29 minutes. 1 covers flights from 30 minutes up to 59 minutes.

time
required
string

Flight time as a human-readable string.

required
object

Domestic capacity values.

seats
required
integer

Domestic seats.

asks
required
integer

Domestic ASKs.

freq
required
integer

Domestic departing frequencies.

required
object

International capacity values.

seats
required
integer

International seats.

asks
required
integer

International ASKs.

freq
required
integer

International departing frequencies.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get all routes for an airline for the current week for an airline/airport

For airline and airport profiles, this will return a list of all valid routes for the current week. Note that this only counts routes flown by the airline itself, not codeshares.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
week
required
string <date>

ISO8601 date of the week start. Must be a Monday. If not set, it defaults to the Monday of the current week.

Responses

Response Schema: application/json
Array
required
object

Departure airport.

id
required
integer

Airport profile ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

url
required
string

Airport profile URL.

required
object

Details on the airport's location.

latitude
required
number

Airport's latitude (decimal degrees).

longitude
required
number

Airport's longitude (decimal degrees).

required
object

Arrival airport.

id
required
integer

Airport profile ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

url
required
string

Airport profile URL.

required
object

Details on the airport's location.

latitude
required
number

Airport's latitude (decimal degrees).

longitude
required
number

Airport's longitude (decimal degrees).

required
Array of objects

Aircraft types.

Array
id
required
integer

Aircraft type ID.

type
required
string

Aircraft type name.

airlineid
required
integer

Airline ID.

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of contacts for a specified profile

This will return a list of contact data for the specified profile.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Contact ID.

name
required
string

Name of the person.

position
required
string

Job title or position of the person.

updated
required
integer

UNIX timestamp of when this record was last updated.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List departures/arrivals per hour for an airline at an airport

This returns a list of the number of departures/arrivals per hour an airport for a given day.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
date
string <date>

ISO8601 date specifying a day that you want slots for. Defaults to the Monday at the start of the current week.

airport
required
integer

An airport ID that you want to receive slots for.

Responses

Response Schema: application/json
required
Array of objects
Array
hour
required
integer [ 0 .. 23 ]

Hour number. Zero means from midnight until 12:59AM. 13 would mean from 1PM to 1:59PM.

dep
required
integer

Number of departures.

arr
required
integer

Number of arrivals.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get historical capacity data for a profile

This will return capacity data for a given profile.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
week
required
string <date>

ISO8601 date of the week these values apply to. Weeks are treated as having started on a Monday.

required
object (CapacitySummaryValue)
seats
required
integer

Number of seats flown.

asks
required
integer

Number of ASKs.

payload
required
integer

Amount of cargo (kg) flown.

aftks
required
integer

Number of AFTKs.

depfreq
required
integer

Number of departing frequencies.

arrfreq
integer

Number of arriving frequencies.

IMPORTANT: This key is not included when pulling down values for regions.

required
object (CapacitySummaryValue)
seats
required
integer

Number of seats flown.

asks
required
integer

Number of ASKs.

payload
required
integer

Amount of cargo (kg) flown.

aftks
required
integer

Number of AFTKs.

depfreq
required
integer

Number of departing frequencies.

arrfreq
integer

Number of arriving frequencies.

IMPORTANT: This key is not included when pulling down values for regions.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List an airline's codeshare partners

Returns a list of an airline's codeshare partners (for the current week). Note that the output for this will change soon.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
name
required
string

Airline name.

code
required
string

Airline IATA code, or ICAO code if IATA code is non-existent.

url
required
string

Airline profile URL.

required
object
max
required
integer

The highest number of codeshare partners that any airline has.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get rankings for a profile

Get ranking values for a profile for the current week.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
object
required
object (ProfileRankResult)
seats
required
integer

Seat rank number (ranked by number of available seats for the current week).

asks
required
integer

ASKs rank number (ranked by number of ASKs for the current week).

freight
required
integer

Freight rank number (ranked by cargo payload kg for the current week).

aftks
required
integer

AFTKs rank number (ranked by AFTKs for the current week).

frequency
required
integer

Frequency rank number (ranked by number of departing frequencies for the current week).

total
required
integer

Total number of entities being ranked.

required
object

These are the values that make up the profile ranking.

seats
required
integer

Number of seats for the current week.

asks
required
integer

Number of ASKs for the current week.

freight
required
integer

Amount of cargo (kg) for the current week.

aftks
required
integer

Number of AFTKs for the current week.

frequency
required
integer

Number of departing frequencies for the current week.

required
object (ProfileRankResult)
seats
required
integer

Seat rank number (ranked by number of available seats for the current week).

asks
required
integer

ASKs rank number (ranked by number of ASKs for the current week).

freight
required
integer

Freight rank number (ranked by cargo payload kg for the current week).

aftks
required
integer

AFTKs rank number (ranked by AFTKs for the current week).

frequency
required
integer

Frequency rank number (ranked by number of departing frequencies for the current week).

total
required
integer

Total number of entities being ranked.

required
object

These are the values that make up the profile ranking.

seats
required
integer

Number of seats for the current week.

asks
required
integer

Number of ASKs for the current week.

freight
required
integer

Amount of cargo (kg) for the current week.

aftks
required
integer

Number of AFTKs for the current week.

frequency
required
integer

Number of departing frequencies for the current week.

required
object (ProfileRankResult)
seats
required
integer

Seat rank number (ranked by number of available seats for the current week).

asks
required
integer

ASKs rank number (ranked by number of ASKs for the current week).

freight
required
integer

Freight rank number (ranked by cargo payload kg for the current week).

aftks
required
integer

AFTKs rank number (ranked by AFTKs for the current week).

frequency
required
integer

Frequency rank number (ranked by number of departing frequencies for the current week).

total
required
integer

Total number of entities being ranked.

required
object

These are the values that make up the profile ranking.

seats
required
integer

Number of seats for the current week.

asks
required
integer

Number of ASKs for the current week.

freight
required
integer

Amount of cargo (kg) for the current week.

aftks
required
integer

Number of AFTKs for the current week.

frequency
required
integer

Number of departing frequencies for the current week.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get outlook data for an airline

Returns seat and cargo capacity values for a given week and 12 weeks in the future.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
week
required
string <date>

ISO8601 date of the week start. Must be a Monday.

Responses

Response Schema: application/json
required
Array of objects
Array
week
required
integer

Number of weeks from now that the values apply to.

seats
required
integer

Number of seats available for the week.

cargo
required
integer

Kilograms of cargo payload for the week.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List airlines currently serving an airport/country

This will return a list of airlines serving an airport/country directly and via codeshare.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

query Parameters
airport
integer

Filters the results to airlines that arrive to/depart from the airport ID.

Responses

Response Schema: application/json
required
object
required
Array of objects

A list of airlines currently serving the destination directly.

Array
id
required
integer

Airline profile ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
Array of objects

A list of airlines currently serving the destination via codeshare.

Array
id
required
integer

Airline profile ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
object
required
object
direct
required
integer

The most destinations directly served out of all airports/countries.

codeshare
required
integer

The most destinations served by codeshare out of all airports/countries.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List airlines based within a country/region

This will return a list of airlines that are based within a country/region (for the current week).

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
string

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Ownership data for an airport

Get basic ownership data for an airport.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
owner
required
string

Owner's name.

percentage
required
number [ 0 .. 100 ]

The percentage owned by the owner, from 0-100.

efrom
required
string <date>

Effective from date for this record. Will be NULL if we have no date data available.

eto
required
string <date>

Effective to date for this record. Will be NULL if we have no date data available.

comment
required
string

HTML string of any notes/comments about this record.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List customers for a lessor

This returns a list of all current customers for a lessor.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

type
required
integer

Profile type ID.

name
required
string

Profile name.

iata
required
string

Profile IATA code (if existing).

icao
required
string

Profile ICAO code (if existing).

url
required
string

Profile URL.

hidden
required
boolean

True if the profile is currently being treated as hidden.

object
max
required
integer

The maximum number of customers that any lessor has.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

View percentages of flights to/from a country

The "market share" resource counts the number of flights going to/from a country (on country profiles) for the current week.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects

A list of countries that have services to/from the given country (aka. "paired countries").

Array
id
required
integer

Paired country ID.

name
required
string

Paired country name.

url
required
string

Paired country profile URL.

required
object
local
required
integer

Number of seats being flown to/from the paired country by airlines local to the main country.

paired
required
integer

Number of seats being flown to/from the paired country by airlines local to the paired country.

other
required
integer

Number of seats being flown to/from the paired country by airlines that are based in neither the main country nor the paired country.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get members of an alliance

Return details of alliance members.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
object
required
object

Contains lists of current members/affiliates of the alliance.

required
Array of objects (AllianceAirlineProfile)

A list of current alliance members.

Array
id
required
integer

Airline profile ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

year
required
integer

Year the airline joined the alliance.

url
required
string

Airline profile URL.

required
Array of objects (AllianceAirlineProfile)

A list of current alliance affiliates.

Array
id
required
integer

Airline profile ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

year
required
integer

Year the airline joined the alliance.

url
required
string

Airline profile URL.

required
object

Contains lists of pending members/affiliates of the alliance.

required
Array of objects (AllianceAirlineProfile)

A list of pending alliance members.

Array
id
required
integer

Airline profile ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

year
required
integer

Year the airline joined the alliance.

url
required
string

Airline profile URL.

required
Array of objects (AllianceAirlineProfile)

A list of pending alliance affiliates.

Array
id
required
integer

Airline profile ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

year
required
integer

Year the airline joined the alliance.

url
required
string

Airline profile URL.

required
Array of objects

A list of former alliance members.

Array
name
required
string

Airline name.

joined
required
integer

Year airline joined alliance.

exited
required
integer

Year airline exited alliance.

reason
required
string

Reason (if any) for the airline leaving the alliance.

Response samples

Content type
application/json
{
  • "data": {
    }
}

List the countries within a region/metaregion

path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get investment information for an investor

This will return some HTML strings detailing investments that an investor has.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
object
current
required
string

HTML string detailing current investments.

previous
required
string

HTML string detailing previous investments.

future
required
string

HTML string detailing future investments.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get financial results information for an investor

This will return some HTML strings detailing an investor's financial results.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
object
results
required
string

HTML string containing investment results.

comment
required
string

HTML string containing any comments CAPA have made.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Aircraft model's variants

This will list all variants of an aircraft model and the airlines that operate them.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
object
required
Array of objects

List of variant series.

Array
id
required
integer

Variant series ID.

name
required
string

Variant series name.

manufacturer
required
string

Variant series manufacturer name.

required
Array of objects

Variants within the variant series.

Array
id
required
integer

Variant ID.

name
required
string

Variant name.

iata
required
string

Variant IATA code.

icao
required
string

Variant ICAO code.

required
object

Configuration data.

id
required
string

Configuration ID.

name
required
string

Configuration name.

winglets
required
boolean

If true, this aircraft has aftermarket winglets fitted.

engines
required
string

Number of engines.

maxpax
required
string

Maximum number of passengers.

maxcargo
required
string

Maximum amount of cargo (tonnes).

mtow
required
string

Maximum takeoff weight (tonnes).

mincrew
required
string

Minimum crew required to operate.

wingspan
required
string

Wingspan (metres).

wingarea
required
string

Wing area (square metres).

length
required
string

Length of the plane (metres).

height
required
string

Height of the plane (metres).

belly
required
string

Total belly volume (cubic metres).

maxseats
required
string

Maximum seats that can be packed in the aircraft.

cdoorheight
required
string

Cargo door height (metres).

cdoorwidth
required
string

Cargo door width (metres).

deckvolume
required
string

Cargo deck volume (cubic metres).

maxfuel
required
string

Maximum fuel the aircraft can hold (litres).

payload
required
string

Max payload that can be carried by the aircraft (tonnes).

empty
required
string

Operating empty weight (max takeoff weight minus payload and fuel, tonnes).

landing
required
string

Max landing weight (tonnes).

zfuel
required
string

Max takeoff weight minus fuel (tonnes).

range
required
string

Aircraft range with max fuel and zero payload (metres).

introduced
required
string

Date aircraft is first used in current format: if it has been converted, this is the date of conversion, otherwise it is the delivery date.

required
Array of objects

List of individual aircraft of this variant.

Array
id
required
integer

Aircraft ID.

status
required
integer

Aircraft status ID.

required
object

Aircraft manufactured date.

year
required
integer

Year aircraft was manufactured.

month
required
integer

Month aircraft was manufactured.

required
object

Last aircraft valuation update date - courtesy of ICF Truebook.

year
required
integer

Year the aircraft valuations was last updated.

month
required
integer

Month the aircraft valuations was last updated.

market
required
integer

Market value (USD) - courtesy of ICF Truebook.

base
required
integer

Base value (USD) - courtesy of ICF Truebook.

lease
required
integer

Lease Rate (USD) - courtesy of ICF Truebook.

leased
required
boolean

If true, this aircraft is currently being leased.

required
Array of objects

List of airlines.

Array
id
required
integer

Airline ID.

country
required
integer

Airline country ID.

required
Array of objects

Groupings by aircraft status.

Array
id
required
integer

Status ID.

name
required
string

Status ID.

count
required
integer

Number of aircraft with this status.

required
Array of objects

List of airlines.

Array
id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA.

icao
required
string

Airline ICAO.

url
required
string

Airline CAPA profile URL.

country
required
integer

Country ID.

required
Array of objects

List of meta-regions, regions and countries the airlines are based in.

Array
id
required
integer

Meta-region ID.

name
required
string

Meta-region name.

code
required
string

Meta-region IATA.

url
required
string

Meta-region CAPA profile URL.

required
Array of objects

Applicable regions within the meta-region.

Array
id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

Region IATA.

url
required
string

Region CAPA profile URL.

required
Array of objects

Applicable countries within the region.

Array
id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

Country IATA.

url
required
string

Country CAPA profile URL.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Profile Fleet Valuations

This will return the current fleet valuations for the given aircraft, airline, airline group or lessor profile.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects

List of variant series.

Array
id
required
integer

Variant series ID.

name
required
string

Variant series name.

manufacturer
required
string

Variant series manufacturer name.

required
Array of objects

Variants within the variant series.

Array
id
required
integer

Variant ID.

name
required
string

Variant name.

required
Array of objects

List of individual aircraft of this variant.

Array
id
required
integer

Aircraft ID.

status
required
integer

Aircraft status ID.

required
object

Aircraft manufactured date.

year
required
integer

Year aircraft was manufactured.

month
required
integer

Month aircraft was manufactured.

required
object

Last aircraft valuation update date - courtesy of ICF Truebook.

year
required
integer

Year the aircraft valuations was last updated.

month
required
integer

Month the aircraft valuations was last updated.

market
required
integer

Market value (USD) - courtesy of ICF Truebook.

base
required
integer

Base value (USD) - courtesy of ICF Truebook.

lease
required
integer

Lease Rate (USD) - courtesy of ICF Truebook.

leased
required
boolean

If true, this aircraft is currently being leased.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Profile Future Fleet Valuations

This will return the predicted future fleet valuations for the given aircraft, airline, airline group or lessor profile.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects

Dates of valuations.

Array
date
required
integer

UNIX timestamp of the date of valuation.

year
required
integer

The year the valuation was made.

month
required
integer

The month the valuation was made.

required
Array of objects

Valuations by aircraft.

Array
id
required
integer

Aircraft ID.

required
Array of objects

Valuations by year.

Array
year
required
integer

Year valuation applies to.

bv
required
integer

Base value (USD).

lr
required
integer

Lease Rate (USD).

required
object

Date range of Valuations.

Array of objects

Known valuation dates.

Array
year
required
integer

Year.

months
required
Array of integers

Months in year.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

List available files for a profile

This will return a list of documents related to a profile, like annual reports or investor presentations.

path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
file
required
string

The name of the file. Use this in conjunction with Download a file from a profile to download the file.

timestamp
required
integer

UNIX timestamp of the date the file was uploaded.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Download a file from a profile

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

filename
required
string

Name of file to download.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Reports

Get a list of reports

This will return a list of both free and paid reports. Note that pulling down more detailed info on a paid report requires using its ID as a shop item ID and getting info from there.

query Parameters
num
integer

Maximum number of results to return.

page
integer

Zero-based page index of results.

Responses

Response Schema: application/json
required
Array of objects (Report)
Array
id
required
integer

Report ID.

name
required
string

Report name.

shortdesc
string <= 255 characters

Short, one-sentence text description of the report.

description
required
string

Longer, multi-paragraph HTML description of the report.

price
number

The price of the report.

currency
string = 3 characters

3-letter code of the currency the report is in.

type
integer

The report type.

ID Type
0 A free report, available to all people with a CAPA Account.
1 A paid report that must be purchased separately.
image
string

The image URL for the report, if it is a paid report. Details on resizing images are here.

Free reports (type = 0) will not have an image URL. You can generate a thumbnail URL instead by using a URL of https://images.cdn.centreforaviation.com/files/reports/{id}/{image}

In this situation, {id} is the report ID and {image} is an image filename that is generated based upon the filename of the report, minus its extension and with a width parameter set. It is the same parameter format used for resizing images, however only the width parameter works. For example, if the report's filename is Daily_News_3.pdf then a valid image filename would be Daily_News_3-400x.jpg - this would give a 400 pixel wide thumbnail image of the first page of the report.

url
string

The URL of the report info page.

filename
integer

The name of the file itself.

timestamp
integer

A UNIX timestamp value of the last date the report file was modified. This will only appear for free reports, not paid ones.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get free report info

This gives back info on a free report. If you want to retrieve details for a paid report, you need to get it from the shop. Using a paid ID to retrieve data from here will result in a mismatch.

path Parameters
id
required
integer

Report ID.

Responses

Response Schema: application/json
required
object (Report)
id
required
integer

Report ID.

name
required
string

Report name.

shortdesc
string <= 255 characters

Short, one-sentence text description of the report.

description
required
string

Longer, multi-paragraph HTML description of the report.

price
number

The price of the report.

currency
string = 3 characters

3-letter code of the currency the report is in.

type
integer

The report type.

ID Type
0 A free report, available to all people with a CAPA Account.
1 A paid report that must be purchased separately.
image
string

The image URL for the report, if it is a paid report. Details on resizing images are here.

Free reports (type = 0) will not have an image URL. You can generate a thumbnail URL instead by using a URL of https://images.cdn.centreforaviation.com/files/reports/{id}/{image}

In this situation, {id} is the report ID and {image} is an image filename that is generated based upon the filename of the report, minus its extension and with a width parameter set. It is the same parameter format used for resizing images, however only the width parameter works. For example, if the report's filename is Daily_News_3.pdf then a valid image filename would be Daily_News_3-400x.jpg - this would give a 400 pixel wide thumbnail image of the first page of the report.

url
string

The URL of the report info page.

filename
integer

The name of the file itself.

timestamp
integer

A UNIX timestamp value of the last date the report file was modified. This will only appear for free reports, not paid ones.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Download a free report

This returns a free report. Paid reports cannot be downloaded in this way - they need to be downloaded as a shop item.

Authorizations:
OAuth2
path Parameters
id
required
integer

Report ID.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

CASK

Get the minimum/maximum years CASK data is available for

Responses

Response Schema: application/json
data
required
Array of strings

This will always be an empty array.

required
object
min
required
integer

The minimum year CASK data is available for.

max
required
integer

The maximum year CASK data is available for.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get CASK data for a year

Authorizations:
OAuth2
path Parameters
year
required
integer

The year of CASK data requested.

Responses

Response Schema: application/json
required
Array of objects
Array
region
required
integer

A regional identifier. This is not the same as the region IDs used throughout the rest of the API, and only applies to CASK data. The possible values are:

ID Region
1 Asia Pacific, Africa & Middle East
2 Europe
3 America
name
required
string

Name of the airline. Note that this may not match the name given from the profile type/ID.

id
required
integer

Profile ID (if available).

type
required
integer

Profile type ID (if available).

required
object

Country details.

name
string

Country name.

object

Business model of the airline.

id
required
integer

Business model ID.

name
required
string

Business model name.

currency
required
string = 3 characters

3-letter code of the currency the airline reports in.

year
required
integer

Year that the data applies to.

latest
required
integer

Year of the latest report used for data.

seats
required
integer

Number of seats flown. Zero if unknown.

fyend
required
integer

The month that the financial year ends in for this carrier.

conversion
required
number

The currency conversion rate we are using to calculate CASK in US cents.

opcosts
required
integer

Operating costs for the carrier (local currency). Zero if unknown.

pax
required
number

Passenger numbers (1,000s) for the carrier. Zero if unknown.

ask
required
number

ASKs (1,000s) flown by the carrier. Zero if unknown.

rpk
required
number

RPK values. Zero if unknown.

asl
required
integer

Average sector length (km).

uscask
required
number

The average CASK (cost per ASK) value for this carrier, in USD.

revenue
required
number

The carrier's revenue (1,000s, local currency). Zero if unknown.

profit
required
number

The carrier's profit (1,000s, local currency). Zero if unknown.

notes
required
string

Any notes about the record.

source
required
string

The source for this record.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Capacity

Search for possible origin airports

Get a list of possible airports flights are departing from for a given search term.

This requires either a search string or an IATA/ICAO code to search by.

Authorizations:
OAuth2
query Parameters
code
required
string

Finds airports that equals the given IATA/ICAO code.

search
required
string

Finds airports that contain the given string within their name, city, country or region.

Responses

Response Schema: application/json
Array of objects (ProfileSearchResult)
Array
rank
integer

Profile type display order (starting from 1).

id
required
integer

Profile ID.

required
object

Profile type.

id
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (if available).

icao
string

Profile ICAO code (if available).

url
string

Profile URL. This is only added for the appropriate profile types (Cities, for instance, do not have a profile page)

object

If the profile has a country linked to it, country details are here.

id
required
string

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Given an origin for a route, get a list of destinations

Authorizations:
OAuth2
query Parameters
id
integer

Departure profile ID.

integer or string

Departure profile type.

This can be an airport, country, region, metaregion or city ID. For all types that are not a city, use their profile type ID. If it is a city, use "city" as the value here.

profiles
string
Example: profiles=2-1343,2-2538

List of departure profiles. This is used when requiring the destinations for multiple possible departure points and is discarded if the type and id parameters are set.

It must take the format of a string listing each profile as [profile type ID]-[profile ID] with each profile separated by ,.

Responses

Response Schema: application/json
Array of objects (ProfileSearchResult)
Array
rank
integer

Profile type display order (starting from 1).

id
required
integer

Profile ID.

required
object

Profile type.

id
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (if available).

icao
string

Profile ICAO code (if available).

url
string

Profile URL. This is only added for the appropriate profile types (Cities, for instance, do not have a profile page)

object

If the profile has a country linked to it, country details are here.

id
required
string

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get capacity for a route

Authorizations:
OAuth2
query Parameters
dep
required
integer

Route departure profile ID.

This can be an airport, country, region, metaregion or city ID.

required
integer or string

The profile type of the departing ID.

This can be an airport, country, region, metaregion or city ID. For all types that are not a city, use their profile type ID. If it is a city, use "city" as the value here.

arr
required
integer

Route arrival profile ID.

This can be an airport, country, region, metaregion or city ID or left as 0 for global data.

required
integer or string

The profile type of the arriving ID.

This can be an airport, country, region, metaregion or city ID or left as 0 for global data. For all types that are not a city, use their profile type ID. If it is a city, use "city" as the value here.

direction
string
Enum: "oneway" "twoway"

Indicates if the flights direction is one-way, only from departing profile to arrival profile, or if it is to be two-way in both directions.

By default, it displays as one-way unles the value 'twoway' is passed in the query.

from
integer

The Unix timestamp that the capacity data starts from. It must be a Monday..

to
integer

The Unix timestamp that the capacity data ends on. It must be a Monday..

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline profile ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
object

Airline alliance details.

id
required
integer

Airline alliance ID. Zero if airline is not in an alliance.

name
required
string

Airline alliance name. Null if airline is not in an alliance.

required
object

Business model details.

id
required
integer

Airline business model ID.

name
required
string

Airline business model name.

required
object

Airline country details.

id
required
integer

Airline country ID.

name
string

Airline country name.

required
Array of objects

Array of capacity data by week.

Array
week
required
string <date>

ISO8601 date of the week this capacity data applies to. Note that all weeks are treated as having started on a Monday.

required
object

Frequency details for the week.

dep
required
integer

Number of departures for the week.

arr
required
integer

Number of arrivals for the week.

This will almost always be identical to the number of departures, except in cases where the schedule gets modified and it starts/ends over a weekend.

required
object

Freight details for the week.

aftks
required
integer

Available freight tonne kilometres (estimated by CAPA).

belly
required
integer

Amount of freight (kg) carried in the bellyhold of passenger planes (estimated by CAPA).

cargo
required
integer

Amount of freight (kg) carried in cargo planes (estimated by CAPA).

total
required
integer

Total amount of freight (kg) carried (estimated by CAPA).

required
object

Seat details for the week.

asks
required
integer

Available seat kilometres.

fclass
required
integer

Number of first class seats flown.

bclass
required
integer

Number of business class seats flown.

peclass
required
integer

Number of premium economy class seats flown.

eclass
required
integer

Number of economy class seats flown.

total
required
integer

Total number of seats flown.

required
object

Divides the data by the country the route arrives at.

required
object

Frequency details for the week.

dep
required
integer

Number of departures for the week.

arr
required
integer

Number of arrivals for the week.

 This will almost always be identical to the number of departures, except in cases where the schedule gets modified and it starts/ends over a weekend.
required
object

Freight details for the week.

aftks
required
integer

Available freight tonne kilometres (estimated by CAPA).

belly
required
integer

Amount of freight (kg) carried in the bellyhold of passenger planes (estimated by CAPA).

cargo
required
integer

Amount of freight (kg) carried in cargo planes (estimated by CAPA).

total
required
integer

Total amount of freight (kg) carried (estimated by CAPA).

required
object

Seat details for the week.

asks
required
integer

Available seat kilometres.

fclass
required
integer

Number of first class seats flown.

bclass
required
integer

Number of business class seats flown.

peclass
required
integer

Number of premium economy class seats flown.

eclass
required
integer

Number of economy class seats flown.

total
required
integer

Total number of seats flown.

required
object

Departure country.

id
required
integer

Departure country ID.

name
required
string

Departure country name.

required
object

Departure region.

id
required
integer

Departure region ID.

name
required
string

Departure region name.

required
object

Divides the data by the country the route arrives at.

required
object

Frequency details for the week.

dep
required
integer

Number of departures for the week.

arr
required
integer

Number of arrivals for the week.

 This will almost always be identical to the number of departures, except in cases where the schedule gets modified and it starts/ends over a weekend.
required
object

Freight details for the week.

aftks
required
integer

Available freight tonne kilometres (estimated by CAPA).

belly
required
integer

Amount of freight (kg) carried in the bellyhold of passenger planes (estimated by CAPA).

cargo
required
integer

Amount of freight (kg) carried in cargo planes (estimated by CAPA).

total
required
integer

Total amount of freight (kg) carried (estimated by CAPA).

required
object

Seat details for the week.

asks
required
integer

Available seat kilometres.

fclass
required
integer

Number of first class seats flown.

bclass
required
integer

Number of business class seats flown.

peclass
required
integer

Number of premium economy class seats flown.

eclass
required
integer

Number of economy class seats flown.

total
required
integer

Total number of seats flown.

required
object

Arrival country.

id
required
integer

Arrival country ID.

name
required
string

Arrival country name.

required
object

Arrival region.

id
required
integer

Arrival region ID.

name
required
string

Arrival region name.

required
object
min
required
string <date>

ISO8601 date of the first week of flights between the selected profiles. Note that all weeks are treated as having started on a Monday.

max
required
string <date>

ISO8601 date of the last week of flights between the selected profiles. Note that all weeks are treated as having started on a Monday.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get capacity for a route

Authorizations:
OAuth2
query Parameters
id
required
integer

Operator profile ID.

This can be an airline, airline group or alliance ID.

type
required
integer

The profile type of the Operator profile ID.

This can be an airline, airline group or alliance ID using their profile type ID.

from
string

This identifies the first day of the first week that the capacity data is pulled from.

If it is not used, the function will start with the earliest date in the capacity data.

to
string

This identifies the first day of the last week that the capacity data is pulled from.

If it is not used, the function will end with the latest date in the capacity data.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline profile ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
object

Airline alliance details.

id
required
integer

Airline alliance ID. Zero if airline is not in an alliance.

name
required
string

Airline alliance name. Null if airline is not in an alliance.

required
object

Business model details.

id
required
integer

Airline business model ID.

name
required
string

Airline business model name.

required
object

Airline country details.

id
required
integer

Airline country ID.

name
string

Airline country name.

required
Array of objects

Array of capacity data by week.

Array
week
required
string <date>

ISO8601 date of the week this capacity data applies to. Note that all weeks are treated as having started on a Monday.

required
object

Frequency details for the week.

dep
required
integer

Number of departures for the week.

arr
required
integer

Number of arrivals for the week.

This will almost always be identical to the number of departures, except in cases where the schedule gets modified and it starts/ends over a weekend.

required
object

Freight details for the week.

aftks
required
integer

Available freight tonne kilometres (estimated by CAPA).

belly
required
integer

Amount of freight (kg) carried in the bellyhold of passenger planes (estimated by CAPA).

cargo
required
integer

Amount of freight (kg) carried in cargo planes (estimated by CAPA).

total
required
integer

Total amount of freight (kg) carried (estimated by CAPA).

required
object

Seat details for the week.

asks
required
integer

Available seat kilometres.

fclass
required
integer

Number of first class seats flown.

bclass
required
integer

Number of business class seats flown.

peclass
required
integer

Number of premium economy class seats flown.

eclass
required
integer

Number of economy class seats flown.

total
required
integer

Total number of seats flown.

required
object

Divides the data by route between the countries the flight connects.

required
object

Frequency details for the week.

dep
required
integer

Number of departures for the week.

arr
required
integer

Number of arrivals for the week.

 This will almost always be identical to the number of departures, except in cases where the schedule gets modified and it starts/ends over a weekend.
required
object

Freight details for the week.

aftks
required
integer

Available freight tonne kilometres (estimated by CAPA).

belly
required
integer

Amount of freight (kg) carried in the bellyhold of passenger planes (estimated by CAPA).

cargo
required
integer

Amount of freight (kg) carried in cargo planes (estimated by CAPA).

total
required
integer

Total amount of freight (kg) carried (estimated by CAPA).

required
object

Seat details for the week.

asks
required
integer

Available seat kilometres.

fclass
required
integer

Number of first class seats flown.

bclass
required
integer

Number of business class seats flown.

peclass
required
integer

Number of premium economy class seats flown.

eclass
required
integer

Number of economy class seats flown.

total
required
integer

Total number of seats flown.

required
object

Departure country.

id
required
integer

Departure country ID.

name
required
string

Departure country name.

required
object

Departure region.

id
required
integer

Departure region ID.

name
required
string

Departure region name.

required
object

Arrival country.

id
required
integer

Arrival country ID.

name
required
string

Arrival country name.

required
object

Arrival region.

id
required
integer

Arrival region ID.

name
required
string

Arrival region name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get route change date range

Get the maximum date range for recorded route changes.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
from
required
string <datetime>

Earliest ISO8601 date of a route-change.

to
required
string <datetime>

Latest ISO8601 date of a route-change.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of airlines with capacity data

Provides a list of airlines with capacity data for the given parameters.

Authorizations:
OAuth2
query Parameters
country
required
integer

Country ID for the airline or departure airport depending on the value of the countrytype parameter.

countrytype
required
string

If this is set to 'airline', the 'country' parameter counts as the ID of the country the airline(s) is based in.

If it is set to 'route' the 'country' parameter counts as the ID of the country the departing airport(s) is located in.

rangetype
required
string

If this is set to 'comp', the dates provided by the 'datestart' and 'dateend' parameters count as the two weeks the list of airlines is extracted from.

If this is set to 'weekly', the weeks of the dates provided are used as the start and end dates and all airlines valid for the entire range are returned.

datestart
string

This identifies the first day of the first week that the airline data is pulled from, either as the start of a date range, or as a comparison with the week defined by the 'dateend' parameter, depending on the value of the 'rangetype' parameter.

If it is not used, the function will use the current week as the default date.

dateend
string

This identifies the first day of the last week that the airline data is pulled from, either as the end of a date range, or as a comparison with the week defined by the 'datestart' parameter, depending on the value of the 'rangetype' parameter.

If it is not used or the 'datestart' is not defined, the function will use the current week as the default date.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline ID.

name
required
string

Airline name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of airports with capacity data

Provides a list of airports with capacity data for the given parameters.

Authorizations:
OAuth2
query Parameters
country
required
integer

Country ID for the airline or departure airport depending on the value of the countrytype parameter.

countrytype
required
string

If this is set to 'airline', the 'country' parameter counts as the ID of the country the airline(s) is based in.

If it is set to 'route' the 'country' parameter counts as the ID of the country the departing or arriving (depending on the 'airporttype' parameter) airport(s) is located in.

airporttype
required
string

If this is set to 'dep' the listed airports are those flights depart from.

If it is set to 'arr' the listed airports are those flights arrive to when leaving the airport defined by the 'depid' parameter.

depid
integer

Departure airport ID used for identifying airports with flights arriving from this airport.

Used only if the 'airporttype' parameter is set to 'arr'

rangetype
required
string

If this is set to 'comp', the dates provided by the 'datestart' and 'dateend' parameters count as the two weeks the list of airlines is extracted from.

If this is set to 'weekly', the weeks of the dates provided are used as the start and end dates and all airlines valid for the entire range are returned.

datestart
string

This identifies the first day of the first week that the airline data is pulled from, either as the start of a date range, or as a comparison with the week defined by the 'dateend' parameter, depending on the value of the 'rangetype' parameter.

If it is not used, the function will use the current week as the default date.

dateend
string

This identifies the first day of the last week that the airline data is pulled from, either as the end of a date range, or as a comparison with the week defined by the 'datestart' parameter, depending on the value of the 'rangetype' parameter.

If it is not used or the 'datestart' is not defined, the function will use the current week as the default date.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airport ID.

name
required
string

Airport name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of route changes

Provides a list of changes in route(s) for the given parameters, including started routes, ended routes and changed frequency of flights on route on a weekly basis.

Authorizations:
OAuth2
query Parameters
countrytype
required
string

If this is set to 'airline', the 'country' parameter counts as the ID of the country the airline(s) is based in.

If it is set to 'route' the 'country' parameter counts as the ID of the country the departing or arriving (depending on the 'airporttype' parameter) airport(s) is located in.

rangetype
required
string

If this is set to 'comp', the returned data shows the route changes between the weeks starting with the selected 'datestart' and 'dateend' parameters.

If this is set to 'weekly', the returned data lists all route changes for the entire range between and including the weeks starting with the selected 'datestart' and 'dateend' parameters.

country
required
integer

Filters the output route changes by the country ID for the airline or departure airport depending on the value of the countrytype parameter.

depid
integer

Limits the route changes to those departing the selected airport ID.

arrid
integer

Limits the route changes to those arriving at the selected airport ID.

airline
integer

Limits the route changes to those to those flown by the selected airline ID.

datestart
string

This identifies the first day of the first week that the route changes data is pulled from, either as the start of a date range, or as a comparison with the week defined by the 'dateend' parameter, depending on the value of the 'rangetype' parameter.

If it is not used, the function will use the current week as the default date.

dateend
string

This identifies the first day of the last week that the route changes data is pulled from, either as the end of a date range, or as a comparison with the week defined by the 'datestart' parameter, depending on the value of the 'rangetype' parameter.

If it is not used or the 'datestart' is not defined, the function will use the current week as the default date.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline ID.

name
required
string

Airline name.

url
required
string

Airline profile URL on CAPA.

required
Array of objects

Airline's aircraft with route changes.

Array
id
required
integer

Aircraft ID.

type
required
string

Aircraft Type.

name
required
string

Aircraft Name.

required
Array of objects

Routes with changes flown by the aircraft.

Array
required
object

Departure airport data.

id
required
integer

Departure airport ID.

name
required
string

Departure airport name.

url
required
string

Departure airport profile URL on CAPA.

iata
required
string

Departure airport IATA code.

required
object

Departure airport latitude/longitude coordinates.

latitude
required
string

Departure airport latitude coordinate.

longitude
required
string

Departure airport longitude coordinate.

required
object

Arrival airport data.

id
required
integer

Arrival airport ID.

name
required
string

Arrival airport name.

url
required
string

Arrival airport profile URL on CAPA.

iata
required
string

Arrival airport IATA code.

required
object

Arrival airport latitude/longitude coordinates.

latitude
required
string

Arrival airport latitude coordinate.

longitude
required
string

Arrival airport longitude coordinate.

required
Array of objects

Data by week for the route.

Array
week
required
string <datetime>

First day of the week the route change applies to.

hasFlight
required
string <datetime>

Indicates if the route exists after this change.

change
required
string <datetime>

Date when this route change occurs.

required
object

Lists the total frequency before and after this route change.

old
required
integer

Total frequency before this route change.

new
required
integer

Total frequency after this route change.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of airports that have current capacity data

Authorizations:
OAuth2
header Parameters
code
string

Search by IATA/ICAO code for an airport. This overrides the contents of the "search" parameter.

search
string

Search for any airports containing this string in the name.

Responses

Response Schema: application/json
required
Array of objects (ProfileSearchResult)
Array
rank
integer

Profile type display order (starting from 1).

id
required
integer

Profile ID.

required
object

Profile type.

id
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (if available).

icao
string

Profile ICAO code (if available).

url
string

Profile URL. This is only added for the appropriate profile types (Cities, for instance, do not have a profile page)

object

If the profile has a country linked to it, country details are here.

id
required
string

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of airlines that have current capacity data

Authorizations:
OAuth2
query Parameters
code
string

IATA/ICAO code of the airline. This overrides the "search" parameter.

search
string

Search for all airlines where the name contains this string.

Responses

Response Schema: application/json
required
Array of objects (ProfileSearchResult)
Array
rank
integer

Profile type display order (starting from 1).

id
required
integer

Profile ID.

required
object

Profile type.

id
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (if available).

icao
string

Profile ICAO code (if available).

url
string

Profile URL. This is only added for the appropriate profile types (Cities, for instance, do not have a profile page)

object

If the profile has a country linked to it, country details are here.

id
required
string

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get changes in future schedules

This function returns the changes in projected schedules on a week by week basis, showing how predictions change and update between weeks.

Authorizations:
OAuth2
query Parameters
type
required
integer

ID of the selected profile's type:

1: Airline 2: Airport

id
required
integer

ID of the selected profile

airportDirection
string
Enum: "dep" "arr" "all"

Only applies if the 'type' parameter is set to 2.

If set to 'dep' the function returns data for flights departing the selected profile. If set to 'arr' the function returns data for flights arriving at the selected profile. If set to 'all' the function returns data for flights departing or arriving to the selected profile.

Responses

Response Schema: application/json
required
Array of objects
Array
proccessed
required
string <datetime>

Date this set of data was processed on.

required
Array of objects

Airline ID.

Array
date
required
string <datetime>

Date of predicted schedule values.

required
object

International schedule totals for selected profile.

seats
required
integer

Estimated total number of seats.

asks
required
integer

Estimated total number of ASKs.

payload
required
integer

Estimated total cargo payload (kg).

aftks
required
integer

Estimated total AFTKs.

depfreq
required
integer

Estimated total frequency of flights departing airport.

arrfreq
required
integer

Estimated total frequency of flights arriving at airport.

required
object

Domestic schedule totals for selected profile.

seats
required
integer

Estimated total number of seats.

asks
required
integer

Estimated total number of ASKs.

payload
required
integer

Estimated total cargo payload (kg).

aftks
required
integer

Estimated total AFTKs.

depfreq
required
integer

Estimated total frequency of flights departing airport.

arrfreq
required
integer

Estimated total frequency of flights arriving at airport.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of airlines with future capacity data

This function creates a list of all airlines which have predicted future capacity data, both for the current week and in data calculated in previous weeks.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline ID.

name
required
string

Airline Name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of airports with future capacity data

This function creates a list of all airports which have predicted future capacity data, both for the current week and in data calculated in previous weeks.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Country ID.

name
required
string

Country Name.

required
Array of objects

Airports within Country.

Array
id
required
integer

Airport ID.

name
required
string

Airport Name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Airport Charges

Get a list of airports with charges data

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects

An array of airports we have charges data for.

Array
id
required
integer

Airport profile ID.

url
required
string

Airport profile URL.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

min
required
integer

The earliest year of ATRS charges data that we have available.

max
required
integer

The most recent year of ATRS charges data that we have available.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Search for airports with charges data

Get a list of airports based off of a provided ID, IATA/ICAO code or search string.

Only one variable is used, with a priority of ID, code and finally search term.

Authorizations:
OAuth2
path Parameters
id
integer

Finds airport has the given ID.

query Parameters
code
string

Finds airports that equals the given IATA/ICAO code.

search
string

Finds airports that contain the given string within their name.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airport profile ID.

required
object

Profile Type details.

id
required
integer

Profile Type ID.

name
required
string

Profile Type name.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
required
string

CAPA profile URL.

min
required
string <datetime>

Earliest date of a charge value for the airport.

max
required
string <datetime>

Latest date of a charge value for the airport.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all charges fields

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Charge ID.

name
required
string

Charge name.

required
object
required
object
max
required
string <datetime>

Latest date of a charge value for the airport.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get charges for an airport

Authorizations:
OAuth2
path Parameters
id
required
integer

Airport ID.

query Parameters
year
required
integer

Year of charges you want returned.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Charge ID.

name
required
string

Charge name.

required
Array of objects

List of aircraft that this charge applies to. Note that as aircraft are defined differently to the CAPA Fleet Database, there is no cross-matching between the two.

Array
aircraft
required
string

Aircraft name.

value
required
number

Charge value (USD).

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Airport Construction

Get a list of all new airports under construction

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects

Metaregion content.

Array
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

code
required
string

2-letter metaregion code.

url
required
string

Metaregion profile URL.

required
Array of objects

Array of regions within the metaregion.

Array
id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

3-letter region code.

url
required
string

Region profile URL.

required
Array of objects

Array of countries within the region.

Array
id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

required
Array of objects

An array of new airports within the country.

Array
id
required
integer

New airport ID.

type
integer

Profile type ID.

name
required
string

New airport name.

iata
required
string

New airport IATA code.

icao
required
string

New airport ICAO code.

required
object

The city the new airport is being constructed in.

id
required
integer

City ID.

name
required
string

City name.

url
required
string

The new airport profile URL.

info
required
string

HTML content giving an overview of the new airport.

investment
required
integer

The total amount (USD) being invested in the airport.

This will be zero if the amount is unknown.

completion
required
string <date>

ISO8601 date of when it is anticipated that construction will be completed.

established
string <date>

ISO8601 date of when the airport is established and goes active (this will usually be after 'completion').

construction
boolean

For airport profiles, this indicates if the profile has an associated 'New Airport' construction project.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a summary of airport construction spend

This returns a summary of the US dollar spend on airport construction for each year we have data for. The data is split by new and existing airports, then for existing airports it is further split into runway, terminal, or other.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
object
required
Array of objects

New airport construction projects.

Array
year
required
integer

The year that the given total value applies to.

total
required
integer

The total value (USD) of all construction projects due for completion in the given year.

required
object

Construction/upgrade project values for existing airports.

required
Array of objects

Runway upgrade/extension/construction projects for existing airports.

Array
year
required
integer

The year that the given total value applies to.

total
required
integer

The total value (USD) of all runway construction projects due for completion in the given year.

required
Array of objects

Terminal upgrade/extension/construction projects for existing airports.

Array
year
required
integer

The year that the given total value applies to.

total
required
integer

The total value (USD) of all terminal construction projects due for completion in the given year.

required
Array of objects

Other construction projects that aren't runway or terminal for existing airports.

Array
year
required
integer

The year that the given total value applies to.

total
required
integer

The total value (USD) of all other construction projects due for completion in the given year.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of all construction projects for existing airports

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

Metaregion profile URL.

code
required
string

2-letter metaregion code.

required
Array of objects

Array of regions within the metaregion.

Array
id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

3-letter region code.

url
required
string

Region URL.

required
Array of objects

Array of countries within the region.

Array
id
required
integer

Country ID.

name
required
string

Country name.

url
required
string

Country profile URL.

code
required
string

2-letter country code.

required
Array of objects (AirportConstructionProject)

Array of airport construction projects within the country.

Array
id
required
number

Construction project ID.

classification
required
string

Construction project classification.

completion
required
string <date>

ISO8601 date of anticipated completion.

required
object

Investment details for the project.

total
required
integer

The total USD value of the investment.

estimated
required
boolean

True if the total is a number estimated by CAPA.

required
object

Annual passenger number details.

required
object

Current PAX traffic.

total
required
integer

Total current PAX traffic.

estimated
required
boolean

True if this value is estimated by CAPA.

required
object

Future annual passenger details.

total
required
integer

Total future PAX traffic.

estimated
required
boolean

True if this value is estimated by CAPA, false if it is estimated by the airport.

year
required
integer

Anticipated year that these passenger numbers will be reached. Zero if not specified.

required
object

Annual freight tonnage details.

required
object

Current annual freight.

total
required
integer

Total current annual freight (tonnes).

estimated
required
boolean

True if this value is estimated by CAPA.

required
object

Future annual freight.

total
required
integer

Total future annual freight (tonnes).

estimated
required
boolean

True if this value is estimated by CAPA, false if it is estimated by the airport.

year
required
integer

Anticipated year that this total will be reached. Zero if not specified.

trialSample
boolean

True if this entry can be shown to users with Trial Account access only. False if the entry is only avalible to Subscribers.

object

If this optional key exists, it details the airport that this construction project applies to. If not, it is because the project is assigned to a country.

id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
required
string

Airport profile URL.

required
Array of objects (AirportConstructionProject)

Array of construction projects within the country that are not assigned to a specific airport.

Array
id
required
number

Construction project ID.

classification
required
string

Construction project classification.

completion
required
string <date>

ISO8601 date of anticipated completion.

required
object

Investment details for the project.

total
required
integer

The total USD value of the investment.

estimated
required
boolean

True if the total is a number estimated by CAPA.

required
object

Annual passenger number details.

required
object

Current PAX traffic.

total
required
integer

Total current PAX traffic.

estimated
required
boolean

True if this value is estimated by CAPA.

required
object

Future annual passenger details.

total
required
integer

Total future PAX traffic.

estimated
required
boolean

True if this value is estimated by CAPA, false if it is estimated by the airport.

year
required
integer

Anticipated year that these passenger numbers will be reached. Zero if not specified.

required
object

Annual freight tonnage details.

required
object

Current annual freight.

total
required
integer

Total current annual freight (tonnes).

estimated
required
boolean

True if this value is estimated by CAPA.

required
object

Future annual freight.

total
required
integer

Total future annual freight (tonnes).

estimated
required
boolean

True if this value is estimated by CAPA, false if it is estimated by the airport.

year
required
integer

Anticipated year that this total will be reached. Zero if not specified.

trialSample
boolean

True if this entry can be shown to users with Trial Account access only. False if the entry is only avalible to Subscribers.

object

If this optional key exists, it details the airport that this construction project applies to. If not, it is because the project is assigned to a country.

id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
required
string

Airport profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a long-form description of the construction project

Authorizations:
OAuth2
path Parameters
id
required
integer

The project ID.

Responses

Response Schema: application/json
data
required
string

A HTML description of the construction project.

Response samples

Content type
application/json
{
  • "data": "string"
}

Events

List upcoming events

This will return a list of upcoming events, excluding CAPA Live events, in ascending chronological order.

query Parameters
ctc
boolean

When set to '1', this parameter filters the output to only those Events associated with the Corporate Travel Community (i.e. CTC only events or Aviation events with CTC components).

If it is not set, the function defaults to using showing all Events.

Responses

Response Schema: application/json
required
Array of objects (Event)
Array
id
required
integer

Event ID

name
required
string

The name of the event.

info
required
string

A short, one-sentence text description of the event.

url
string

The event's URL.

object

If the event has a live stream associated, these are the details of it.

id
required
integer

Live stream ID.

start
required
integer

UNIX timestamp of when the live stream starts.

end
required
integer

UNIX timestamp of when the live stream ends.

url
required
string

URL of the livestream event page on the CAPA site.

embed
required
string

URL to use for embedding the livestream event.

required
object

The city the event is being held in.

id
required
string

City ID.

name
required
string

City name.

required
object

The country the event is being held in.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string = 2 characters

Two-letter country code.

required
object

The metaregion the event is being held in.

id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

required
object

The date of the event. Dates are in the timezone of the event's city.

start
required
string <date>

The start date of the event, in ISO8601 format.

end
required
string <date>

The end date of the event, in ISO8601 format.

certain
required
boolean

Whether or not the dates for this event are certain, or just placeholder dates.

tech
required
boolean

Whether this event has an IT-focused component or not.

finance
required
boolean

Whether this event has a finance focused component or not.

ctc
integer

Indicates if Corporate Travel Community is involved in the event.

An Aviation-only event is morked with '0', a CTC-only event is marked as '1' and an Aviation event with a CTC presence is marked as '2'

corporate
required
boolean

Whether this event has a corporate travel focused component or not.

airline
required
boolean

Whether this event has an airline focus or not.

airport
required
boolean

Whether this event has an airport focus or not.

attendees
required
integer

Expected number of attendees.

australasia
required
boolean

True if this is a CAPA-ACTE event.

splash
string

The URL for an event splash image, if available. Info on resizing images.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Send an event sponsorship enquiry

Request Body schema: application/json
required
name
required
string

User's name.

company
required
string

User's company.

position
required
string

User's position/job title.

email
required
string

User's email address.

phone
required
string

User's phone number.

Responses

Response Schema: application/json
data
required
string
Value: "Successfully posted form."

Request samples

Content type
application/json
{
  • "name": "string",
  • "company": "string",
  • "position": "string",
  • "email": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "data": "Successfully posted form."
}

List upcoming CAPA Live events

This function provides a list of all upcoming CAPA Live events, as opposed to regular CAPA events.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
string

CAPA Live event ID.

type
required
string

Name of the type of CAPA Live event.

title
required
string

CAPA Live event name.

htmlDescription
string

HTML formatted code for the description of the CAPA Live event.

beginsAt
required
string <datetime>

Date the CAPA Live event begins on.

endsAt
required
string <datetime>

Date the CAPA Live event ends on.

categories
Array of strings

A list of the CAPA Live event's categories.

Array of objects

A speakers for the CAPA Live event.

Array
speaker
string

Speaker ID.

speakerName
required
string

Speaker name.

firstName
required
string

Speaker first name.

lastName
required
string

Speaker last name.

photoUrl
string

URL location of image for the speaker.

speakerImage
string

URL location of image for the speaker.

jobTitle
string

Speaker's job title.

organization
string

The name of the organization the speaker represents at the event.

speakerPosition
string

The position the speaker has at the event.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List past events

This function provides a list of completed CAPA events.

query Parameters
num
integer

This indicates how many events are returned in the current request.

If it is not set, the function defaults to 50 results.

page
integer

This indicates which 'page' or results is being requested, using the total per page defined in the 'num' parameter.

It starts using '0' for the first page and increases numerically per page.

If it is not set, the function defaults to using '0' for the first page of results.

ctc
boolean

When set to '1', this parameter filters the output to only those Events associated with the Corporate Travel Community (i.e. CTC only events or Aviation events with CTC components).

If it is not set, the function defaults to using showing all Events.

Responses

Response Schema: application/json
required
Array of objects (Event)
Array
id
required
integer

Event ID

name
required
string

The name of the event.

info
required
string

A short, one-sentence text description of the event.

url
string

The event's URL.

object

If the event has a live stream associated, these are the details of it.

id
required
integer

Live stream ID.

start
required
integer

UNIX timestamp of when the live stream starts.

end
required
integer

UNIX timestamp of when the live stream ends.

url
required
string

URL of the livestream event page on the CAPA site.

embed
required
string

URL to use for embedding the livestream event.

required
object

The city the event is being held in.

id
required
string

City ID.

name
required
string

City name.

required
object

The country the event is being held in.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string = 2 characters

Two-letter country code.

required
object

The metaregion the event is being held in.

id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

required
object

The date of the event. Dates are in the timezone of the event's city.

start
required
string <date>

The start date of the event, in ISO8601 format.

end
required
string <date>

The end date of the event, in ISO8601 format.

certain
required
boolean

Whether or not the dates for this event are certain, or just placeholder dates.

tech
required
boolean

Whether this event has an IT-focused component or not.

finance
required
boolean

Whether this event has a finance focused component or not.

ctc
integer

Indicates if Corporate Travel Community is involved in the event.

An Aviation-only event is morked with '0', a CTC-only event is marked as '1' and an Aviation event with a CTC presence is marked as '2'

corporate
required
boolean

Whether this event has a corporate travel focused component or not.

airline
required
boolean

Whether this event has an airline focus or not.

airport
required
boolean

Whether this event has an airport focus or not.

attendees
required
integer

Expected number of attendees.

australasia
required
boolean

True if this is a CAPA-ACTE event.

splash
string

The URL for an event splash image, if available. Info on resizing images.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get event details

path Parameters
id
required
integer

This is the ID of the requested event.

query Parameters
code
integer

A content specific access code used to unlock a restricted access component of an event.

access
integer

An overall access code used to unlock an event that has restricted access.

Responses

Response Schema: application/json
required
object
id
required
integer

Event ID.

name
required
string

Event name.

url
string

URL the event page is located at.

australasia
boolean

Indicates if the event is located in the Australasia region.

attendees
string

Expected number of attendees.

airline
integer

Airlines Strategy & Liberalisation value.

0: None for this event 1: Dedicated Session on this category 2: Core Focus on this category

tech
string

Air/Travel Technology & Traveller Centricity value.

0: None for this event 1: Dedicated Session on this category 2: Core Focus on this category

airport
string

Airport Strategy & Innovation value.

0: None for this event 1: Dedicated Session on this category 2: Core Focus on this category

corporate
string

Corporate Travel & Procurement value.

0: None for this event 1: Dedicated Session on this category 2: Core Focus on this category

finance
string

Air Finance, Fleets, Aerospace & MRO value.

0: None for this event 1: Dedicated Session on this category 2: Core Focus on this category

splash
string

URL of 'splash' image to use as background for event page.

object

Post-event review content.

Only applies to completed events.

id
required
integer

Event review ID.

url
string

Event review page URL.

required
Array of objects

A list of tabs/pages for the event review.

Array
name
required
string

Tab name.

content
required
string

HTML format content of the tab.

code
integer

Code used to restrict access for the tab.

images
Array of strings

List of images for the tab.

required
Array of objects

List of videos connected to event review.

Array
id
required
integer

Video ID.

name
required
string

Video ID.

vimeoid
integer

Vimeo ID of video - only used when the video is stored on Vimeo.

embed
string

HTML embed code used to display the video on a webpage - only used when the video is not stored on Vimeo.

description
integer

HTML formatted description of the video.

premium
boolean

If this is set to true, then the video is a premium, restricted access video.

url
integer

This is the CAPA site URL the video can be located on.

date
required
integer

UNIX timestamp for the date the video applies to.

certain
boolean

If set to true, the 'date' value is accurate, otherwise it is approximate.

object

A summary of the event data associated with the video (note, this is a duplicate of earlier data).

id
required
integer

Event ID.

name
required
string

Event name.

url
string

URL the event page is located at.

required
object

Event date range

Note: if a sub-event's date range starts before or ends after this range, the sub-event's range takes precedence.

start
required
string <datetime>

Start date of event.

end
required
string <datetime>

End date of event.

certain
boolean

If true, this date range is confirmed, otherwise it is only estimated and subject to change.

tags
Array of strings

A list of tags associated with the video.

locationtbc
boolean

If set to true, the event location is TBC - overriden by the city property.

object

Location of the event.

id
required
integer

City ID.

name
required
string

City name.

required
object

City country.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

Country code.

required
object

Country region.

id
required
integer

Region ID.

name
required
string

Region name.

required
object

Event date range

Note: if a sub-event's date range starts before or ends after this range, the sub-event's range takes precedence.

start
required
string <datetime>

Start date of event.

end
required
string <datetime>

End date of event.

certain
boolean

If true, this date range is confirmed, otherwise it is only estimated and subject to change.

Array of objects

A list of sub-events that are part of the main event.

Array
id
required
integer

Sub-event ID.

name
required
string

Sub-event name.

url
string

Sub-event page URL.

required
object

Sub-event date range.

start
required
string <datetime>

Start date of sub-event.

end
required
string <datetime>

End date of sub-event.

certain
boolean

If true, this date range is confirmed, otherwise it is only estimated and subject to change.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Export

Create CSV

This function creates a CSV from the provided data.

Request Body schema: application/json
required
filename
required
string

The name of the file to be created.

data
Array of strings[ items ]

This is a two-level array that contains the data to be converted to an CSV file.

The first level of the array lists the rows, and each value of the array must be a sub-array.

Each sub-array contains the values of the individual cells of that array as strings.

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Create image file from SVG

This function converts SVG data into a binary image.

Request Body schema: application/json
required
filename
required
string

The name of the file to be created.

type
string

The type of file to be created. May be set to 'image/svg+xml' or 'image/png'.

svg
string

The content of the image, structured as an SVG map.

width
integer

The width of the image, measured in pixels. If not set, it defaults to 1024

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "type": "string",
  • "svg": "string",
  • "width": 0
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Create CAPA Fast Facts report

This function creates a PDF file that contains the selected content of a chosen CAPA profile.

Authorizations:
OAuth2
Request Body schema: application/json
required
type
integer

The profile type ID to be exported.

id
integer

The profile ID to be exported.

charts
object

The SVG content of the graphs to be converted into images.

tables
object

The HTML formatted tables to be added to the file.

about
boolean

If set to true, the profile's About information text is included in the export.

news
boolean

If set to true, the export includes the most recent news articles associated with the profile.

newscount
integer

This defines how many news articles are added to the export if the 'news' value is set to true. If not set, it defaults to 20.

contacts
boolean

If set to true, the export includes the contact details associated with the profile.

return
boolean

If set to true, the export is downloaded directly to the user, otherwise the generated file is emailed to the address provided by the 'email' parameter.

email
string

This contains the email that the file is sent to if the 'return' value is set to false.

Responses

Request samples

Content type
application/json
{
  • "type": 0,
  • "id": 0,
  • "charts": { },
  • "tables": { },
  • "about": true,
  • "news": true,
  • "newscount": 0,
  • "contacts": true,
  • "return": true,
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Financials

List companies that have financial data

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects (ProfileSearchResult)
Array
rank
integer

Profile type display order (starting from 1).

id
required
integer

Profile ID.

required
object

Profile type.

id
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (if available).

icao
string

Profile ICAO code (if available).

url
string

Profile URL. This is only added for the appropriate profile types (Cities, for instance, do not have a profile page)

object

If the profile has a country linked to it, country details are here.

id
required
string

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get financial calendar

This will return a financial calendar in HTML format. At the moment there's no way to retrieve this data in a more useful format.

Authorizations:
OAuth2

Responses

Response Schema: application/json
data
required
string

HTML string of an upcoming financials calendar.

Response samples

Content type
application/json
{
  • "data": "string"
}

Get currency conversion rate

This function will take a provided currency and provide the conversion rate to convert it to a different currency for a given date range.

Authorizations:
OAuth2
path Parameters
currencyFrom
required
string[A-Z]{3}

This is the three-letter code for the current currency.

currencyTo
required
string[A-Z]{3}

This is the three-letter code for the currency to be converted to.

query Parameters
from
integer

The UNIX timesetamp of the start of the required date range for the conversion rate.

If not set, this defaults to the current date

to
integer

The UNIX timesetamp of the end of the required date range for the conversion rate.

If not set, this defaults to the current date

Responses

Response Schema: application/json
data
required
integer

This is the conversion rate used to convert the 'currencyFrom' currency to the 'currencyTo' currency.

Response samples

Content type
application/json
{
  • "data": 0
}

List currencies available for conversion

This will return a list of the currencies that CAPA tracks for conversion rates.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects

List of currencies.

Array
code
required
string

Three letter code for the currency.

name
required
string

Currency name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List available financial fields

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

range
required
string
Enum: "annual" "quarterly"

The reporting type of financial data to return. This can be one of two values - annual or quarterly.

Responses

Response Schema: application/json
required
Array of objects (FinancialFieldResult)
Array
id
required
integer

Field ID.

name
required
string

Field name.

years
required
Array of integers

An array of years that the financial field has data for. Note that only full years are returned here, not split years. 2016 might mean 2016 or it could mean 2016/17 depending on the company's profile. To find out what month a company's financial year ends in, check the basic profile info result.

Note that the years returned may be out of order and may have holes (although it's unlikely).

children
Array of objects (FinancialFieldResult)

If there's any child fields of this field, they will be listed here.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List available sustainability fields

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

range
required
string
Value: "annual"

The reporting type of sustainability data to return. This is currently only annual

Responses

Response Schema: application/json
required
Array of objects (FinancialFieldResult)
Array
id
required
integer

Field ID.

name
required
string

Field name.

years
required
Array of integers

An array of years that the financial field has data for. Note that only full years are returned here, not split years. 2016 might mean 2016 or it could mean 2016/17 depending on the company's profile. To find out what month a company's financial year ends in, check the basic profile info result.

Note that the years returned may be out of order and may have holes (although it's unlikely).

children
Array of objects (FinancialFieldResult)

If there's any child fields of this field, they will be listed here.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get specific financial data for a company

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

range
required
string
Enum: "annual" "quarterly"

The reporting type of financial data to return. This can be one of two values - annual or quarterly.

field
required
integer

A field ID, if you're only interested in a single field.

query Parameters
from
integer

Year to get financial from.

to
integer

Year to get financial data to.

Responses

Response Schema: application/json
required
object (FinancialResult)
id
required
integer

Field ID.

name
required
string

Field name.

isPercent
required
string

If the values for this field should be treated as a percentage, this will be true.

showGrowth
required
string

If true, then graphs on the CAPA site should display growth year-on-year for this value.

required
Array of objects

An array of values for this field.

Array
year
required
string

The year this applies to. Note that this is the financial year, so it depends on the company's locale as to if it's a normal whole year, or if it's a split year, like 2016/17.

required
Array of objects

Periods in the year.

Array
period
required
integer

Period number .This will always be a zero if we're looking at annual figures, otherwise it's a 1-based index.

note
required
string

If there's any notes about this value, they'll be here.

grouping
required
string

If there's another grouping for this value, it will be here.

local
required
number

The value, as expressed in the company's local currency.

usd
number

The value, converted to USD (average USD conversion rate for the period that the value applied to is used). If we have no conversion rate, or the value is already USD then this won't be included.

children
required
Array of objects (FinancialResult)

If this field has child fields, then they'll be listed here.

object
source
required
string

The financial data source.

note
Array of strings

A list of notes/comments that applies to the traffic data.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Fleet

Search for fleet data

Authorizations:
OAuth2
path Parameters
type
string

This is used to define if the data is to be returned with a different format to standard. The available paths are:

Path Result
/data/fleet The report returns an report for each individual aircraft.
/data/fleet/aggregate The report returns an report displaying totals grouped by the filters selected in the 'group' parameter.
/data/fleet/timeseries The report returns an report displaying totals by date grouped by the filters selected in the 'group' parameter.
query Parameters
sort
string

Column ID to sort results on.

order
string
Enum: "asc" "desc"

Order to sort results in.

group
string

List the filters to group by for timeseries or aggregate reports. It takes the form of a string containing the filter ID words, separated by commas, e.g. 'airline,variant'.

ignoreStatus
boolean

This variable is only used when reportType is set to timeseries. If true, then the resuling output combines the aircraft status instead of separating them out with other groupings.

airlinegroup
Array of integers (IntArray)

List of airline/operator group IDs to return results for.

This will only return records that have an operator assigned to them.

airline
Array of integers (IntArray)

List of CAPA airline/operator IDs to return results for. These are equivalent to CAPA Profile IDs.

This will only return records that have an operator assigned to them.

awoperator
Array of integers (IntArray)

List of Aviation Week operator IDs to return results for. These are not the same as CAPA Profile IDs.

country
Array of integers (IntArray)

List of country IDs to return results for.

This will only return records that have an operator assigned to them.

region
Array of integers (IntArray)

List of region IDs to return results for.

This will only return records that have an operator assigned to them.

bizmodel
Array of integers (IntArray)

List of business model IDs to return results for.

This will only return records that have an operator assigned to them.

alliance
Array of integers (IntArray)

List of alliance IDs to return results for.

This will only return records that have an operator assigned to them.

drange
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a delivery date range to search for.

The format of the request is YYYY-MM-DD/YYYY-MM-DD where the date value before the slash is the "from" date and the date value after the slash is the "to" date.

mrange
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a manufactured date range to search for.

The format of the request is YYYY-MM-DD/YYYY-MM-DD where the date value before the slash is the "from" date and the date value after the slash is the "to" date.

mtow
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of maximum take-off weight (kg) to search for.

igalley
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of the number of galleys an aircraft has.

itoilet
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of the number of lavatories an aircraft has.

ltype
Array of integers (IntArray)

List of lease type IDs to search for - 1: Operating, 2: Financial.

ocountry
Array of integers (IntArray)

List of country IDs of aircraft owners to return results for.

maircraft
boolean

If set to 1, only aircraft which have been manufactured are returned.

iwma
Array of integers (IntArray)

List of Wireless IFE Manufacturer IDs to return results for.

iwm
Array of integers (IntArray)

List of Wireless IFE Model IDs to return results for.

iifema
Array of integers (IntArray)

List of IFE Manufacturer IDs to return results for.

iifem
Array of integers (IntArray)

List of IFE Model IDs to return results for.

ipedsync
boolean

If set to 1, only aircraft with IFE PED sync capabilities are returned.

ilivetv
boolean

If set to 1, only aircraft with live TV capabilities are returned.

iifcp
Array of integers (IntArray)

List of IFC Provider IDs to return results for.

iifcs
Array of integers (IntArray)

List of IFC Service IDs to return results for.

iisp
Array of integers (IntArray)

List of Internet Service Provider IDs to return results for.

iism
Array of integers (IntArray)

List of Internet Service Model IDs to return results for.

igsm
Array of integers (IntArray)

List of GSM IDs to return results for.

iband
Array of integers (IntArray)

List of IFC Band IDs to return results for.

igsma
Array of integers (IntArray)

List of Seat Manufacturer IDs to return results for.

ifdoor
boolean

If set to 1, only aircraft with First Class doors installed are returned.

ifconfig
string^\d{1}-\d{1}$

This is a range of possible First Class seat configurations an aircraft has.

ifsma
Array of integers (IntArray)

List of First Class Seat Manufacturer IDs to return results for.

ifsm
Array of integers (IntArray)

List of First Class Seat Model IDs to return results for.

ifsd
Array of integers (IntArray)

List of First Class Seat Designer IDs to return results for.

ifpitch
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible First Class seat pitch ranges an aircraft has.

ifwidth
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible First Class seat width ranges an aircraft has.

ifrlength
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible First Class seat recline length ranges an aircraft has.

ifrecline
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible First Class seat recline degrees ranges an aircraft has.

ifscreen
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible First Class seat screen sizes an aircraft has.

iftoilet
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of the number of First Class lavatories an aircraft has.

ifbar
Array of integers (IntArray)

List of First Class Bar Type IDs to return results for.

ifinternet
Array of integers (IntArray)

List of First Class Internet Type IDs to return results for.

ifped
Array of integers (IntArray)

List of First Class PED Support Device IDs to return results for.

ibdoor
boolean

If set to 1, only aircraft with Business Class doors installed are returned.

ibconfig
string^\d{1}-\d{1}$

This is a range of possible Business Class seat configurations an aircraft has.

ibsma
Array of integers (IntArray)

List of Business Class Seat Manufacturer IDs to return results for.

ibsm
Array of integers (IntArray)

List of Business Class Seat Model IDs to return results for.

ibsd
Array of integers (IntArray)

List of Business Class Seat Designer IDs to return results for.

ibpitch
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Business Class seat pitch ranges an aircraft has.

ibwidth
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Business Class seat width ranges an aircraft has.

ibrlength
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Business Class seat recline length ranges an aircraft has.

ibrecline
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Business Class seat recline degrees ranges an aircraft has.

ibscreen
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Business Class seat screen sizes an aircraft has.

ibtoilet
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of the number of Business Class lavatories an aircraft has.

ibbar
Array of integers (IntArray)

List of Business Class Bar Type IDs to return results for.

ibinternet
Array of integers (IntArray)

List of Business Class Internet Type IDs to return results for.

ibped
Array of integers (IntArray)

List of Business Class PED Support Device IDs to return results for.

ipedoor
boolean

If set to 1, only aircraft with Premium Economy Class doors installed are returned.

ipeconfig
string^\d{1}-\d{1}$

This is a range of possible Premium Economy Class seat configurations an aircraft has.

ipesma
Array of integers (IntArray)

List of Premium Economy Class Seat Manufacturer IDs to return results for.

ipesm
Array of integers (IntArray)

List of Premium Economy Class Seat Model IDs to return results for.

ipesd
Array of integers (IntArray)

List of Premium Economy Class Seat Designer IDs to return results for.

ipepitch
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Premium Economy Class seat pitch ranges an aircraft has.

ipewidth
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Premium Economy Class seat width ranges an aircraft has.

iperlength
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Premium Economy Class seat recline length ranges an aircraft has.

iperecline
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Premium Economy Class seat recline degrees ranges an aircraft has.

ipescreen
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Premium Economy Class seat screen sizes an aircraft has.

ipetoilet
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of the number of Premium Economy Class lavatories an aircraft has.

ipebar
Array of integers (IntArray)

List of Premium Economy Class Bar Type IDs to return results for.

ipeinternet
Array of integers (IntArray)

List of Premium Economy Class Internet Type IDs to return results for.

ipeped
Array of integers (IntArray)

List of Premium Economy Class PED Support Device IDs to return results for.

iepdoor
boolean

If set to 1, only aircraft with Economy Plus Class doors installed are returned.

iepconfig
string^\d{1}-\d{1}$

This is a range of possible Economy Plus Class seat configurations an aircraft has.

iepsma
Array of integers (IntArray)

List of Economy Plus Class Seat Manufacturer IDs to return results for.

iepsm
Array of integers (IntArray)

List of Economy Plus Class Seat Model IDs to return results for.

iepsd
Array of integers (IntArray)

List of Economy Plus Class Seat Designer IDs to return results for.

ieppitch
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Plus Class seat pitch ranges an aircraft has.

iepwidth
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Plus Class seat width ranges an aircraft has.

ieprlength
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Plus Class seat recline length ranges an aircraft has.

ieprecline
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Plus Class seat recline degrees ranges an aircraft has.

iepscreen
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Plus Class seat screen sizes an aircraft has.

ieptoilet
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of the number of Economy Plus Class lavatories an aircraft has.

iepbar
Array of integers (IntArray)

List of Economy Plus Class Bar Type IDs to return results for.

iepinternet
Array of integers (IntArray)

List of Economy Plus Class Internet Type IDs to return results for.

iepped
Array of integers (IntArray)

List of Economy Plus Class PED Support Device IDs to return results for.

iedoor
boolean

If set to 1, only aircraft with Economy Class doors installed are returned.

ieconfig
string^\d{1}-\d{1}$

This is a range of possible Economy Class seat configurations an aircraft has.

iesma
Array of integers (IntArray)

List of Economy Class Seat Manufacturer IDs to return results for.

iesm
Array of integers (IntArray)

List of Economy Class Seat Model IDs to return results for.

iesd
Array of integers (IntArray)

List of Economy Class Seat Designer IDs to return results for.

iepitch
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Class seat pitch ranges an aircraft has.

iewidth
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Class seat width ranges an aircraft has.

ierlength
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Class seat recline length ranges an aircraft has.

ierecline
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Class seat recline degrees ranges an aircraft has.

iescreen
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of possible Economy Class seat screen sizes an aircraft has.

ietoilet
string^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$

This is a range of the number of Economy Class lavatories an aircraft has.

iebar
Array of integers (IntArray)

List of Economy Class Bar Type IDs to return results for.

ieinternet
Array of integers (IntArray)

List of Economy Class Internet Type IDs to return results for.

ieped
Array of integers (IntArray)

List of Economy Class PED Support Device IDs to return results for.

amanufacturer
Array of integers (IntArray)

List of aircraft manufacturer IDs to search for.

model
Array of integers (IntArray)

List of aircraft model IDs to search for.

series
Array of integers (IntArray)

List of aircraft variant series IDs to search for.

variant
Array of integers (IntArray)

List of aircraft variant IDs to search for.

type
Array of integers (IntArray)

List of aircraft type IDs to search for.

role
Array of integers (IntArray)

List of aircraft role IDs to search for.

parked
Array of integers (IntArray)

List of airport IDs to search for, if looking for aircraft that are currently in storage.

serial
Array of strings (StringArray)

List of aircraft serial numbers to search for.

tail
Array of strings (StringArray)

List of aircraft tail numbers to search for.

emanufacturer
Array of integers (IntArray)

List of engine manufacturer IDs to search for.

engine
Array of integers (IntArray)

List of engine IDs to search for.

emodel
Array of integers (IntArray)

List of engine model IDs to search for.

status
Array of integers (IntArray)

List of record status IDs to search for.

fstatus
Array of integers (IntArray)

List of Aviation Week financial status IDs to search for.

ostatus
Array of integers (IntArray)

List of Aviation Week operating status IDs to search for.

wetleased
integer
Value: 1

True if we want to include aircraft that are subleased to an operator when doing a search by operator ID.

myairlease
integer
Value: 1

True if we only want to return records that we have myairlease data for.

winglets
integer
Value: 1

True if we only want aircraft that have winglets.

relevant
integer
Value: 1

When doing a date range search, set this to true to only return records that fall within the date range, for aircraft that have multiple records within the range. Otherwise all records from the date range start up until the present are returned for the aircraft.

apumanufacturer
Array of integers (IntArray)

List of APU manufacturer IDs to search for.

apumodel
Array of integers (IntArray)

List of APU model IDs to search for.

apu
Array of integers (IntArray)

List of APU IDs to search for.

owned
integer
Value: 1

True will only return aircraft that are owned by the operator.

leased
integer
Value: 1

True will only return aircraft that are leased by the operator.

lessor
Array of strings (LessorArray) [^\d+-(0|1)$]

List of CAPA lessor/owner IDs to search for. These are based on CAPA airline/lessor profiles.

sublessor
Array of strings (LessorArray) [^\d+-(0|1)$]

List of sublessor IDs to search for.

lmanager
Array of strings (LessorArray) [^\d+-(0|1)$]

List of aircraft manager IDs to search for.

asat
string <date>

Date to do point-in-time searches with. Overrides range, from and to.

range
string
Enum: "year" "last3" "decade"

Date range to search. Overrides from and to.

from
string <date>

Date to search records from.

to
string <date>

Date to search records to.

page
integer

Zero-based page index of results.

num
integer

Number of results to return.

Responses

Response Schema: application/json
required
Array of objects (FleetResult)
Array
id
required
integer

Record ID.

required
object

Aircraft details.

id
required
integer

Aircraft ID.

object

Subvariant details (if they exist). Note that due to taxonomy requirements imposed by Aviation Week, subvariants are now called "aircraft models" on the frontend.

id
required
integer

Subvariant ID.

name
required
string

Subvariant name.

object

Aircraft category information.

id
required
integer

Aircraft category ID.

code
required
string

Aircraft category code.

name
required
string

Aircraft category name.

serial
required
string

Aircraft serial.

tail
required
string

Aircraft registration/tail number.

myairlease
required
boolean

True if this record has myairlease data available.

winglets
required
boolean

True if this aircraft has aftermarket winglets fitted.

required
object

Aircraft variant information. Note that due to taxonomy requirements imposed by Aviation Week, variants are now called "aircraft types" on the frontend.

id
required
integer

Variant ID.

name
required
string

Aircraft variant name.

iata
required
string

Aircraft variant IATA code.

icao
required
string

Aircraft variant ICAO code.

winglets
required
boolean

True if this aircraft variant comes with stock winglets.

mtow
required
integer

Generic maximum takeoff weight for this aircraft variant (kg).

engines
required
integer

Number of engines this variant has.

required
object

Variant series information. Note that due to taxonomy requirements imposed by Aviation Week, variant series is no longer displayed on the frontend.

id
required
integer

Variant series ID.

name
required
string

Variant series name.

required
object

Aircraft model information. Note that due to taxonomy requirements imposed by Aviation Week, models are now called "production groups" on the frontend.

id
required
integer

Aircraft model ID.

name
required
string

Aircraft model name.

myairlease
required
string

The myairlease name for this aircraft model.

required
object

Model type information. Note that due to taxonomy requirements imposed by Aviation Week, model types are now called "aircraft classes" on the frontend.

id
required
integer

Model type ID.

name
required
string

Model type name.

required
object

Aircraft manufacturer information.

id
required
integer

Aircraft manufacturer ID.

name
required
string

Aircraft manufacturer name.

required
object

Aircraft seat information.

fclass
required
integer

Number of first class seats.

bclass
required
integer

Number of business class seats.

peclass
required
integer

Number of premium economy class seats.

eclass
required
integer

Number of economy class seats.

mtow
required
integer

Non-generic aircraft maximum takeoff weight (kg).

required
object

Engine information. Note that due to taxonomy requirements imposed by Aviation Week, engines are now called "engine models" on the frontend.

id
required
integer

Engine ID.

name
required
string

Engine name.

required
object

Engine model information. Note that due to taxonomy requirements imposed by Aviation Week, engine models are now called "engine types" on the frontend.

id
required
integer

Engine model ID.

name
required
string

Engine model name.

required
object

Engine manufacturer information.

id
required
integer

Engine manufacturer ID.

name
required
string

Engine manufacturer name.

required
object

Aircraft role information.

id
required
integer

Role ID.

name
required
string

Role name.

line
integer

Aircraft line number (if available). This is for Boeing aircraft.

block
string

Aircraft variable block identifier. This is for Boeing aircraft.

object

Hours and cycles information (if available).

This key will exist if the aircraft has hours/cycles information and the user has access to it.

year
required
integer

Year the hours/cycles applies to.

month
required
integer

Month the hours/cycles applies to (1 = January).

required
object

Hours information.

total
required
integer

Total hours registered for the aircraft up until the given month.

month
required
integer

Number of hours flown for the aircraft for the given month.

required
object

Cycles information.

total
required
integer

Total cycles registered for the aircraft up until the given month.

month
required
integer

Number of cycles flown for the aircraft for the given month.

object

ICF aircraft valuation information if it exists and the user has access to them. Note that valuations are generic to the variant.

year
required
integer

Valuation year.

month
required
integer

Valuation month (1 = January).

market
required
integer

USD market value.

base
required
integer

USD base value.

lease
required
integer

USD lease rate.

object

If date of manufacture information is available, it is here.

year
required
integer

Year of manufacture.

month
required
integer

Month of manufacture.

object

If delivery information is available, it is here.

year
required
integer

Year of aircraft delivery.

month
required
integer

Month of aircraft delivery.

If the delivery date is greater than 2 years in the future, this value will not exist.

day
integer

Day of aircraft delivery.

If the delivery date is greater than 6 months in the future, this value will not exist.

object

APU information, if available. Note that due to taxonomy requirements imposed by Aviation Week, APUs are now called "APU models" on the frontend.

id
required
integer

APU ID.

name
required
string

APU name.

generic
required
boolean

True if this APU is generic to the variant, false if it is aftermarket.

required
object

APU model information. Note that due to taxonomy requirements imposed by Aviation Week, APU models are now called "APU types" on the frontend.

id
required
integer

APU model ID.

name
required
string

APU model name.

required
object

APU manufacturer information.

id
required
integer

APU manufacturer ID.

name
required
string

APU manufacturer name.

required
FleetStatus (object) or Array of FleetStatus (objects)

If the ignoreStatus parameter was sent, status results per record will be an array of objects instead of just an object.

One of
id
required
integer

Status ID.

name
required
string

Status name.

required
object

Event information. Note that due to taxonomy requirements imposed by Aviation Week, events are now called "activity names" on the frontend.

id
required
integer

Event ID.

name
required
string

Event name.

required
object

Record effective information.

from
required
string <date>

Date that the record was effective from.

to
required
string <date>

Date that the record is effective to. Will be null if the record is considered to be currently effective.

note
required
string

Any notes about this record. Note that due to taxonomy requirements imposed by Aviation Week, notes are now called "activity remarks" on the frontend.

multiple
string
Enum: "first" "multiple" "final"

If a date range has been used as a query parameter and there are multiple records for a single aircraft returned for that date range, then they will contain a multiple key.

The key can have three possible values - first, multiple and final.

  • first is the first (oldest) record for that range.
  • multiple will be applied to any records between first and final
  • final is the last (newest) record for that range.
object

If the aircraft has an operator assigned to it, the details of it will here here.

Note that it is possible for this key to be empty and only contain a country key - this indicates that a CAPA-to-Aviation Week mapping does not exist, in which case you should check the avweek key for operator details.

id
integer

CAPA operator ID.

name
string

CAPA operator name.

iata
string

CAPA operator IATA code.

icao
string

CAPA operator ICAO code.

url
string

CAPA operator profile URL.

required
object

If country data exists for the operator, it's here.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

Country code.

tcode
required
string

Country IATA traffic code.

url
required
string

Country profile URL.

required
object

Region information.

id
required
integer

Region ID.

name
required
string

Region name.

url
required
string

Region profile URL.

object

Operator alliance, if existing.

id
required
integer

Alliance ID.

name
required
string

Alliance name.

url
string

Alliance profile URL.

object

Operator business model.

id
required
integer

Operator business model ID.

name
required
string

Operator business model name.

object

If owner information is available, it is here.

id
required
integer

CAPA owner ID.

type
required
integer
Enum: 1 3

CAPA owner type ID. This will be 1 for airlines and 3 for lessors.

name
required
string

CAPA owner name.

iata
required
string

CAPA owner IATA code.

icao
required
string

CAPA owner ICAO code.

url
string

CAPA owner profile URL.

object

If sublessor information is available, it is here.

id
required
integer

CAPA sublessor ID.

type
required
integer

CAPA sublessor type ID. This will be 1 for airlines and 3 for lessors.

name
required
string

CAPA sublessor name.

iata
required
string

CAPA sublessor IATA code.

icao
required
string

CAPA sublessor ICAO code.

url
required
string

CAPA sublessor profile URL.

object

Aircraft manager info, if available.

id
required
integer

CAPA aircraft manager ID.

type
required
integer

CAPA aircraft manager type ID.

name
required
string

CAPA aircraft manager name.

iata
required
string

CAPA aircraft manager IATA code.

icao
required
string

CAPA aircraft manager ICAO code.

url
required
string

CAPA aircraft manager profile URL.

object

Lease information, if available.

from
required
string <date>

Date the lease started.

to
required
string <date>

Date the lease ended. Null if ongoing.

type
required
integer

Lease type ID.

name
required
string

Lease type name.

object

If the aircraft is currently in storage, this is the details of the airport it is stored at.

id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
string

Airport profile URL. Will be null if there is no active profile.

required
object

Aviation Week-specific data.

required
object

Operating status information.

id
required
integer

Operating status ID.

name
required
string

Operating status name.

required
object

Financial status information.

id
required
integer

Financial status ID.

name
required
string

Financial status name.

object

Aviation Week operator information.

id
required
integer

Aviation Week operator company ID.

name
required
string

Aviation Week operator company name.

iata
required
string

Aviation Week operator company IATA code.

icao
required
string

Aviation Week operator company ICAO code.

required
object

Aviation Week operator company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is operated, so it is possible for an aircraft to have an operator classified as a scheduled airline, but another aircraft may have that same operator classified as a non-scheduled airline.

code
required
string

Single-letter code to identify the classification.

name
required
string

The operator's classification.

object

Aviation Week owner information. The logic behind this is it's the same as the consolidated owner if that data exists, otherwise it will be showing the registered owner.

id
required
integer

Aviation Week owner company ID.

name
required
string

Aviation Week owner company name.

iata
required
string

Aviation Week owner company IATA code.

icao
required
string

Aviation Week owner company ICAO code.

required
object

Aviation Week owner company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is owned.

code
required
string

Single-letter code to identify the classification.

name
required
string

The owner's classification.

object

Aviation Week registered owner information.

id
required
integer

Aviation Week registered owner company ID.

name
required
string

Aviation Week registered owner company name.

iata
required
string

Aviation Week registered owner company IATA code.

icao
required
string

Aviation Week registered owner company ICAO code.

required
object

Aviation Week registered owner company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is owned.

code
required
string

Single-letter code to identify the classification.

name
required
string

The operator's classification.

object

Aviation Week beneficiary owner information.

id
required
integer

Aviation Week beneficiary owner company ID.

name
required
string

Aviation Week beneficiary owner company name.

iata
required
string

Aviation Week beneficiary owner company IATA code.

icao
required
string

Aviation Week beneficiary owner company ICAO code.

object

Aviation Week consolidated owner information.

id
required
integer

Aviation Week consolidated owner company ID.

name
required
string

Aviation Week consolidated owner company name.

iata
required
string

Aviation Week consolidated owner company IATA code.

icao
required
string

Aviation Week consolidated owner company ICAO code.

required
object

Aviation Week consolidated owner company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is owned.

code
required
string

Single-letter code to identify the classification.

name
required
string

The operator's classification.

object

Aviation Week sublessor information.

id
required
integer

Aviation Week sublessor company ID.

name
required
string

Aviation Week sublessor company name.

iata
required
string

Aviation Week sublessor company IATA code.

icao
required
string

Aviation Week sublessor company ICAO code.

required
object

Aviation Week sublessor company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is subleased.

code
required
string

Single-letter code to identify the classification.

name
required
string

The operator's classification.

object

Aviation Week lease manager information.

id
required
integer

Aviation Week lease manager company ID.

name
required
string

Aviation Week lease manager company name.

iata
required
string

Aviation Week lease manager company IATA code.

icao
required
string

Aviation Week lease manager company ICAO code.

required
object

Aviation Week lease manager company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is managed.

code
required
string

Single-letter code to identify the classification.

name
required
string

The lease manager's classification.

required
object
count
required
integer

Number of records returned.

total
required
integer

Total number of records for this query.

page
required
integer

Zero-based page number of results.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Export fleet data

This runs a fleet search but returns the data as XLSX/CSV instead of JSON. NOTE: All request parameters are identical to what is listed under Search for fleet data, however the num and page parameters are ignored.

Authorizations:
OAuth2
query Parameters
format
required
string
Enum: "excel" "csv"

The format you want your data in.

columns
required
string

This lists the columns to be used in the exported data as listed by the List the avalible export columns request. It takes the form of a string containing the column ID words, separated by commas, e.g. 'airline,variant'.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List the avalible export columns

This will return an array of columns and the ids that can be used when exporting fleet data with the Export fleet data request.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects

An array of columns for fleet export.

Array
id
required
string

This is the id used in the columns parameter of the export request.

name
required
string

This is the column header in the exported file.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get fleet history for an aircraft

This will return an array of fleet results in reverse-chronological order detailing the history of the aircraft.

Authorizations:
OAuth2
path Parameters
id
required
integer

Aircraft ID.

Responses

Response Schema: application/json
required
Array of objects (FleetResult)

An reverse-chronological array of fleet results, detailing the history of the aircraft.

Array
id
required
integer

Record ID.

required
object

Aircraft details.

id
required
integer

Aircraft ID.

object

Subvariant details (if they exist). Note that due to taxonomy requirements imposed by Aviation Week, subvariants are now called "aircraft models" on the frontend.

id
required
integer

Subvariant ID.

name
required
string

Subvariant name.

object

Aircraft category information.

id
required
integer

Aircraft category ID.

code
required
string

Aircraft category code.

name
required
string

Aircraft category name.

serial
required
string

Aircraft serial.

tail
required
string

Aircraft registration/tail number.

myairlease
required
boolean

True if this record has myairlease data available.

winglets
required
boolean

True if this aircraft has aftermarket winglets fitted.

required
object

Aircraft variant information. Note that due to taxonomy requirements imposed by Aviation Week, variants are now called "aircraft types" on the frontend.

id
required
integer

Variant ID.

name
required
string

Aircraft variant name.

iata
required
string

Aircraft variant IATA code.

icao
required
string

Aircraft variant ICAO code.

winglets
required
boolean

True if this aircraft variant comes with stock winglets.

mtow
required
integer

Generic maximum takeoff weight for this aircraft variant (kg).

engines
required
integer

Number of engines this variant has.

required
object

Variant series information. Note that due to taxonomy requirements imposed by Aviation Week, variant series is no longer displayed on the frontend.

id
required
integer

Variant series ID.

name
required
string

Variant series name.

required
object

Aircraft model information. Note that due to taxonomy requirements imposed by Aviation Week, models are now called "production groups" on the frontend.

id
required
integer

Aircraft model ID.

name
required
string

Aircraft model name.

myairlease
required
string

The myairlease name for this aircraft model.

required
object

Model type information. Note that due to taxonomy requirements imposed by Aviation Week, model types are now called "aircraft classes" on the frontend.

id
required
integer

Model type ID.

name
required
string

Model type name.

required
object

Aircraft manufacturer information.

id
required
integer

Aircraft manufacturer ID.

name
required
string

Aircraft manufacturer name.

required
object

Aircraft seat information.

fclass
required
integer

Number of first class seats.

bclass
required
integer

Number of business class seats.

peclass
required
integer

Number of premium economy class seats.

eclass
required
integer

Number of economy class seats.

mtow
required
integer

Non-generic aircraft maximum takeoff weight (kg).

required
object

Engine information. Note that due to taxonomy requirements imposed by Aviation Week, engines are now called "engine models" on the frontend.

id
required
integer

Engine ID.

name
required
string

Engine name.

required
object

Engine model information. Note that due to taxonomy requirements imposed by Aviation Week, engine models are now called "engine types" on the frontend.

id
required
integer

Engine model ID.

name
required
string

Engine model name.

required
object

Engine manufacturer information.

id
required
integer

Engine manufacturer ID.

name
required
string

Engine manufacturer name.

required
object

Aircraft role information.

id
required
integer

Role ID.

name
required
string

Role name.

line
integer

Aircraft line number (if available). This is for Boeing aircraft.

block
string

Aircraft variable block identifier. This is for Boeing aircraft.

object

Hours and cycles information (if available).

This key will exist if the aircraft has hours/cycles information and the user has access to it.

year
required
integer

Year the hours/cycles applies to.

month
required
integer

Month the hours/cycles applies to (1 = January).

required
object

Hours information.

total
required
integer

Total hours registered for the aircraft up until the given month.

month
required
integer

Number of hours flown for the aircraft for the given month.

required
object

Cycles information.

total
required
integer

Total cycles registered for the aircraft up until the given month.

month
required
integer

Number of cycles flown for the aircraft for the given month.

object

ICF aircraft valuation information if it exists and the user has access to them. Note that valuations are generic to the variant.

year
required
integer

Valuation year.

month
required
integer

Valuation month (1 = January).

market
required
integer

USD market value.

base
required
integer

USD base value.

lease
required
integer

USD lease rate.

object

If date of manufacture information is available, it is here.

year
required
integer

Year of manufacture.

month
required
integer

Month of manufacture.

object

If delivery information is available, it is here.

year
required
integer

Year of aircraft delivery.

month
required
integer

Month of aircraft delivery.

If the delivery date is greater than 2 years in the future, this value will not exist.

day
integer

Day of aircraft delivery.

If the delivery date is greater than 6 months in the future, this value will not exist.

object

APU information, if available. Note that due to taxonomy requirements imposed by Aviation Week, APUs are now called "APU models" on the frontend.

id
required
integer

APU ID.

name
required
string

APU name.

generic
required
boolean

True if this APU is generic to the variant, false if it is aftermarket.

required
object

APU model information. Note that due to taxonomy requirements imposed by Aviation Week, APU models are now called "APU types" on the frontend.

id
required
integer

APU model ID.

name
required
string

APU model name.

required
object

APU manufacturer information.

id
required
integer

APU manufacturer ID.

name
required
string

APU manufacturer name.

required
FleetStatus (object) or Array of FleetStatus (objects)

If the ignoreStatus parameter was sent, status results per record will be an array of objects instead of just an object.

One of
id
required
integer

Status ID.

name
required
string

Status name.

required
object

Event information. Note that due to taxonomy requirements imposed by Aviation Week, events are now called "activity names" on the frontend.

id
required
integer

Event ID.

name
required
string

Event name.

required
object

Record effective information.

from
required
string <date>

Date that the record was effective from.

to
required
string <date>

Date that the record is effective to. Will be null if the record is considered to be currently effective.

note
required
string

Any notes about this record. Note that due to taxonomy requirements imposed by Aviation Week, notes are now called "activity remarks" on the frontend.

multiple
string
Enum: "first" "multiple" "final"

If a date range has been used as a query parameter and there are multiple records for a single aircraft returned for that date range, then they will contain a multiple key.

The key can have three possible values - first, multiple and final.

  • first is the first (oldest) record for that range.
  • multiple will be applied to any records between first and final
  • final is the last (newest) record for that range.
object

If the aircraft has an operator assigned to it, the details of it will here here.

Note that it is possible for this key to be empty and only contain a country key - this indicates that a CAPA-to-Aviation Week mapping does not exist, in which case you should check the avweek key for operator details.

id
integer

CAPA operator ID.

name
string

CAPA operator name.

iata
string

CAPA operator IATA code.

icao
string

CAPA operator ICAO code.

url
string

CAPA operator profile URL.

required
object

If country data exists for the operator, it's here.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

Country code.

tcode
required
string

Country IATA traffic code.

url
required
string

Country profile URL.

required
object

Region information.

id
required
integer

Region ID.

name
required
string

Region name.

url
required
string

Region profile URL.

object

Operator alliance, if existing.

id
required
integer

Alliance ID.

name
required
string

Alliance name.

url
string

Alliance profile URL.

object

Operator business model.

id
required
integer

Operator business model ID.

name
required
string

Operator business model name.

object

If owner information is available, it is here.

id
required
integer

CAPA owner ID.

type
required
integer
Enum: 1 3

CAPA owner type ID. This will be 1 for airlines and 3 for lessors.

name
required
string

CAPA owner name.

iata
required
string

CAPA owner IATA code.

icao
required
string

CAPA owner ICAO code.

url
string

CAPA owner profile URL.

object

If sublessor information is available, it is here.

id
required
integer

CAPA sublessor ID.

type
required
integer

CAPA sublessor type ID. This will be 1 for airlines and 3 for lessors.

name
required
string

CAPA sublessor name.

iata
required
string

CAPA sublessor IATA code.

icao
required
string

CAPA sublessor ICAO code.

url
required
string

CAPA sublessor profile URL.

object

Aircraft manager info, if available.

id
required
integer

CAPA aircraft manager ID.

type
required
integer

CAPA aircraft manager type ID.

name
required
string

CAPA aircraft manager name.

iata
required
string

CAPA aircraft manager IATA code.

icao
required
string

CAPA aircraft manager ICAO code.

url
required
string

CAPA aircraft manager profile URL.

object

Lease information, if available.

from
required
string <date>

Date the lease started.

to
required
string <date>

Date the lease ended. Null if ongoing.

type
required
integer

Lease type ID.

name
required
string

Lease type name.

object

If the aircraft is currently in storage, this is the details of the airport it is stored at.

id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
string

Airport profile URL. Will be null if there is no active profile.

required
object

Aviation Week-specific data.

required
object

Operating status information.

id
required
integer

Operating status ID.

name
required
string

Operating status name.

required
object

Financial status information.

id
required
integer

Financial status ID.

name
required
string

Financial status name.

object

Aviation Week operator information.

id
required
integer

Aviation Week operator company ID.

name
required
string

Aviation Week operator company name.

iata
required
string

Aviation Week operator company IATA code.

icao
required
string

Aviation Week operator company ICAO code.

required
object

Aviation Week operator company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is operated, so it is possible for an aircraft to have an operator classified as a scheduled airline, but another aircraft may have that same operator classified as a non-scheduled airline.

code
required
string

Single-letter code to identify the classification.

name
required
string

The operator's classification.

object

Aviation Week owner information. The logic behind this is it's the same as the consolidated owner if that data exists, otherwise it will be showing the registered owner.

id
required
integer

Aviation Week owner company ID.

name
required
string

Aviation Week owner company name.

iata
required
string

Aviation Week owner company IATA code.

icao
required
string

Aviation Week owner company ICAO code.

required
object

Aviation Week owner company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is owned.

code
required
string

Single-letter code to identify the classification.

name
required
string

The owner's classification.

object

Aviation Week registered owner information.

id
required
integer

Aviation Week registered owner company ID.

name
required
string

Aviation Week registered owner company name.

iata
required
string

Aviation Week registered owner company IATA code.

icao
required
string

Aviation Week registered owner company ICAO code.

required
object

Aviation Week registered owner company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is owned.

code
required
string

Single-letter code to identify the classification.

name
required
string

The operator's classification.

object

Aviation Week beneficiary owner information.

id
required
integer

Aviation Week beneficiary owner company ID.

name
required
string

Aviation Week beneficiary owner company name.

iata
required
string

Aviation Week beneficiary owner company IATA code.

icao
required
string

Aviation Week beneficiary owner company ICAO code.

object

Aviation Week consolidated owner information.

id
required
integer

Aviation Week consolidated owner company ID.

name
required
string

Aviation Week consolidated owner company name.

iata
required
string

Aviation Week consolidated owner company IATA code.

icao
required
string

Aviation Week consolidated owner company ICAO code.

required
object

Aviation Week consolidated owner company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is owned.

code
required
string

Single-letter code to identify the classification.

name
required
string

The operator's classification.

object

Aviation Week sublessor information.

id
required
integer

Aviation Week sublessor company ID.

name
required
string

Aviation Week sublessor company name.

iata
required
string

Aviation Week sublessor company IATA code.

icao
required
string

Aviation Week sublessor company ICAO code.

required
object

Aviation Week sublessor company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is subleased.

code
required
string

Single-letter code to identify the classification.

name
required
string

The operator's classification.

object

Aviation Week lease manager information.

id
required
integer

Aviation Week lease manager company ID.

name
required
string

Aviation Week lease manager company name.

iata
required
string

Aviation Week lease manager company IATA code.

icao
required
string

Aviation Week lease manager company ICAO code.

required
object

Aviation Week lease manager company classification details.

Note that these values are assigned at an aircraft level depending on the context of how the aircraft is managed.

code
required
string

Single-letter code to identify the classification.

name
required
string

The lease manager's classification.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Export aircraft history

Export history for an aircraft to CSV.

Authorizations:
OAuth2
path Parameters
id
required
integer

Aircraft ID.

query Parameters
format
required
string
Enum: "excel" "csv"

Export format.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get hours and cycles data for an aircraft

This will return hours and cycles data (if available) for an aircraft, in chronological order.

Authorizations:
OAuth2
path Parameters
id
required
integer

Aircraft ID.

Responses

Response Schema: application/json
required
Array of objects
Array
year
required
integer

Year that these hours/cycles apply to.

Note that it is possible for year and month to be zero. If so, this indicates that these were the starting values that we had for this aircraft.

required
Array of objects
Array
month
required
integer

Month number. This is 1-indexed, so 1 = January.

hours
required
integer

Number of hours this plane flew for the month.

cycles
required
integer

Number of times this plane flew in the month.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Fleet summary by country

This will return a list of fleet totals (aircraft hulls & seats), organised by region, country, variant, type, configuration and status.

Authorizations:
OAuth2
query Parameters
date
string <datetime>

The Monday of the week the fleet data is to be pulled from. If not set, it defaults to the current day.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Meta-region ID.

name
required
string

Meta-region name.

required
Array of objects

List of regions in the meta-region.

Array
id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

Three letter region IATA code.

required
Array of objects

List of countries in the region.

Array
id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

Two letter country IATA code.

url
required
string

URL of CAPA profile page.

required
Array of objects

List of airlines based in the country.

Array
id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Two letter airline IATA code.

icao
required
string

Three letter airline ICAO code.

url
required
string

URL of CAPA profile page.

required
Array of objects

List of manufacturers of aircraft used by this airline.

Array
id
required
integer

Aircraft manufacturer ID.

name
required
string

Aircraft manufacturer name.

required
Array of objects

List of models built by this aircraft manufacturer.

Array
id
required
integer

Aircraft model ID.

name
required
string

Aircraft model name.

required
Array of objects

List of variants of this aircraft model.

Array
id
required
integer

Aircraft variant ID.

name
required
string

Aircraft variant name.

required
Array of objects

List of aircraft types of this aircraft variant.

Array
id
required
integer

Aircraft type ID.

name
required
string

Aircraft type name.

required
Array of objects

List of possible configurations of this aircraft type.

Array
id
required
integer

Aircraft configuration ID.

name
required
string

Aircraft configuration name.

required
Array of objects

List of possible statuses of this aircraft configuration.

Array
id
required
integer

Aircraft statuses ID.

name
required
string

Aircraft statuses name.

aircraft
required
integer

Total number of aircraft hulls.

seats
required
integer

Total number of aircraft seats.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get valuation data for an aircraft

This returns any valuation data associated with an aircraft. Aircraft valuation data is provided by ICF Truebook and requires the Valuations Addon in order to be viewed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Aircraft ID.

Responses

Response Schema: application/json
required
Array of objects

An array of valuation data. Each entry corresponds to what the aircraft was worth at the time of valuation. So an entry for November 2014 would be what ICF considered that aircraft to be worth back then.

Array
year
required
integer

Year of valuation.

required
Array of objects

Array of months with valuation data.

Array
month
integer

Month of valuation. 1-based, so 1 = January.

lr
number

Monthly lease rate.

Values listed are in multiples of 1 million.

br
number

Base rate.

Values listed are in multiples of 1 million.

mr
required
number

Market rate.

Values listed are in multiples of 1 million.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get future valuation data for an aircraft

This returns any predicted future valuation data associated with an aircraft. Aircraft valuation data is provided by ICF Truebook and requires the Valuations Addon in order to be viewed.

Authorizations:
OAuth2
path Parameters
id
required
integer

Aircraft ID.

query Parameters
year
integer

The year the future valuation data is to be pulled from.

If not set this defaults to the maximum for the aircraft.

month
integer

The month the future valuation data is to be pulled from.

If not set this defaults to the maximum for the aircraft.

Responses

Response Schema: application/json
required
Array of objects

An array of future valuation data. Each entry corresponds to what the aircraft is predicted to be worth at the requested time of valuation.

Array
year
required
integer

Year of valuation. This is the year that these valuations apply to, not the year it was valued.

bv
required
integer

Base value.

lr
required
integer

Lease rate.

required
object
object

The maximum possible date for this aircraft's future valuations.

year
integer

The maximum year for this aircraft's future valuations.

month
integer

The maximum month of the maximum year for this aircraft's future valuations.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get myairlease data about the aircraft

myairlease is a third-party website that tracks aircraft that are available for leasing. If an aircraft in the CAPA Fleet Database has a myairlease record associated with it, then data will be returned for this call.

path Parameters
id
required
integer

Aircraft ID.

Responses

Response Schema: application/json
required
object

myairlease data.

object

Engine details.

manufacturer
required
string

Engine manufacturer.

id
required
string

Engine ID.

name
required
string

Engine name.

hours
required
integer

Reported hours that this aircraft has flown (this data is from myairlease, not the CAPA Fleet Database).

Zero if unknown/not supplied.

cycles
required
integer

Reported cycles that this aircraft has flown (this data is from myairlease, not the CAPA Fleet Database).

Zero if unknown/not supplied.

olas
required
string

String listing the types of leasing available. Lease types are separated by a slash.

Types: * OL: operating lease * A: ACMI * S: sale

required
object

Date the aircraft was listed.

month
required
integer

Month the aircraft was listed.

year
required
integer

Year the aircraft was listed.

object

Date the aircraft is available from.

If this key does not exist, then it is assumed that the aircraft is immediately available.

month
required
integer

Month the aircraft is available from.

year
required
integer

Year the aircraft is available from.

object

Listed seat configuration. Note this is data from myairlease and not the CAPA Fleet Database.

If this key does not exist, then seating configuration information was not provided.

fclass
required
integer

First class seats available.

bclass
required
integer

Business class seats available.

eclass
required
integer

Economy class seats available.

link
required
string

Link to the company on myairlease.

required
object

This is the company managing the lease/sale.

id
required
string

Lessor ID.

name
required
string

Lessor name.

url
required
string

Lessor profile URL.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Search for a filter

This is used to get a list of possible options that can be used to filter fleet data in the Search for fleet data and Export fleet data requests.

Authorizations:
OAuth2
path Parameters
type
required
string

The filter type. This can be set to:

ID Description
airline CAPA aircraft operator
awoperator Aviation Week aircraft operator
bizmodel Aircraft operator business model
airlinegroup Aircraft operator's airline group
alliance Aircraft operator alliance
country Aircraft operator country
region Aircraft operator region
lessor Aircraft lessor
awowner Aviation Week aircraft owner
ltype Aircraft lease type
role Aircraft role
type Aircraft type
status Aircraft status
fstatus Aicraft financial status
ostatus Aicraft operating status
event Latest event
airport Parked location
amanufacturer Aircraft manufacturer
model Aircraft model
series Aircraft variant series
variant Aircraft variant
emanufacturer Aircraft engine manufacturer
emodel Aircraft engine model
engine Aircraft engine
apumanufacturer Aircraft APU manufacturer
apumodel Aircraft APU model
apu Aircraft APU
iwma Wireless IFE manufacturer
iwm Wireless IFE model
iifema IFE manufacturer
iifem IFE model
iifcp IFC provider
iifcs IFC service
iband IFC band
iisp Internet service provider
iism Internet service model
igsm GSM model
isma Aircraft seat manufacturer
ism Aircraft seat model
isd Aircraft seat designer
iped Aicraft PED
ibar Aicraft bar type
iinternet Aircraft internet
iconfig Aircraft seat configuration
query Parameters
page
integer

Results page number (zero-based).

search
string

A search string to filter results by.

code
string

For airline searches, you can specify an IATA/ICAO code and it will search based on that. Sending a value for this causes the search parameter to be ignored.

parent
integer

For searches by variant or variant series, this parameter filters the result by the ID of the aircraft model or variant series respectively.

This parameter is only used when the search parameter is not being used.

inservice
integer
Value: 1

If a value is sent for this and it's an airline search, then only airlines currently operating will be returned.

Responses

Response Schema: application/json
required
Array of objects (FleetFilterResult)
Array
id
required
integer

Result ID.

name
required
string

Result name.

required
object
total
required
integer

Total results available for this search.

perpage
required
integer

Number of results returned per page.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get a filter by ID

Authorizations:
OAuth2
path Parameters
type
required
string

Filter type.

id
required
integer

Filter ID.

Responses

Response Schema: application/json
required
object (FleetFilterResult)
id
required
integer

Result ID.

name
required
string

Result name.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of saved searches

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects (FleetSavedSearch)
Array
id
required
integer

Saved search ID.

name
required
string

Saved search name.

search
required
object

This will be an object of fleet search parameters.

columns
required
Array of strings

An array of columns to display for the search. This is currently unused and subject to change.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create a new saved search

Authorizations:
OAuth2
Request Body schema: application/json
required
name
required
string

Name of the saved search.

search
required
object

Search parameters as an object.

columns
required
Array of strings

Array of column IDs to display (currently ignored).

type
string

The type of sheet/tab. May be set to 'sheet', 'report', 'timeseries', 'graph', 'tsgraph' or 'aircraft'.

uuid
string

User ID.

Responses

Response Schema: application/json
data
required
integer

Newly saved search ID.

Request samples

Content type
application/json
{
  • "name": "string",
  • "search": { },
  • "columns": [
    ],
  • "type": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "data": 0
}

Get the details of a saved search

Authorizations:
OAuth2
path Parameters
id
required
integer

Fleet search ID.

Responses

Response Schema: application/json
id
required
integer

Saved search ID.

name
required
string

Saved search name.

search
required
object

This will be an object of fleet search parameters.

columns
required
Array of strings

An array of columns to display for the search. This is currently unused and subject to change.

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "search": { },
  • "columns": [
    ]
}

Update a saved search

Authorizations:
OAuth2
path Parameters
id
required
integer

Saved search ID.

Request Body schema: application/json
required
name
required
string

Name of saved search.

search
required
object

Search parameters.

columns
required
Array of strings

Column IDs to return. Currently ignored.

type
string

The type of sheet/tab. May be set to 'sheet', 'report', 'timeseries', 'graph', 'tsgraph' or 'aircraft'.

uuid
string

User ID.

Responses

Response Schema: application/json
data
required
boolean

This will always be true.

Request samples

Content type
application/json
{
  • "name": "string",
  • "search": { },
  • "columns": [
    ],
  • "type": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "data": true
}

Delete a saved search

Authorizations:
OAuth2
path Parameters
id
required
integer

Saved search ID.

Responses

Response Schema: application/json
data
required
boolean

This will always be true.

Response samples

Content type
application/json
{
  • "data": true
}

Get a global fleet summary

This returns a current global fleet summary as of today. Note that only results with a status of In Service, On Order, On Option or In Storage are returned. Cancelled etc statuses are omitted.

Authorizations:
OAuth2
query Parameters
date
string <datetime>

The Monday of the week the fleet data is to be pulled from. If not set, it defaults to the current day.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Aircraft manufacturer ID.

name
required
string

Aircraft manufacturer name.

required
Array of objects

Metaregions that this aircraft manufacturer has aircraft in.

Array
id
required
integer

Metaregion ID. If the metaregion is unknown, this will be zero.

name
required
string

Metaregion name. If the metaregion is unknown, this will be "n/a".

code
required
string

2-letter metaregion code. Null if unknown.

required
Array of objects

Business models this aircraft is used in.

Array
id
required
integer

Business model ID. Zero if unknown.

name
required
string

Business model name. "n/a" if unknown.

required
Array of objects

Aircraft configurations.

Array
id
required
integer

Aircraft configuration ID.

name
required
string

Aircraft configuration name.

required
Array of objects

Aircraft types.

Array
id
required
integer

Aircraft type ID.

name
required
string

Aircraft type name.

required
Array of objects

Aircraft statuses.

Array
id
required
integer

Aircraft status ID.

name
required
string

Aircraft status name.

aircraft
required
integer

Number of aircraft that currently have this status.

seats
required
integer

Number of seats that currently have this status.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a historical fleet summary

This returns a fleet summary of the past 6 years by year. Note that only results with a status of In Service, On Order, On Option or In Storage are returned. Cancelled etc statuses are omitted.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
year
required
integer

Year.

required
Array of objects
Array
id
required
integer

Aircraft manufacturer ID.

name
required
string

Aircraft manufacturer name.

required
Array of objects

Regions the aircraft manufacturer serve.

Array
id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

Region IATA code.

required
Array of objects

Airline business models.

Array
id
required
integer

Business model ID.

name
required
string

Business model name.

required
Array of objects

Aircraft configurations.

Array
id
required
integer

Aircraft configuration ID.

name
required
string

Aircraft configuration name.

required
Array of objects

Aircraft types.

Array
id
required
integer

Aircraft type ID.

name
required
string

Aircraft type name.

required
Array of objects

Aircraft statuses.

Array
id
required
integer

Aircraft status ID.

name
required
string

Aircraft status name.

aircraft
required
integer

Number of aircraft that currently have this status.

seats
required
integer

Number of seats that currently have this status.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get average fleet age by metaregion

This returns the average age in days of aircraft that are currently in service, split by metaregion.

Authorizations:
OAuth2
query Parameters
date
string <datetime>

The Monday of the week the fleet data is to be pulled from. If not set, it defaults to the current day.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Metaregion ID. Zero if unknown.

name
required
string

Metaregion name. "n/a" if unknown.

avg
required
number

Average age in days of aircraft in service as of today.

med
required
integer

Median age in days of aircraft in service as of today.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a global summary of leased aircraft totals

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Lessor ID.

name
required
string

Lessor name.

url
required
string

Lessor profile URL.

required
object

Aircraft details.

service
required
integer

Total aircraft in service.

storage
required
integer

Total aircraft in storage.

order
required
integer

Total aircraft on order.

option
required
integer

Total aircraft on option.

required
object

Seat details.

service
required
integer

Total seats in service.

storage
required
integer

Total seats in storage.

order
required
integer

Total seats on order.

option
required
integer

Total seats on option.

object

Data on aircraft managed by, but not owned by, the Lessor.

required
object

Aircraft details.

service
required
integer

Total aircraft in service.

storage
required
integer

Total aircraft in storage.

order
required
integer

Total aircraft on order.

option
required
integer

Total aircraft on option.

required
object

Seat details.

service
required
integer

Total seats in service.

storage
required
integer

Total seats in storage.

order
required
integer

Total seats on order.

option
required
integer

Total seats on option.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a global summary of aircraft on order

Authorizations:
OAuth2
query Parameters
date
string <datetime>

The Monday of the week the fleet data is to be pulled from. If not set, it defaults to the current day.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

code
required
string

2-letter metaregion code.

required
Array of objects
Array
id
required
integer

Region ID.

name
required
string

Region name.

code
required
string

3-letter region code.

required
Array of objects
Array
id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

required
Array of objects
Array
id
required
string

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
object
id
required
integer

Business model ID.

name
required
string

Business model name.

required
Array of objects
Array
id
required
integer

Configuration ID.

name
required
string

Configuration name.

Array of objects
Array
id
required
integer

Aircraft type ID.

name
required
string

Aircraft type name.

required
Array of objects
Array
year
required
integer

Year of expected delivery. Zero if unknown.

aircraft
required
integer

Total aircraft on order.

seats
required
integer

Total seats on order.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a global summary of aircraft deliveries

This returns a summary of aircraft deliveries, grouped by region and business model.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Metaregion ID.

Can be null for any aircraft not assigned operators.

name
required
string

Metaregion name.

Can be null for any aircraft not assigned operators.

code
required
string

Metaregion code.

Can be null for any aircraft not assigned operators.

required
Array of objects

Array of business models within the region.

Array
id
required
integer

Business model ID.

Can be null for any aircraft not assigned operators.

name
required
string

Business model name.

    Can be null for any aircraft not assigned operators.
required
Array of objects

Aircraft configurations array.

Array
id
required
integer

Configuration ID.

name
required
string

Configuration name (passenger, cargo etc).

required
Array of objects

Array of aircraft types.

Array
id
required
integer

Aircraft type ID.

name
required
string

Aircraft type name.

required
Array of objects

Array of delivery years.

Array
year
required
integer

Aircraft delivery year.

aircraft
required
integer

Number of aircraft delivered.

seats
required
integer

Total number of seats from all delivered aircraft.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get current aircraft locations

This returns a list of aircraft, aircraft locations and other associated data. Note: this is not available to third parties without prior arrangement.

Authorizations:
OAuth2
query Parameters
since
integer

The time range to pull data from, calculated as number of seconds in the past to the current moment. If not set, this defaults to 30.

Responses

Response Schema: application/json
required
Array of objects (AircraftLocation)

OK

Array
adshex
required
string

Aircraft/Flight ID hex string.

lat
required
integer

Aircraft latitude.

lon
required
integer

Aircraft longitude.

mtime
required
integer

Unix timestamp this data was recorded at.

altitude
required
integer

Aircraft altitude (ft).

speed
required
integer

Aircraft speed (kts).

heading
required
integer

Aircraft heading (degrees).

vertRate
required
string

Aircraft rate of ascent/descent (ft/m).

reg
required
string

Aircraft registration/tail number.

callsign
required
string

Flight callsign.

flightNo
required
string

Flight number.

route
required
string

Flight route. Uses the airport IATA codes joined by '-'. For example 'SYD-MEL'

type
required
string

Aircraft manufacturer model code.

squawk
required
integer

Air Traffic Control ID code.

category
required
string

Flight category.

visFlag
required
boolean

Show/hide aircraft flag.

dep
required
integer

Departure airport profile ID.

arr
required
integer

Arrival airport profile ID.

object

Extra data, subject to availability.

selectedAltitude
integer

Altitude set into autopilot.

barometer
integer

Air pressure.

magneticHeading
integer

Heading relative to magnetic north.

rollAngle
integer

Aircraft tilt angle - positive number indicates left wing is higher then right wing.

groundSpeed
integer

Horizontal speed relative to the ground.

indicatedAirSpeed
integer

Recorded airspeed NOT adjusted for air pressure.

trueAirSpeed
integer

Actual airspeed.

mach
integer

Speed as mach.

trackAngle
integer

Actual path travelled over ground.

targetHeading
integer

Heading set into autopilot.

windSpeed
integer

Wind speed outside aircraft.

windDirection
integer

Wind direction outside aircraft.

outsideAirTemperature
integer

Air temperature outside aircraft.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get aircraft location

This returns an aircraft's current location and other associated data. Note: this is not available to third parties.

Authorizations:
OAuth2
path Parameters
id
required
integer

Aircraft ID.

query Parameters
since
integer

The time range to pull data from, calculated as number of seconds in the past to the current moment. If not set, this defaults to 30.

Responses

Response Schema: application/json
required
object (AircraftLocation)
adshex
required
string

Aircraft/Flight ID hex string.

lat
required
integer

Aircraft latitude.

lon
required
integer

Aircraft longitude.

mtime
required
integer

Unix timestamp this data was recorded at.

altitude
required
integer

Aircraft altitude (ft).

speed
required
integer

Aircraft speed (kts).

heading
required
integer

Aircraft heading (degrees).

vertRate
required
string

Aircraft rate of ascent/descent (ft/m).

reg
required
string

Aircraft registration/tail number.

callsign
required
string

Flight callsign.

flightNo
required
string

Flight number.

route
required
string

Flight route. Uses the airport IATA codes joined by '-'. For example 'SYD-MEL'

type
required
string

Aircraft manufacturer model code.

squawk
required
integer

Air Traffic Control ID code.

category
required
string

Flight category.

visFlag
required
boolean

Show/hide aircraft flag.

dep
required
integer

Departure airport profile ID.

arr
required
integer

Arrival airport profile ID.

object

Extra data, subject to availability.

selectedAltitude
integer

Altitude set into autopilot.

barometer
integer

Air pressure.

magneticHeading
integer

Heading relative to magnetic north.

rollAngle
integer

Aircraft tilt angle - positive number indicates left wing is higher then right wing.

groundSpeed
integer

Horizontal speed relative to the ground.

indicatedAirSpeed
integer

Recorded airspeed NOT adjusted for air pressure.

trueAirSpeed
integer

Actual airspeed.

mach
integer

Speed as mach.

trackAngle
integer

Actual path travelled over ground.

targetHeading
integer

Heading set into autopilot.

windSpeed
integer

Wind speed outside aircraft.

windDirection
integer

Wind direction outside aircraft.

outsideAirTemperature
integer

Air temperature outside aircraft.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get aircraft capacity for a route

This returns a route's seat and frequency data by aircraft variant for the current week, as well as the frequency data for a provided week in the past for comparison.

Authorizations:
OAuth2
query Parameters
dep
required
integer

The ID of the selected departure CAPA profile.

deptype
required
integer

The ID of the selected departure CAPA profile type.

depprofiles
srring

List of departure profiles. This is used when requiring the destinations for multiple possible departure points and is discarded if the deptype and dep parameters are set.

It must take the format of a string listing each profiles as '[profile type ID]-[profile ID]' with each profile separated by ','. For example; '2-1343|2-2538'.

arr
required
integer

The ID of the selected arrival CAPA profile.

arrtype
required
integer

The ID of the selected arrival CAPA profile type.

comparisionDate
required
string <datetime>

The Monday of the week the comparison frequency data is to be pulled from.

ctype
string
Enum: "system" "international" "domestic"

Indicates if the routes should be International only, Domestic only or total. It defaults to total.

Responses

Response Schema: application/json
required
Array of objects
Array
object

Details of the airline that owns/operates the aircraft variant.

name
string

Airline name.

code
string

Airline IATA code.

url
string

URL of airline's CAPA profile page.

object

Aircraft variant data.

name
string

Aircraft variant name.

url
string

URL of aircraft variant's CAPA profile page.

object

Total seat, cargo and frequency capacity.

fclass
integer

Total first-class seats.

bclass
integer

Total business-class seats.

peclass
integer

Total premium economy-class seats.

eclass
integer

Total economy-class seats.

cargo
integer

Total cargo (kg).

object

Total frequency capacity.

current
integer

Total frequency for the current week.

past
integer

Total frequency for the week selected in the 'comparisionDate' parameter.

required
object
min
required
string <datetime>

Earliest time available for aircraft route data with the selected parameters.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get route capacity for an aircraft

This returns an aircraft's seat and frequency data by route for the current week, as well as the frequency data for a provided week in the past for comparison.

Authorizations:
OAuth2
query Parameters
manufacturer
required
integer

The ID of the aircraft manufacturer.

model
required
integer

The ID of the aircraft model.

family
required
integer

The ID of the aircraft variant series.

variant
required
integer

The ID of the aircraft variant.

comparisionDate
required
string <datetime>

The Monday of the week the comparison frequency data is to be pulled from.

Responses

Response Schema: application/json
required
Array of objects
Array
object

Departure airport.

name
string

Departure airport name.

code
string

Departure airport IATA code.

url
string

URL of departure airport's CAPA profile page.

object

Arrival airport.

name
string

Arrival airport name.

code
string

Arrival airport IATA code.

url
string

URL of arrival airport's CAPA profile page.

object

Details of the airline that owns/operates the aircraft variant.

name
string

Airline name.

code
string

Airline IATA code.

url
string

URL of airline's CAPA profile page.

object

Total seat, cargo and frequency capacity.

fclass
integer

Total first-class seats.

bclass
integer

Total business-class seats.

peclass
integer

Total premium economy-class seats.

eclass
integer

Total economy-class seats.

cargo
integer

Total cargo (kg).

object

Total frequency capacity.

current
integer

Total frequency for the current week.

past
integer

Total frequency for the week selected in the 'comparisionDate' parameter.

Array of objects

List of flightnumbers in this grouping.

Array
string
object
min
required
string <datetime>

Earliest time available for aircraft route data with the selected parameters.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get Fleet search settings

This returns saved settings for the Fleet interface.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects

This is a list of the saved sheets/tabs.

Array
columns
required
Array of strings

An array of columns to display for the search. This is currently unused and subject to change.

exportColumns
required
Array of strings

An array of columns to use when exporting a sheet's data to excel or CSV. This is currently unused and subject to change.

name
required
string

Saved search name.

search
required
object

This will be an object of fleet search parameters.

type
required
string

The type of sheet/tab. May be set to 'sheet', 'report', 'timeseries', 'graph', 'tsgraph' or 'aircraft'.

uuid
required
string

User ID.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Save Fleet search settings

This saves the settings the user has chosen to the database, so that they will be preserved for the user to return to at a later date.

Authorizations:
OAuth2
Request Body schema: application/json
required
currentSheet
required
string

The ID of the currently selected sheet/tab on the Fleet Matrix page.

required
Array of objects

A list of the sheets/tabs and their settings for the user.

Array
columns
required
Array of strings

An array of columns to display for the search. This is currently unused and subject to change.

exportColumns
required
Array of strings

An array of columns to use when exporting a sheet's data to excel or CSV. This is currently unused and subject to change.

name
required
string

Saved search name.

search
required
object

This will be an object of fleet search parameters.

type
required
string

The type of sheet/tab. May be set to 'sheet', 'report', 'timeseries', 'graph', 'tsgraph' or 'aircraft'.

uuid
required
string

User ID.

Responses

Response Schema: application/json
data
required
boolean

If the settings have been stored, the function returns a true response.

Request samples

Content type
application/json
{
  • "currentSheet": "string",
  • "sheets": [
    ]
}

Response samples

Content type
application/json
{
  • "data": true
}

List recently updated aircraft IDs

Returns a list of aircraft IDs and when they were last updated in the fleet database.

Authorizations:
OAuth2
query Parameters
since
integer
Default: 1

Most recent number of days to search for.

Responses

Response Schema: application/json
required
Array of objects

A list of IDs and when they were updated.

Array
id
required
integer

Aircraft ID.

updated
required
integer

UNIX timestamp of when the aircraft was updated.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Redirect to new aircraft ID

Returns a 301 redirect indicating what the new aircraft ID is, given an old CAPA ID.

path Parameters
id
required
integer
Default: 1

CAPA aircraft ID.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Form 41

Get a list of available Form 41 fields

Authorizations:
OAuth2
path Parameters
type
required
integer
Value: 1

Profile type. This will always be 1 at the moment as Form 41 data is treated as airline-centric.

id
required
integer

Profile ID.

Responses

Response Schema: application/json
required
Array of objects
Array
id
string

Field ID. If this is a field grouping that has child fields, then the field ID will not exist.

name
required
string

Field or field grouping name.

Array of objects

If this is a field grouping, a children key will exist, that lists fields that make up the grouping.

Array
id
required
string

Field ID.

name
required
string

Field name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List Form 41 regions

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
object
id
required
integer

The region ID.

name
required
string

The region name.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Form 41 data for an airline

Authorizations:
OAuth2
path Parameters
type
required
integer
Value: 1

Profile type ID. At the moment all Form 41 searches are airline-centric, so the profile ID is always going to be 1 in this case.

id
required
integer

Profile ID.

field
required
integer

Form 41 field ID.

query Parameters
from
integer

The year to return data from.

Defaults to the current year minus 4 years.

to
integer

The year to return data to.

Defaults to the current year.

region
required
integer

Form 41 region ID.

Responses

Response Schema: application/json
required
Array of objects (Form41Result)
Array
year
required
integer

Year that the included values apply to.

required
Array of objects

A list of values. Note that this may not be in order.

Array
quarter
required
integer

A 1-indexed quarter number (1 = January-March).

value
required
number

The value for the quarter.

required
object
required
object

Minimum and maximum year values that we have for this airline/field.

min
required
integer

The earliest year for this airline/field that we have Form 41 data for.

max
required
integer

The most recent year for this airline/field that we have Form 41 data for.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Search for airlines with Form 41 data

Authorizations:
OAuth2
query Parameters
code
string

Search for an airline with Form 41 data by IATA or ICAO code. This overrides anything in the search parameter. Either this or search needs to be set.

search
string

Search for an airline with Form 41 data by name. Either this or code needs to be set.

inservice
integer
Value: 1

If this is set and is a non-zero value, then results returned will only be airlines that are currently considered to be operating.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

object

Airline country information (if available).

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Search for airlines with T100 data

Authorizations:
OAuth2
query Parameters
code
string

Search for an airline by their IATA or ICAO code.

search
string

Search for an airline by their name. This parameter is discarded if the "code" parameter is set.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
object

Airline's home country.

id
required
integer

Country ID.

code
required
string

2-letter country code.

name
required
string

Country name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Search for airlines with T100 data

Authorizations:
OAuth2
path Parameters
id
required
integer

Search for an airline that matches the provided ID.

query Parameters
code
string

Search for an airline by their IATA or ICAO code. This parameter is discarded if the "id" parameter is set.

search
string

Search for an airline by their name. This parameter is discarded if the "id" or "code" parameter is set.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL.

required
object

Airline's home country.

id
required
integer

Country ID.

code
required
string

2-letter country code.

name
required
string

Country name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get T100 origins for an airline

Authorizations:
OAuth2
path Parameters
id
required
integer

Airline ID.

Responses

Response Schema: application/json
required
Array of objects

A list of departing airports that we have data for (for this airline).

Array
id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of destinations for an origin

Authorizations:
OAuth2
path Parameters
id
required
integer

Airline ID.

query Parameters
dep
required
integer

Origin airport ID.

Responses

Response Schema: application/json
required
Array of objects

A list of destination airports that we have T100 data for.

Array
id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of aircraft on a route

Authorizations:
OAuth2
path Parameters
id
required
integer

Airline ID.

query Parameters
dep
required
integer

Origin airport ID.

arr
required
integer

Destination airport ID.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
string

Aircraft ID. This does not match the CAPA Fleet Database and only relates to Form 41 data.

name
required
string

Aircraft name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of T100 fields

Authorizations:
OAuth2
path Parameters
id
required
integer

Airline ID.

Responses

Response Schema: application/json
required
Array of objects

A list of fields and their associated IDs.

Array
id
required
integer

Field ID.

name
required
string

Field name.

loadfactor
boolean

If this key exists and is true, then this is a field that can be used for calculating load factors (ie. PAX divided by seats). See Get T100 data for an airline for more information.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List Form 41 regions

Authorizations:
OAuth2
path Parameters
id
required
integer

Airline ID.

query Parameters
dep
required
integer

Origin airport ID.

arr
required
integer

Destination airport ID.

Responses

Response Schema: application/json
required
object
id
required
integer

The region ID.

name
required
string

The region name.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get T100 data for an airline

Authorizations:
OAuth2
path Parameters
id
required
integer

Airline profile ID.

query Parameters
dep
required
integer

Departing airport ID.

arr
required
integer

Arriving airport ID.

field
required
Array of integers (IntArray)
Example: field=1

T100 field ID.

Load factors

Getting load factor data has a bit of a quirk to it. If you wish to retrieve load factors, field should be set to the values that have a loadfactor: true key returned from a call to list fields, separated by a pipe.

So if you do a call to /fields and it returns a list of fields, and two of those fields have loadfactor: true (let's say they have an ID of 4 and 5), then if you were to use 5|4 as the field ID, it would return load factor values. Alternatively you could pull down the PAX and seats fields separately and do the load factor calculation yourself.

aircraft
integer

Aircraft ID.

Responses

Response Schema: application/json
required
Array of objects (T100Result)

Returns an unsorted list of T100 results.

Array
year
required
integer

The year that this record refers to.

month
required
integer

The month that this record refers to (1-indexed, so 1 = January).

value
required
number

The value of the field requested.

pax
integer

If a load factor field has been requested, then the passenger count will be returned here.

seats
integer

If a load factor field has been requested, then the seat count will be returned here.

percent
boolean

If this key exists and has a true value, then the number given in the value key should be treated as a percentage.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Airport Investment

Get a list of investors for all airports

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects (AirportInvestorResult)
Array
id
required
integer

Airport profile ID.

type
required
integer
Enum: 2 16

Airport profile type. Note that an airport could be classified as either an "airport" or a "new airport" so there's two possible types here. See Profile Types for more information.

name
required
string

Airport name.

iata
required
string

Airport IATA code. Null if unavailable.

icao
required
string

Airport ICAO code. Null if unavailable.

url
required
string

Airport profile URL.

required
object

Airport country/region details.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

required
object

Region details.

id
required
integer

Region ID.

name
required
string

Region name.

url
required
string

Region URL.

required
Array of objects

Investors involved with this airport.

Array
id
required
integer

Investor profile ID.

type
required
integer

Investor profile type. An investor may be an "investor," but it's also possible for it to be an airline or another airport, so don't assume that this will always be a profile type of "investor." More info on profile types.

name
required
string

Investor name.

iata
required
string

Investor IATA code (if available).

icao
required
string

Investor ICAO code (if available).

iType
required
string

The type of the Investor.

major
required
boolean

True if the investor is classified as a "major" investor. Not a major investor in the airport, but as a major investor worldwide.

url
required
string

Investor profile URL.

required
object

Investor's country details.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get investment details for an airport

Authorizations:
OAuth2
path Parameters
type
required
integer

Airport type ID.

id
required
integer

Airport ID.

Responses

Response Schema: application/json
required
object (AirportInvestorResult)
id
required
integer

Airport profile ID.

type
required
integer
Enum: 2 16

Airport profile type. Note that an airport could be classified as either an "airport" or a "new airport" so there's two possible types here. See Profile Types for more information.

name
required
string

Airport name.

iata
required
string

Airport IATA code. Null if unavailable.

icao
required
string

Airport ICAO code. Null if unavailable.

url
required
string

Airport profile URL.

required
object

Airport country/region details.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

required
object

Region details.

id
required
integer

Region ID.

name
required
string

Region name.

url
required
string

Region URL.

required
Array of objects

Investors involved with this airport.

Array
id
required
integer

Investor profile ID.

type
required
integer

Investor profile type. An investor may be an "investor," but it's also possible for it to be an airline or another airport, so don't assume that this will always be a profile type of "investor." More info on profile types.

name
required
string

Investor name.

iata
required
string

Investor IATA code (if available).

icao
required
string

Investor ICAO code (if available).

iType
required
string

The type of the Investor.

major
required
boolean

True if the investor is classified as a "major" investor. Not a major investor in the airport, but as a major investor worldwide.

url
required
string

Investor profile URL.

required
object

Investor's country details.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

url
required
string

Country profile URL.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Low Cost Carriers

Get a global list of LCCs for a year

Authorizations:
OAuth2
query Parameters
year
required
integer

The year to get LCCs for.

Responses

Response Schema: application/json
required
Array of objects (LCCAirlineResult)
Array
id
required
integer

Airline ID. Will be null if there's no match between our profile database and OAG's.

type
required
integer
Value: 1

Airline type ID. Will always be 1.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL. Null if we don't have one.

from
required
integer

Month number (1 = January) that this airline was counted as an LCC from.

to
required
integer

Month number (1 = January) that this airline counts as an LCC to.

startup
required
boolean

True if this airline is a startup.

failedstartup
required
boolean

True if this airline is a failed startup.

hidden
required
boolean

True if this profile should be hidden.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of LCCs for a profile

Authorizations:
OAuth2
path Parameters
type
required
integer
Enum: 4 5 6

Profile type ID. Can be countries, regions or metaregions.

id
required
integer

Profile ID.

query Parameters
year
required
integer

The year to get LCCs for.

Responses

Response Schema: application/json
required
Array of objects (LCCAirlineResult)
Array
id
required
integer

Airline ID. Will be null if there's no match between our profile database and OAG's.

type
required
integer
Value: 1

Airline type ID. Will always be 1.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

url
required
string

Airline profile URL. Null if we don't have one.

from
required
integer

Month number (1 = January) that this airline was counted as an LCC from.

to
required
integer

Month number (1 = January) that this airline counts as an LCC to.

startup
required
boolean

True if this airline is a startup.

failedstartup
required
boolean

True if this airline is a failed startup.

hidden
required
boolean

True if this profile should be hidden.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get global LCC penetration data

Authorizations:
OAuth2
query Parameters
from
required
integer

A year to search for data from.

to
required
integer

A year to search for data to.

Responses

Response Schema: application/json
required
Array of objects (LCCResult)
Array
year
required
integer

The year that the values apply to.

required
Array of objects

An array of months.

Array
month
required
integer

1-based index of the month (so 1 = January).

required
object

Types of possible values.

required
object

Seats for flights within the profile.

total
required
integer

Total number of seats (including LCC) flown within the profile.

lcc
required
integer

Total number of LCC seats flown within the profile.

object

International seats.

total
required
integer

Total number of seats (including LCC) flown between this and other profiles.

lcc
required
integer

Total number of LCC seats flown between this and other profiles.

incomplete
boolean

This will exist and be true if the data for this year is incomplete.

required
object
min
required
integer

The earliest year that there is LCC data for.

max
required
integer

The latest year that there is LCC data for.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get LCC penetration data for a profile

Authorizations:
OAuth2
path Parameters
type
required
integer
Enum: 4 5 6

Profile type ID. Can be countries, regions or metaregions.

id
required
integer

Profile ID.

query Parameters
from
required
integer

A year to search for data from.

to
required
integer

A year to search for data to.

Responses

Response Schema: application/json
required
Array of objects (LCCResult)
Array
year
required
integer

The year that the values apply to.

required
Array of objects

An array of months.

Array
month
required
integer

1-based index of the month (so 1 = January).

required
object

Types of possible values.

required
object

Seats for flights within the profile.

total
required
integer

Total number of seats (including LCC) flown within the profile.

lcc
required
integer

Total number of LCC seats flown within the profile.

object

International seats.

total
required
integer

Total number of seats (including LCC) flown between this and other profiles.

lcc
required
integer

Total number of LCC seats flown between this and other profiles.

incomplete
boolean

This will exist and be true if the data for this year is incomplete.

required
object
min
required
integer

The earliest year that there is LCC data for.

max
required
integer

The latest year that there is LCC data for.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Articles

Get a list of articles

Returns an array of articles in reverse-chronological order.

Authorizations:
OAuth2
query Parameters
num
integer

Maximum number of articles to return.

page
integer

Zero-based article page index.

categories
Array of integers (IntArray)

A comma-separated list of category IDs to filter by.

This will do an intersect merge on the tags that feature within the categories, meaning that only tags included in all the categories listed will be used for filtering.

IMPORTANT: If a categories parameter is included, any alert parameter will be ignored.

anycat
integer

If this is set to a non-zero value, then the categories matched in the categories parameter will not be intersected, giving results that match any listed category.

alert
string

Either an Alert ID or unique identifier for an Alert to filter the results by.

tags
Array of strings (StringArray)

Any tags to filter results by.

profileid
integer

If you want to filter results by profile, then this will be the profile ID that you want to filter by.

Both profile ID and profile type are required for profile filtering.

profiletype
integer

If you want to filter results by profile, then this will be the profile type that you want to filter by.

Both profile ID and profile type are required for profile filtering.

linked
integer
Value: 1

If this is set, then the content returned will be automatically linked to CAPA profiles on relevant keywords.

types
Array of integers (IntArray)

Comma-separated list of news type IDs to return. This will override anything sent in the "type" parameter.

ID Type Description
1 Analysis Analysis articles.
2 Press Releases CAPA press releases.
3 Direct News Sources Other company press releases.
4 Insight Short-form CAPA articles.
5 Sponsored Content Articles submitted by third parties.
6 Airline Leader Articles from Airline Leader.
7 Corporate Travel Community Articles from CTC.
8 CTC Sponsored Content Sponsored Articles from CTC.
type
string
Enum: "analysis" "direct-news-sources" "press-releases" "airline-leader" "ctc"

The type of news to return. This is just an easier way of specifying news types than using the "types" parameter.

from
string <date>
Example: from=2019-01-01

If this is set, it will filter results to any articles published after this date.

to
string <date>
Example: to=2019-01-01

If this is set, it will filter results to any articles published before this date.

Responses

Response Schema: application/json
required
Array of objects (Article)
Array
id
required
integer

Article ID.

title
required
string

The title of the article.

description
string

A short description of the article, for use as a meta description tag.

abstract
required
string

The article abstract. This will be the first paragraph or two of an article.

article
string

The article content. Concatenate this with the article abstract to get the full article. This will only be returned on individual article requests.

ad
required
boolean

This will be true if ads should be displayed within the article.

keypoints
required
string

A plaintext list of key points for an article. Not really used anymore.

featured
required
boolean

Treat this article as a featured article.

image
required
string

Article image URL. See resizing for info on getting the correct image size.

premium
required
boolean

Whether or not this is a premium article. If it is and the user has no access to the article, then the "article" key will be omitted from the result.

price
number

The price of a premium article. Left over from when we used to sell access to individual articles, and is unused now.

tags
required
Array of strings

An array of tags for the article.

timestamp
required
integer

UNIX timestamp of the article date.

url
required
string

The article URL.

source
string

Article source details (appears at the bottom of PR stories).

words
integer

Total number of words in the article.

required
object

The news type of the article.

id
required
string

Article type ID.

name
required
string

Article type name.

Array of objects

If the article has files attached to it for download, then they will be listed here. This key will only be included on individual article requests.

Documentation on downloading attachments.

Array
description
string

Description of the file.

filename
required
string

The file's filename.

mro
Array of integers

A list of MRO Matrix record IDs associated with the article.

required
object
total
required
integer

The total number of articles available that match the filters provided.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get an article

Authorizations:
OAuth2
path Parameters
id
required
integer

Article ID.

Responses

Response Schema: application/json
required
object (Article)
id
required
integer

Article ID.

title
required
string

The title of the article.

description
string

A short description of the article, for use as a meta description tag.

abstract
required
string

The article abstract. This will be the first paragraph or two of an article.

article
string

The article content. Concatenate this with the article abstract to get the full article. This will only be returned on individual article requests.

ad
required
boolean

This will be true if ads should be displayed within the article.

keypoints
required
string

A plaintext list of key points for an article. Not really used anymore.

featured
required
boolean

Treat this article as a featured article.

image
required
string

Article image URL. See resizing for info on getting the correct image size.

premium
required
boolean

Whether or not this is a premium article. If it is and the user has no access to the article, then the "article" key will be omitted from the result.

price
number

The price of a premium article. Left over from when we used to sell access to individual articles, and is unused now.

tags
required
Array of strings

An array of tags for the article.

timestamp
required
integer

UNIX timestamp of the article date.

url
required
string

The article URL.

source
string

Article source details (appears at the bottom of PR stories).

words
integer

Total number of words in the article.

required
object

The news type of the article.

id
required
string

Article type ID.

name
required
string

Article type name.

Array of objects

If the article has files attached to it for download, then they will be listed here. This key will only be included on individual article requests.

Documentation on downloading attachments.

Array
description
string

Description of the file.

filename
required
string

The file's filename.

mro
Array of integers

A list of MRO Matrix record IDs associated with the article.

Array of objects

If the user hasn't got authorization to download the full version of a premium article, an error key will be returned along with the main data.

Array
message
required
string
Value: "This is a premium article that requires CAPA Membership to view."
status
required
integer
Value: 401

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ]
}

Get an article's related news

This function returns a list of news content, related to the article by matching tags.

path Parameters
id
required
integer

News brief ID.

Responses

Response Schema: application/json
required
Array of objects (Article)

List of articles.

Array
id
required
integer

Article ID.

title
required
string

The title of the article.

description
string

A short description of the article, for use as a meta description tag.

abstract
required
string

The article abstract. This will be the first paragraph or two of an article.

article
string

The article content. Concatenate this with the article abstract to get the full article. This will only be returned on individual article requests.

ad
required
boolean

This will be true if ads should be displayed within the article.

keypoints
required
string

A plaintext list of key points for an article. Not really used anymore.

featured
required
boolean

Treat this article as a featured article.

image
required
string

Article image URL. See resizing for info on getting the correct image size.

premium
required
boolean

Whether or not this is a premium article. If it is and the user has no access to the article, then the "article" key will be omitted from the result.

price
number

The price of a premium article. Left over from when we used to sell access to individual articles, and is unused now.

tags
required
Array of strings

An array of tags for the article.

timestamp
required
integer

UNIX timestamp of the article date.

url
required
string

The article URL.

source
string

Article source details (appears at the bottom of PR stories).

words
integer

Total number of words in the article.

required
object

The news type of the article.

id
required
string

Article type ID.

name
required
string

Article type name.

Array of objects

If the article has files attached to it for download, then they will be listed here. This key will only be included on individual article requests.

Documentation on downloading attachments.

Array
description
string

Description of the file.

filename
required
string

The file's filename.

mro
Array of integers

A list of MRO Matrix record IDs associated with the article.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Download an article attachment

Authorizations:
OAuth2
path Parameters
id
required
integer

Article ID.

filename
required
string

Attached file to download.

query Parameters
inline
integer
Value: 1

If this is set, then the file will attempt to open in the browser if possible.

This has no effect if the request is not called by a browser.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Generate a PDF of an article

Authorizations:
OAuth2
path Parameters
id
required
integer

Article ID.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get current URL for article based on legacy URL

Generate the current URL of an article from a legacy URL from an earlier site iteration.

query Parameters
type
string
Enum: "analysis" "press-releases" "direct-news-sources" "insights" "sponsored" "airline-leader" "rar" "news"

Article type.

date
required
string <date>

Article creation date.

shorturl
required
string

Article shorturl component.

Responses

Response Schema: application/json
id
required
integer

Article ID.

url
required
string

Current version of article URL.

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "string"
}

News

Get a news brief

Authorizations:
OAuth2
path Parameters
id
required
integer

News brief ID.

query Parameters
linked
integer
Value: 1

If this flag is set, then the news brief content will be automatically linked to CAPA profiles on relevant keywords.

Responses

Response Schema: application/json
required
object (NewsBrief)
id
required
integer

ID of news brief.

title
required
string

Title of news brief.

article
string

HTML content of news brief. This will not be returned if the articles is not a headline and the user is not logged in with membership access.

date
required
integer

UNIX timestamp of the news brief's date.

url
required
string

URL of the news brief.

tags
required
Array of strings

An array of tags that the news brief has been tagged with.

mro
Array of integers

A list of MRO Matrix record IDs associated with the article.

premium
required
boolean

True if this article is not available for free.

object (Error)

This is an error response. It will be returned if there's any problems with the request. Note that is possible to have both data and errors returned in the one response, although it doesn't happen often.

The errors array will always have at least one element. The errors are in the array in an unspecified order - none is seen as more severe than the other.

required
Array of objects non-empty
Array (non-empty)
message
required
string

A short description of what the error was.

status
required
integer

The closest equivalent HTTP status code. This will usually match the HTTP status code that has been sent from the response.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": {
    }
}

Get a brief's related news

This function returns a list of news content, related to the daily brief by matching tags.

Authorizations:
OAuth2
path Parameters
id
required
integer

News brief ID.

query Parameters
linked
integer
Value: 1

If this flag is set, then the news brief content will be automatically linked to CAPA profiles on relevant keywords.

Responses

Response Schema: application/json
required
Array of objects

List of news briefs.

Array
id
required
integer

ID of news brief.

title
string

Title of news brief.

date
integer

UNIX timestamp of the news brief's date.

article
string

HTML content of news brief. This will not be returned if the articles is not a headline and the user is not logged in with membership access.

url
string

URL of the news brief.

tags
Array of strings

An array of tags that the news brief has been tagged with.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of news briefs

Returns an array of news briefs in reverse-chronological order.

Authorizations:
OAuth2
query Parameters
num
integer

Maximum number of results to return.

page
integer

Zero-based page index number.

categories
Array of integers (IntArray)
Example: categories=23,5,20,85

A comma-separated list of category IDs to filter by.

This will do an intersect merge on the tags that feature within the categories, meaning that only tags included in all the categories listed will be used for filtering.

IMPORTANT: If a categories parameter is included, any alert parameter will be ignored.

anycat
integer

If this is set to a non-zero value, then the categories matched in the categories parameter will not be intersected, giving results that match any listed category.

integer or string

Either an Alert ID or unique identifier for an Alert to filter the results by.

tags
Array of strings (StringArray)

Any tags to filter results by.

profileid
integer

If you want to filter results by profile, then this will be the profile ID that you want to filter by.

Both profile ID and profile type are required for profile filtering.

profiletype
integer

If you want to filter results by profile, then this will be the profile type that you want to filter by.

Both profile ID and profile type are required for profile filtering.

linked
integer
Value: 1

If this is set, then the content returned will be automatically linked to CAPA profiles on relevant keywords.

from
string <date>
Example: from=2019-01-01

If this is set, it will filter results to any articles published after this date.

to
string <date>
Example: to=2019-01-01

If this is set, it will filter results to any articles published before this date.

Responses

Response Schema: application/json
required
Array of objects (NewsBrief)
Array
id
required
integer

ID of news brief.

title
required
string

Title of news brief.

article
string

HTML content of news brief. This will not be returned if the articles is not a headline and the user is not logged in with membership access.

date
required
integer

UNIX timestamp of the news brief's date.

url
required
string

URL of the news brief.

tags
required
Array of strings

An array of tags that the news brief has been tagged with.

mro
Array of integers

A list of MRO Matrix record IDs associated with the article.

premium
required
boolean

True if this article is not available for free.

required
object
total
required
integer

The total number of articles available that match the filters provided.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Video

List available videos

query Parameters
num
integer

Maximum number of results to return.

page
integer

Zero-based page index number.

categories
Array of integers (IntArray)
Example: categories=23,5,20,85

A comma-separated list of category IDs to filter by.

This will do an intersect merge on the tags that feature within the categories, meaning that only tags included in all the categories listed will be used for filtering.

anycat
integer

If this is set to a non-zero value, then the categories matched in the categories parameter will not be intersected, giving results that match any listed category.

events
Array of integers (IntArray)
Example: events=23,5,20,85

A comma-separated list of CAPA event IDs to filter by - the results will match at least one event ID.

tags
Array of strings (StringArray)

Any tags to filter results by.

profileid
integer

If you want to filter results by profile, then this will be the profile ID that you want to filter by.

Both profile ID and profile type are required for profile filtering.

profiletype
integer

If you want to filter results by profile, then this will be the profile type that you want to filter by.

Both profile ID and profile type are required for profile filtering.

Responses

Response Schema: application/json
required
Array of objects (Video)
Array
id
required
integer

Internal video ID.

name
required
string

Video name.

url
required
string

Video URL on the CAPA site.

date
required
integer

UNIX timestamp of when the video was published.

description
required
string

HTML description of the video.

image
required
string

Video image URL. See resizing for info on getting the correct image size.

premium
required
boolean

Whether or not this is a premium article. If it is and the user has no access to the article, then the "article" key will be omitted from the result.

tags
required
Array of strings

An array of tags for the article.

required
object

Event the video was filmed at

id
integer

Event ID if it was a CAPA event.

name
required
string

Event name.

required
object

Date info for the event.

start
required
string <date>

ISO8601 date that the event started.

end
required
string <date>

ISO8601 date that the event ended.

certain
required
boolean

True if we are certain about these dates (will virtually always be true, as if a video is associated with an event it means the event has already happened).

url
string

If the event has a historical post-event info page, this will be the URL of it.

vimeoid
required
integer

Vimeo ID number of the video. Omission means it's not a Vimeo video and you should rely on the embed value instead.

embed
string

URL of the video if it is not hosted on Vimeo. Omitted if video is hosted on Vimeo.

transcript
string

A transcript of the video, if available.

required
object
total
required
integer

The total number of videos available that match the filters provided.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get a video

path Parameters
id
required
integer

Video ID.

Responses

Response Schema: application/json
required
object (Video)
id
required
integer

Internal video ID.

name
required
string

Video name.

url
required
string

Video URL on the CAPA site.

date
required
integer

UNIX timestamp of when the video was published.

description
required
string

HTML description of the video.

image
required
string

Video image URL. See resizing for info on getting the correct image size.

premium
required
boolean

Whether or not this is a premium article. If it is and the user has no access to the article, then the "article" key will be omitted from the result.

tags
required
Array of strings

An array of tags for the article.

required
object

Event the video was filmed at

id
integer

Event ID if it was a CAPA event.

name
required
string

Event name.

required
object

Date info for the event.

start
required
string <date>

ISO8601 date that the event started.

end
required
string <date>

ISO8601 date that the event ended.

certain
required
boolean

True if we are certain about these dates (will virtually always be true, as if a video is associated with an event it means the event has already happened).

url
string

If the event has a historical post-event info page, this will be the URL of it.

vimeoid
required
integer

Vimeo ID number of the video. Omission means it's not a Vimeo video and you should rely on the embed value instead.

embed
string

URL of the video if it is not hosted on Vimeo. Omitted if video is hosted on Vimeo.

transcript
string

A transcript of the video, if available.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Miscellaneous

Get global seat/ASK counts for the current week

This returns a simple object that lists all seats/ASKs for domestic and international routes worldwide, for the current week.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
object
required
object

Domestic seats/ASKs.

required
object

Domestic seats.

fclass
required
integer

Domestic first class seats.

bclass
required
integer

Domestic business class seats.

peclass
required
integer

Domestic premium economy class seats.

eclass
required
integer

Domestic economy class seats.

required
object

Domestic ASKs.

fclass
required
integer

Domestic first class ASKs.

bclass
required
integer

Domestic business class ASKs.

peclass
required
integer

Domestic premium economy class ASKs.

eclass
required
integer

Domestic economy class ASKs.

required
object

International seats/ASKs.

required
object

International seats.

fclass
required
integer

International first class seats.

bclass
required
integer

International business class seats.

peclass
required
integer

International premium economy class seats.

eclass
required
integer

International economy class seats.

required
object

International ASKs.

fclass
required
integer

International first class ASKs.

bclass
required
integer

International business class ASKs.

peclass
required
integer

International premium economy class ASKs.

eclass
required
integer

International economy class ASKs.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of all regions

This returns a list of all available regions. Needs refactoring.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

code
required
string = 2 characters

2-letter metaregion code.

url
required
string

Metaregion profile URL.

required
Array of objects
Array
id
required
integer

Region ID.

name
required
string

Region name.

code
required
string = 3 characters

3-letter region code.

url
required
string

Region profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a map token

Requests to OAG's mapping server need to be accompanied by a token, which proves that the request was coming from a CAPA user.

Authorizations:
OAuth2

Responses

Response Schema: application/json
data
required
string

A map token. This will be appended to the OAG iframe, under a parameter called CAPAID.

Response samples

Content type
application/json
{
  • "data": "string"
}

Check a map token

Check if a user has access to maps, based on the token supplied. This is normally called from OAG's mapping server.

Request Body schema: application/json
required
token
required
string

The user's map token. It expires as soon as it is validated.

Responses

Response Schema: application/json
required
object
id
required
integer

The user's ID.

access
required
boolean

Whether or not the user has access to OAG maps.

trial
required
boolean

Whether or not the user is trialling OAG maps.

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Search the CAPA site

This allows the user to perform a full-text search across CAPA's news, analysis, reports and profiles.

query Parameters
term
required
string

The search term to use.

where
string
Enum: "dist" "news" "analysis" "video" "briefs" "profiles" "report" "video"

The collection of items to search in. This is slightly confusing. dist means everything, news or analysis means analysis articles, video means video news articles, briefs means news, profiles means CAPA airline, airport, e.t.c. company profiles, report means traffic/financial/tourism report data.

tags
Array of strings (StringArray)

Results must match at least one tag in this comma-separated list.

sort
string
Enum: "date" "relevance"

How to sort results.

  • date: sorts them in reverse-chronological order.
  • relevance: sorts it by what the search engine thinks is most relevant.
page
integer

Page number of results. 10 results are returned at a time. This cannot be overridden.

from
string <date>

If you want to search within a date range, include From and To.

to
string <date>

If you want to search within a date range, include From and To.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

The ID of the result. Note that duplicates can exist, as this is the ID of the record itself. So if there's a news article with an ID of 52 and a profile with an ID of 52, they're both going to have the same ID. Differentiate by checking the "type" field.

premium
required
boolean

True if the result can only be viewed by CAPA members.

url
required
string

The URL of the result.

timestamp
required
integer

UNIX timestamp of the publication date of the result. For results that don't have publication dates (ie. profiles) this will be zero.

tags
required
string

A comma-separated list of tag IDs related to the result.

title
required
string

The name of the result.

snippet
required
string

A snippet of HTML that gives the user an idea of why the result matched.

type
required
string
Enum: "news" "briefs" "video" "airlines" "airports" "countries" "lessors" "regions"

The type of the result. Note that this is a bit weird in that news = analysis and briefs = news.

object
total
required
integer

The total results found.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get current homepage content

Responses

Response Schema: application/json
required
Array of objects
Array
type
required
string

Unique identifier string of the "type" of the result.

title
required
string

The title of the section.

required
Array of Event (object) or NewsBrief (object) or Video (object) or Article (object) or Report (object)

An array of items for that data type.

Array
Any of
id
required
integer

Event ID

name
required
string

The name of the event.

info
required
string

A short, one-sentence text description of the event.

url
string

The event's URL.

object

If the event has a live stream associated, these are the details of it.

id
required
integer

Live stream ID.

start
required
integer

UNIX timestamp of when the live stream starts.

end
required
integer

UNIX timestamp of when the live stream ends.

url
required
string

URL of the livestream event page on the CAPA site.

embed
required
string

URL to use for embedding the livestream event.

required
object

The city the event is being held in.

id
required
string

City ID.

name
required
string

City name.

required
object

The country the event is being held in.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string = 2 characters

Two-letter country code.

required
object

The metaregion the event is being held in.

id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

required
object

The date of the event. Dates are in the timezone of the event's city.

start
required
string <date>

The start date of the event, in ISO8601 format.

end
required
string <date>

The end date of the event, in ISO8601 format.

certain
required
boolean

Whether or not the dates for this event are certain, or just placeholder dates.

tech
required
boolean

Whether this event has an IT-focused component or not.

finance
required
boolean

Whether this event has a finance focused component or not.

ctc
integer

Indicates if Corporate Travel Community is involved in the event.

An Aviation-only event is morked with '0', a CTC-only event is marked as '1' and an Aviation event with a CTC presence is marked as '2'

corporate
required
boolean

Whether this event has a corporate travel focused component or not.

airline
required
boolean

Whether this event has an airline focus or not.

airport
required
boolean

Whether this event has an airport focus or not.

attendees
required
integer

Expected number of attendees.

australasia
required
boolean

True if this is a CAPA-ACTE event.

splash
string

The URL for an event splash image, if available. Info on resizing images.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of available categories

Categories are groups of tags that are used to filter Alerts and categorise news and analysis articles, as well as profiles.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Category grouping ID.

name
required
string

Category grouping name.

required
Array of objects

An array of categories.

Array
id
required
integer

Category ID.

name
required
string

Category name.

url
string

URL address for the CAPA page filtering by the Category.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get category information

path Parameters
id
required
integer

Category ID. This parameter is ignored if "search" or "shortname" is set.

query Parameters
search
string

Used to filter for categories by a search term (only returns one result).

shortname
string

Show the category by shortname - a unique text abbreviation identifying the category. This parameter is ignored if "search" is set.

Responses

Response Schema: application/json
required
object
id
required
integer

Category ID.

name
required
string

Category name.

parent
required
integer

Category parent ID. This will be zero if the category has no parent.

sortorder
required
integer

Integer value relating to where the category should appear if in a list of categories. 0 = top of the list.

url
string

The category URL.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of countries

Returns a list of countries and their corresponding IDs.

IMPORTANT: Note that there are two separate versions of the countries list - one is used for user accounts and shop items, and the other is used for all data-related URLs.

query Parameters
shop
integer
Value: 1

Send a shop flag if you want to return countries from the shop instead of the main data database.

If you're working with data, you want the main database. If you're working with user accounts, you want the shop database.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
string

Country ID.

name
required
string

Country name.

code
string = 2 characters

2-letter country code.

url
string

Country URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get available industry sectors

Get a list of industry sectors. Mostly useful when creating/updating accounts.

Responses

Response Schema: application/json
required
Array of objects

Industry sectors.

Array
id
required
integer

Industry sector ID.

name
required
string

Industry sector name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all cities

This will return a huge list of cities, grouped by country.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Country ID.

name
required
string

Country name.

required
Array of objects

An array of cities within the country.

Array
id
required
integer

City ID.

name
required
string

City name.

state
required
string

State that the city is in (if known).

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all airports

Return a huge array of all airports within our system.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Country ID.

name
required
string

Country name.

url
string

The country profile URL.

required
Array of objects

An array of airports within this country.

Array
id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string <= 3 characters

Airport IATA code.

icao
required
string <= 4 characters

Airport ICAO code.

url
string

The airport profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all new airports

Return a huge array of all new airports (i.e. airports that are planned or undergoing construction) within our system.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Country ID.

name
required
string

Country name.

url
string

The country profile URL.

required
Array of objects

An array of airports within this country.

Array
id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string <= 3 characters

Airport IATA code.

icao
required
string <= 4 characters

Airport ICAO code.

url
string

The airport profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all airline alliances

Responses

Response Schema: application/json
required
Array of objects

An array of airline alliances.

Array
id
required
integer

Alliance ID.

name
required
string

Alliance name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all airlines

Get a list of all available airlines.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Airline ID.

name
required
string

Airline name.

iata
required
string

Airline IATA code.

icao
required
string

Airline ICAO code.

efrom
required
string <date>

Date that the airline began operations. May be 0000-00-00 if it is unknown.

eto
required
string <date>

Date that the airline ceased operations. If the airline is still in operation, this value will be null.

bizmodel
required
integer

Business model ID of the airline.

startup
required
boolean

True if we classify the airline as a startup.

failed
required
integer

True if we classify the airline as a failed startup.

startupdate
required
string

Date the airline started up. This is a string, not a date as it could be a year, or a month, or a quarter etc.

url
required
string

The airline profile URL.

required
object

The country the airline is based in.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string = 2 characters

2-letter country code.

url
required
string

Country profile URL.

required
object

The country's region.

id
required
integer

Region ID.

name
required
string

Region name.

url
required
string

Region profile URL.

metaregion
required
integer

Metaregion ID.

required
object

The airline's main hub.

id
required
integer

Airport ID.

name
required
string

Airport name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
required
string

The airport profile URL.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all investors

Responses

Response Schema: application/json
required
Array of objects

An array of investors.

Array
id
required
integer

Investor ID.

name
required
string

Investor name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all fleet statuses

Get a list of all possible fleet statuses.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Status ID.

name
required
string

Status name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of airline business models

Get a list of all possible airline business models.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Business model ID.

name
required
string

Business model name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of all aircraft roles

Returns an array of all possible aircraft roles.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Role ID.

name
required
string

Role name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Search for a tag

This allows a user to retrieve a tag and its corresponding ID based on a search.

query Parameters
term
required
string
Example: term=qan

Search for any tags beginning with this string.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Tag ID.

name
required
string

Tag name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Download an XML sitemap index

Search engines use XML sitemaps in order to find all the available links within a website. Accessing this URL returns an XML sitemap index of the CAPA website.

Responses

Download an XML sitemap

Access this to download an individual XML sitemap. Generally this is not accessed directly, and is instead piped through the CAPA site.

path Parameters
filename
required
string
Example: sitemap-0.xml.gz

A sitemap filename.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Download a Google News XML sitemap

This returns an XML sitemap of the latest news, for use in Google News.

path Parameters
required
integer or string

A type of news

Responses

Generate error email

This function is automatically triggered by the CAPA site when an error occurs. It generates an email to the CAPA development team, listing the error and associated details.

Request Body schema: application/json
required
error
required
string

The provided JSX error message.

info
required
string

A description of the component path the error was located in.

userAgent
required
string

A string containing the User Agent request header.

url
required
string

A string containing the URL the error occurred on.

history
Array of any[ items ]

An array containing the User history in this session.

message
string

A string containing the content of the error report text box that appears when an error on the CAPA site occurs, filled in by the user.

userid
integer

If the user is logged into a CAPA account, the account's ID is included here.

Responses

Request samples

Content type
application/json
{
  • "error": "string",
  • "info": "string",
  • "userAgent": "string",
  • "url": "string",
  • "history": [
    ],
  • "message": "string",
  • "userid": 0
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Generate feedback email

This function is used by the CAPA feedback system within the Fleet Matrix aircraft pages and MRO Matrix entry pages. It generates an email to the CAPA data team, allowing a user to submit feedback on the site.

Authorizations:
OAuth2
Request Body schema: application/json
required
feedback
required
string

The feedback data from the user.

source
required
string
Enum: "fleet-record" "mro-record"

Used to indicate whether the feedback originated from the Fleet or the MRO components.

id
required
integer

This contains the id from the page URL for the aircraft/MRO entry the function was called from.

Responses

Request samples

Content type
application/json
{
  • "feedback": "string",
  • "source": "fleet-record",
  • "id": 0
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Generate feedback email

This function blocks direct access to a stored file and instead routes it though a secure to generate and download the file indirectly.

Authorizations:
OAuth2
path Parameters
filename
required
string

File name.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List CAPA API documentation (json)

Returns the CAPA API documentation in the format of a json file.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List CAPA API documentation (html)

Returns the CAPA API documentation in the format of a html file.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Publications

Get a list of mailable publications

Provides a list of products that can be received via email from CAPA.

Responses

Response Schema: application/json
required
Array of objects
Array
object
id
required
integer

Product ID.

name
required
string

Product name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of publications

Responses

Response Schema: application/json
object
required
Array of objects

Current publications.

Array
id
required
integer

Publication ID.

shortname
required
string

Short unique lowercase abbreviation for the publication, mostly for use in URLs.

name
required
string

Publication name.

description
required
string

HTML description of the publication.

hidden
required
boolean

Flag indicating whether or not this publication should be publicly listed.

frequency
required
string

Description of the publication frequency.

freqnum
required
integer

A frequency ID. They look like this:

ID Frequency
0 Daily
1 Weekly
2 Fortnightly
3 Monthly
4 Bi-monthly
5 Annually
6 Once only
required
object

Info on the most recent issue.

id
required
integer

Issue ID (not to be confused with issue number).

filename
required
string

The filename of the issue.

date
required
integer

UNIX timestamp of the issue's publication date.

title
required
string

Issue title (generally blank)

description
required
string

HTML description of the issue (generally blank).

issue
required
integer

Issue number (not to be confused with issue ID).

required
Array of objects

Old archived publications.

Array
shortname
required
string

Short unique lowercase abbreviation for the publication, mostly for use in URLs.

name
required
string

Name of the publication.

Response samples

Content type
application/json
{
  • "data": {
    }
}

List issues for a current publication

Authorizations:
OAuth2
path Parameters
id
required
integer

Publication ID.

query Parameters
num
integer

Maximum number of results to return.

page
integer

Zero-based page index of results.

Responses

Response Schema: application/json
required
Array of objects (Issue)

An array of issues.

Array
id
integer

Issue ID (don't confuse with issue number).

issue
integer

Issue number (don't confuse with issue ID).

title
required
string

Issue title (usually blank).

Issue title (usually blank).

date
required
integer

UNIX timestamp of the issue publication date.

shortname
string

Publication shortname - a short, unique lowercase abbreviation identifying the publication.

description
required
string

HTML description of the issue (usually blank).

password
string

File password. A long time ago we used to distribute issues as password-protected PDFs. This has not been done for many years now.

filename
required
string

Issue filename.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get info for an issue

Authorizations:
OAuth2
path Parameters
id
required
integer

Publication ID.

issueid
required
integer

Issue ID.

Responses

Response Schema: application/json
required
object (Issue)
id
integer

Issue ID (don't confuse with issue number).

issue
integer

Issue number (don't confuse with issue ID).

title
required
string

Issue title (usually blank).

Issue title (usually blank).

date
required
integer

UNIX timestamp of the issue publication date.

shortname
string

Publication shortname - a short, unique lowercase abbreviation identifying the publication.

description
required
string

HTML description of the issue (usually blank).

password
string

File password. A long time ago we used to distribute issues as password-protected PDFs. This has not been done for many years now.

filename
required
string

Issue filename.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Download an issue

Authorizations:
OAuth2
path Parameters
id
required
integer

Publication ID.

issueid
required
integer

Issue ID.

Responses

Download an issue from an archived publication

Authorizations:
OAuth2
path Parameters
shortname
required
string

Publication shortname - a unique text abbreviation identifying the publication.

filename
required
string

Publication filename.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a list of issues for an archived publication

Authorizations:
OAuth2
path Parameters
shortname
required
string

Publication shortname - a unique text abbreviation identifying the publication.

Responses

Response Schema: application/json
data
required
Array of strings

A reverse-chronological array listing every filename for every issue of the archived publication.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Rankings

Get ranked airlines

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

month
required
string

The name and year of the month of data being ranked in the style of 'Jun-2021'. Note: if the 'week' parameter is set, this parameter is ignored.

direction
required
string
Enum: "both" "dep" "arr"

This limits the direction of the flight data that is used for rankings. This applies only if the data is ranked by a location profile (airport, country, e.t.c.) or is being filtered by such a profile.

Value Included Data
both Flight data both arriving at and departing airports is used
dep Flight data departing airports is used
arr Flight data arriving at airports is used
type
required
string
Enum: "system" "international" "domestic"

This indicates if the data displays only international flights ('international'), domestic flights ('domestic') or both ('system').

bizmodel
required
integer

This filters flight data by the airlines' business model ID.

alliance
required
integer

This filters flight data by the airlines' alliance ID.

rfrom
required
string

This filters by flights departing/arriving at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This may be combined with the 'rto' and 'cto' parameters.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data 
| both | Flight data both arriving at and departing this region |
| dep | Flight data departing this region is used |
| arr | Flight data arriving at this region is used |
rto
required
string

This filters by flights arriving/departing at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data arriving at this region is used
arr Flight data departing this region is used
region
required
string

This filters flight data by the ID of the region the flight airport(s) are based in. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" parameter is not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data departing this region is used
arr Flight data arriving at this region is used
regionlocal
required
interger

If this is set to 1, then the only flights shown are those where the airport(s) defined by the 'direction' parameter are based in the region. If it is set to 2, it shows only flights for airport(s) defined by the 'direction' parameter are not based in the region.

This parameter only applies if the "region" parameter is set.

cfrom
required
integer

This filters by flights departing/arriving at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
cto
required
integer

This filters by flights arriving/departing at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data arriving at this country/territory is used
arr Flight data departing this country/territory is used
country
required
integer

This filters flight data by the ID of the country/territory the flight airport(s) are based in.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
local
required
boolean

If this is set to 1, then the only flights shown are those where the airline is based in the country/territory.

This parameter only applies if the "country" parameter is set.

cityfrom
required
integer

This filters by flights departing/arriving at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
cityto
required
integer

This filters by flights arriving/departing at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data arriving at this city is used
arr Flight data departing this city is used
city
required
integer

This filters flight data by the ID of the city the flight airport(s) are based in.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
airport
required
integer

This filters flight data by the ID of the airport the flight connects to.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this airport
dep Flight data departing this airport is used
arr Flight data arriving at this airport is used

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

iata
required
string

Profile IATA code.

icao
required
string

Profile ICAO code.

url
required
string

URL of profile CAPA page.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

required
object
routes
required
integer

Total number of different routes flown (no duplicates).

airports
required
integer

Total number of different destination airports flown to (no duplicates).

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked airline groups

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

month
required
string

The name and year of the month of data being ranked in the style of 'Jun-2021'. Note: if the 'week' parameter is set, this parameter is ignored.

direction
required
string
Enum: "both" "dep" "arr"

This limits the direction of the flight data that is used for rankings. This applies only if the data is ranked by a location profile (airport, country, e.t.c.) or is being filtered by such a profile.

Value Included Data
both Flight data both arriving at and departing airports is used
dep Flight data departing airports is used
arr Flight data arriving at airports is used
type
required
string
Enum: "system" "international" "domestic"

This indicates if the data displays only international flights ('international'), domestic flights ('domestic') or both ('system').

bizmodel
required
integer

This filters flight data by the airlines' business model ID.

rfrom
required
string

This filters by flights departing/arriving at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This may be combined with the 'rto' and 'cto' parameters.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data 
| both | Flight data both arriving at and departing this region |
| dep | Flight data departing this region is used |
| arr | Flight data arriving at this region is used |
rto
required
string

This filters by flights arriving/departing at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data arriving at this region is used
arr Flight data departing this region is used
cfrom
required
integer

This filters by flights departing/arriving at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
cto
required
integer

This filters by flights arriving/departing at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data arriving at this country/territory is used
arr Flight data departing this country/territory is used
country
required
integer

This filters flight data by the ID of the country/territory the flight airport(s) are based in.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
local
required
boolean

If this is set to 1, then the only flights shown are those where the airline is based in the country/territory.

This parameter only applies if the "country" parameter is set.

cityfrom
required
integer

This filters by flights departing/arriving at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
cityto
required
integer

This filters by flights arriving/departing at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data arriving at this city is used
arr Flight data departing this city is used
city
required
integer

This filters flight data by the ID of the city the flight airport(s) are based in.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
showOnlyGroups
required
boolean

If set to 1, this forces the results to return only airline group rankings. If set to 0, then it also adds airlines that are not part of an airline group to the rankings list.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

url
required
string

URL of profile CAPA page.

required
object

Profile type.

id
required
integer

Profile type ID.

name
required
string

Profile type name.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked airports

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

month
required
string

The name and year of the month of data being ranked in the style of 'Jun-2021'. Note: if the 'week' parameter is set, this parameter is ignored.

direction
required
string
Enum: "both" "dep" "arr"

This limits the direction of the flight data that is used for rankings. This applies only if the data is ranked by a location profile (airport, country, e.t.c.) or is being filtered by such a profile.

Value Included Data
both Flight data both arriving at and departing airports is used
dep Flight data departing airports is used
arr Flight data arriving at airports is used
type
required
string
Enum: "system" "international" "domestic"

This indicates if the data displays only international flights ('international'), domestic flights ('domestic') or both ('system').

bizmodel
required
integer

This filters flight data by the airlines' business model ID.

airline
required
integer

This filters flight data by the airline IDs operating the flight.

investor
required
integer

This filters flight data by the ID of the investor profile investing in airports the flight connects to at either end. This parameter is not affected by the 'direction' parameter.

rfrom
required
string

This filters by flights departing/arriving at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This may be combined with the 'rto' and 'cto' parameters.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data 
| both | Flight data both arriving at and departing this region |
| dep | Flight data departing this region is used |
| arr | Flight data arriving at this region is used |
rto
required
string

This filters by flights arriving/departing at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data arriving at this region is used
arr Flight data departing this region is used
region
required
string

This filters flight data by the ID of the region the flight airport(s) are based in. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" parameter is not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data departing this region is used
arr Flight data arriving at this region is used
regionlocal
required
interger

If this is set to 1, then the only flights shown are those where the airport(s) defined by the 'direction' parameter are based in the region. If it is set to 2, it shows only flights for airport(s) defined by the 'direction' parameter are not based in the region.

This parameter only applies if the "region" parameter is set.

cfrom
required
integer

This filters by flights departing/arriving at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
cto
required
integer

This filters by flights arriving/departing at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data arriving at this country/territory is used
arr Flight data departing this country/territory is used
country
required
integer

This filters flight data by the ID of the country/territory the flight airport(s) are based in.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
local
required
boolean

If this is set to 1, then the only flights shown are those where the airline is based in the country/territory.

This parameter only applies if the "country" parameter is set.

cityfrom
required
integer

This filters by flights departing/arriving at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
cityto
required
integer

This filters by flights arriving/departing at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data arriving at this city is used
arr Flight data departing this city is used
city
required
integer

This filters flight data by the ID of the city the flight airport(s) are based in.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
airport
required
integer

This filters flight data by the ID of the airport the flight connects to.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this airport
dep Flight data departing this airport is used
arr Flight data arriving at this airport is used

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

iata
required
string

Profile IATA code.

icao
required
string

Profile ICAO code.

url
required
string

URL of profile CAPA page.

required
object

Airport city.

id
required
integer

City ID.

name
required
string

City name.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

object
routes
integer

Total number of different routes flown (no duplicates).

airports
integer

Total number of different destination airports flown to (no duplicates).

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked investors

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

month
required
string

The name and year of the month of data being ranked in the style of 'Jun-2021'. Note: if the 'week' parameter is set, this parameter is ignored.

direction
required
string
Enum: "both" "dep" "arr"

This limits the direction of the flight data that is used for rankings. This applies only if the data is ranked by a location profile (airport, country, e.t.c.) or is being filtered by such a profile.

Value Included Data
both Flight data both arriving at and departing airports is used
dep Flight data departing airports is used
arr Flight data arriving at airports is used
type
required
string
Enum: "system" "international" "domestic"

This indicates if the data displays only international flights ('international'), domestic flights ('domestic') or both ('system').

bizmodel
required
integer

This filters flight data by the airlines' business model ID.

airline
required
integer

This filters flight data by the airline IDs operating the flight.

rfrom
required
string

This filters by flights departing/arriving at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This may be combined with the 'rto' and 'cto' parameters.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data 
| both | Flight data both arriving at and departing this region |
| dep | Flight data departing this region is used |
| arr | Flight data arriving at this region is used |
rto
required
string

This filters by flights arriving/departing at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data arriving at this region is used
arr Flight data departing this region is used
region
required
string

This filters flight data by the ID of the region the flight airport(s) are based in. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" parameter is not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data departing this region is used
arr Flight data arriving at this region is used
cfrom
required
integer

This filters by flights departing/arriving at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
cto
required
integer

This filters by flights arriving/departing at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data arriving at this country/territory is used
arr Flight data departing this country/territory is used
country
required
integer

This filters flight data by the ID of the country/territory the flight airport(s) are based in.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
local
required
boolean

If this is set to 1, then the only flights shown are those where the airline is based in the country/territory.

This parameter only applies if the "country" parameter is set.

cityfrom
required
integer

This filters by flights departing/arriving at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
cityto
required
integer

This filters by flights arriving/departing at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data arriving at this city is used
arr Flight data departing this city is used
city
required
integer

This filters flight data by the ID of the city the flight airport(s) are based in.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
airport
required
integer

This filters flight data by the ID of the airport the flight connects to.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this airport
dep Flight data departing this airport is used
arr Flight data arriving at this airport is used

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

url
required
string

URL of profile CAPA page.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked alliances

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

month
required
string

The name and year of the month of data being ranked in the style of 'Jun-2021'. Note: if the 'week' parameter is set, this parameter is ignored.

direction
required
string
Enum: "both" "dep" "arr"

This limits the direction of the flight data that is used for rankings. This applies only if the data is ranked by a location profile (airport, country, e.t.c.) or is being filtered by such a profile.

Value Included Data
both Flight data both arriving at and departing airports is used
dep Flight data departing airports is used
arr Flight data arriving at airports is used
type
required
string
Enum: "system" "international" "domestic"

This indicates if the data displays only international flights ('international'), domestic flights ('domestic') or both ('system').

bizmodel
required
integer

This filters flight data by the airlines' business model ID.

rfrom
required
string

This filters by flights departing/arriving at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This may be combined with the 'rto' and 'cto' parameters.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data 
| both | Flight data both arriving at and departing this region |
| dep | Flight data departing this region is used |
| arr | Flight data arriving at this region is used |
rto
required
string

This filters by flights arriving/departing at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data arriving at this region is used
arr Flight data departing this region is used
cfrom
required
integer

This filters by flights departing/arriving at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
cto
required
integer

This filters by flights arriving/departing at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data arriving at this country/territory is used
arr Flight data departing this country/territory is used
country
required
integer

This filters flight data by the ID of the country/territory the flight airport(s) are based in.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
local
required
boolean

If this is set to 1, then the only flights shown are those where the airline is based in the country/territory.

This parameter only applies if the "country" parameter is set.

cityfrom
required
integer

This filters by flights departing/arriving at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
cityto
required
integer

This filters by flights arriving/departing at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data arriving at this city is used
arr Flight data departing this city is used
city
required
integer

This filters flight data by the ID of the city the flight airport(s) are based in.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

url
required
string

URL of profile CAPA page.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked routes

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

direction
required
string
Enum: "both" "dep" "arr"

This limits the direction of the flight data that is used for rankings. This applies only if the data is ranked by a location profile (airport, country, e.t.c.) or is being filtered by such a profile.

Value Included Data
both Flight data both arriving at and departing airports is used
dep Flight data departing airports is used
arr Flight data arriving at airports is used
type
required
string
Enum: "system" "international" "domestic"

This indicates if the data displays only international flights ('international'), domestic flights ('domestic') or both ('system').

bizmodel
required
integer

This filters flight data by the airlines' business model ID.

airline
required
integer

This filters flight data by the airline IDs operating the flight.

rfrom
required
string

This filters by flights departing/arriving at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This may be combined with the 'rto' and 'cto' parameters.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data 
| both | Flight data both arriving at and departing this region |
| dep | Flight data departing this region is used |
| arr | Flight data arriving at this region is used |
rto
required
string

This filters by flights arriving/departing at a selected metaregion/region. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data arriving at this region is used
arr Flight data departing this region is used
cfrom
required
integer

This filters by flights departing/arriving at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
cto
required
integer

This filters by flights arriving/departing at a selected country/territory ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data arriving at this country/territory is used
arr Flight data departing this country/territory is used
country
required
integer

This filters flight data by the ID of the country/territory the flight airport(s) are based in.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
cityfrom
required
integer

This filters by flights departing/arriving at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used
cityto
required
integer

This filters by flights arriving/departing at a selected city ID.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data arriving at this city is used
arr Flight data departing this city is used
city
required
integer

This filters flight data by the ID of the city the flight airport(s) are based in.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used

Responses

Response Schema: application/json
required
Array of objects
Array
required
object

Departure airport.

id
required
integer

Profile ID.

name
required
string

Profile Name.

iata
required
string

Profile IATA code.

icao
required
string

Profile ICAO code.

url
required
string

URL of profile CAPA page.

required
object

Airport city.

id
required
integer

Profile ID.

name
required
string

Profile Name.

required
object

City country.

id
required
integer

Profile ID.

name
required
string

Profile Name.

url
required
string

URL of profile CAPA page.

required
object

Arrival airport.

id
required
integer

Profile ID.

name
required
string

Profile Name.

iata
required
string

Profile IATA code.

icao
required
string

Profile ICAO code.

url
required
string

URL of profile CAPA page.

required
object

Airport city.

id
required
integer

Profile ID.

name
required
string

Profile Name.

required
object

City country.

id
required
integer

Profile ID.

name
required
string

Profile Name.

url
required
string

URL of profile CAPA page.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

required
object

Values for week one year prior to requested week.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked countries

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

direction
required
string
Enum: "both" "dep" "arr"

This limits the direction of the flight data that is used for rankings. This applies only if the data is ranked by a location profile (airport, country, e.t.c.) or is being filtered by such a profile.

Value Included Data
both Flight data both arriving at and departing airports is used
dep Flight data departing airports is used
arr Flight data arriving at airports is used
type
required
string
Enum: "system" "international" "domestic"

This indicates if the data displays only international flights ('international'), domestic flights ('domestic') or both ('system').

airline
required
integer

This filters flight data by the airline IDs operating the flight.

region
required
string

This filters flight data by the ID of the region the flight airport(s) are based in. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" parameter is not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data departing this region is used
arr Flight data arriving at this region is used

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

code
required
string

Profile IATA code.

url
required
string

URL of profile CAPA page.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

arrfreq
required
integer

Total arrival frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked regions

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

direction
required
string
Enum: "both" "dep" "arr"

This limits the direction of the flight data that is used for rankings. This applies only if the data is ranked by a location profile (airport, country, e.t.c.) or is being filtered by such a profile.

Value Included Data
both Flight data both arriving at and departing airports is used
dep Flight data departing airports is used
arr Flight data arriving at airports is used
type
required
string
Enum: "system" "international" "domestic"

This indicates if the data displays only international flights ('international'), domestic flights ('domestic') or both ('system').

airline
required
integer

This filters flight data by the airline IDs operating the flight.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

code
required
string

Profile IATA code.

url
required
string

URL of profile CAPA page.

seats
required
integer

Total seats.

asks
required
integer

Total AFTKs.

depfreq
required
integer

Total departure frequency.

arrfreq
required
integer

Total arrival frequency.

cargo
required
integer

Total cargo payload (kg).

aftks
required
integer

Total AFTKs.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked airline fleets

Authorizations:
OAuth2
query Parameters
week
required
string <date>

The first day of the week of data being ranked.

bizmodel
required
integer

This filters flight data by the airlines' business model ID.

status
integer

Aircraft status ID.

role
integer

Aircraft role ID.

region
required
string

This filters flight data by the ID of the region the flight airport(s) are based in. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" parameter is not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data departing this region is used
arr Flight data arriving at this region is used
country
required
integer

This filters flight data by the ID of the country/territory the flight airport(s) are based in.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
group
string
Enum: "1" "10" "aagcombination" "4"

Identifies the profile groupings for fleet data. The options are listed below.

Value Included Profiles
1 Groups by airline profiles
10 Groups by airline group profiles
aagcombination Groups by airline group profiles, and airline profiles not part of an airline group
4 Groups by country airline is based in

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

required
object

Profile type.

id
required
integer

Profile type ID.

iata
required
string

Profile IATA code.

icao
required
string

Profile ICAO code.

url
required
string

URL of profile CAPA page.

required
object

Totals of aircraft.

narrow
integer

Total number of narrow-body aircraft.

wide
integer

Total number of wide-body aircraft.

other
integer

Total number of other types of aircraft.

required
object

Totals of seats.

narrow
integer

Total number of seats on narrow-body aircraft.

wide
integer

Total number of seats on wide-body aircraft.

other
integer

Total number of seats on other types of aircraft.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get ranked traffic reports

Authorizations:
OAuth2
query Parameters
datefrequency
required
string
Enum: "FY" "HY" "Q" "M"

Defines the date period of traffic data used. If set to any value but 'FY', then the 'dateperiod' parameter is enabled.

Value Included Profiles
FY Groups by airline profiles
HY Groups by airline group profiles
Q Groups by airline group profiles, and airline profiles not part of an airline group
M Groups by country airline is based in
dateyear
required
string

This indicates which year the data is pulled from. If the 'datefrequency' parameter is set to 'FY' then this can also be set to 'latest' to show the latest year of full data.

If the year's data is incomplete it shows 'Year-to-Date' calculated from monthly data.

dateperiod
required
integer

If the 'datefrequency' parameter is not set to 'FY' then this defines which year half/quarter/month the data is pulled from.

bizmodel
required
integer

This filters flight data by the airlines' business model ID.

alliance
required
integer

This filters flight data by the airlines' alliance ID.

region
required
string

This filters flight data by the ID of the region the flight airport(s) are based in. If the profile is a metaregion, preface the ID with a 'm' otherwise use only the ID.

This parameter only applies if the "country" parameter is not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this region
dep Flight data departing this region is used
arr Flight data arriving at this region is used
country
required
integer

This filters flight data by the ID of the country/territory the flight airport(s) are based in.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this country/territory
dep Flight data departing this country/territory is used
arr Flight data arriving at this country/territory is used
city
required
integer

This filters flight data by the ID of the city the flight airport(s) are based in.

This parameter only applies if the "country" and "region" parameters are not set.

The direction of flights for this parameter depends on the 'direction' parameter as below.

Value Included Data
both Flight data both arriving at and departing this city
dep Flight data departing this city is used
arr Flight data arriving at this city is used

Responses

Response Schema: application/json
required
Array of objects (RankingReportResults)
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

iata
required
string

Profile IATA code.

icao
required
string

Profile ICAO code.

yearend
required
string

Month the profile's end-of-financial-year lies in.

required
object

Date the rank applies to.

year
required
integer

Year.

period
required
integer

Integer value of date period.

name
required
string

Name value of date period.

required
object
id
required
integer

Airline business model ID.

name
required
string

Airline business model name.

required
object
id
required
integer

Profile type ID.

name
required
string

Profile type name.

required
object
id
required
integer

Alliance ID.

name
required
string

Alliance name.

required
object

Data on locations the profile is located in - May be empty if not applicable to the profile type.

required
object
id
required
integer

City ID.

name
required
string

City name.

required
object
id
required
integer

Country ID.

name
required
string

Country name.

required
object
id
required
integer

Region ID.

name
required
string

Region name.

required
object
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

URL of profile CAPA page.

required
Array of objects

list of values. Note: the object key corresponds to the data indicator ID.

Array
id
required
integer

Data indicator ID.

name
required
string

Data indicator name.

value
required
integer

Data value.

ispercent
required
boolean

If true, then the value is a percentage.

range
required
string

Name of date period data applies to.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of possible profile groupings and data indicators by traffic report date frequency type.

Responses

Response Schema: application/json
required
object (RankingReportOptions)

A list of possible data indicators and profile groupings for the report type.

required
object

Lists all possible data indicators by date type.

required
Array of objects (RankingDataIndicator) [ items ]

Lists all possible data indicators for full year reports.

Note: the key corresponds to the profile type ID, e.g. the indicators in the '1' array apply to airline profiles.

Array
Array
id
required
integer

Data indicator ID.

name
required
integer

Data indicator name.

fieldorder
required
integer

Indicates where in the list of indicators it should be displayed.

required
Array of objects

Lists second-level breakdowns of this data indicator.

Note: although data indicator breakdowns can theoretically continue infinitely, a max of two levels is returned by this function.

Array
id
required
integer

Child data indicator ID.

name
required
integer

Child data indicator name.

required
Array of objects (RankingDataIndicator) [ items ]

Lists all possible data indicators for half year reports.

Note: the key corresponds to the profile type ID, e.g. the indicators in the '1' array apply to airline profiles.

Array
Array
id
required
integer

Data indicator ID.

name
required
integer

Data indicator name.

fieldorder
required
integer

Indicates where in the list of indicators it should be displayed.

required
Array of objects

Lists second-level breakdowns of this data indicator.

Note: although data indicator breakdowns can theoretically continue infinitely, a max of two levels is returned by this function.

Array
id
required
integer

Child data indicator ID.

name
required
integer

Child data indicator name.

required
Array of objects (RankingDataIndicator) [ items ]

Lists all possible data indicators for quarterly reports.

Note: the key corresponds to the profile type ID, e.g. the indicators in the '1' array apply to airline profiles.

Array
Array
id
required
integer

Data indicator ID.

name
required
integer

Data indicator name.

fieldorder
required
integer

Indicates where in the list of indicators it should be displayed.

required
Array of objects

Lists second-level breakdowns of this data indicator.

Note: although data indicator breakdowns can theoretically continue infinitely, a max of two levels is returned by this function.

Array
id
required
integer

Child data indicator ID.

name
required
integer

Child data indicator name.

required
Array of objects (RankingDataIndicator) [ items ]

Lists all possible data indicators for monthly reports.

Note: the key corresponds to the profile type ID, e.g. the indicators in the '1' array apply to airline profiles.

Array
Array
id
required
integer

Data indicator ID.

name
required
integer

Data indicator name.

fieldorder
required
integer

Indicates where in the list of indicators it should be displayed.

required
Array of objects

Lists second-level breakdowns of this data indicator.

Note: although data indicator breakdowns can theoretically continue infinitely, a max of two levels is returned by this function.

Array
id
required
integer

Child data indicator ID.

name
required
integer

Child data indicator name.

required
object

Lists all possible profile groupings by date type.

FY
required
Array of integers

Lists all possible profile groupings for full year reports.

HY
required
Array of integers

Lists all possible profile groupings for half year reports.

Q
required
Array of integers

Lists all possible profile groupings for quarterly reports.

M
required
Array of integers

Lists all possible profile groupings for monthly reports.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get ranked tourism reports

Authorizations:
OAuth2
query Parameters
datefrequency
required
string
Enum: "FY" "HY" "Q" "M"

Defines the date period of traffic data used. If set to any value but 'FY', then the 'dateperiod' parameter is enabled.

Value Included Profiles
FY Groups by airline profiles
HY Groups by airline group profiles
Q Groups by airline group profiles, and airline profiles not part of an airline group
M Groups by country airline is based in
dateyear
required
string

This indicates which year the data is pulled from. If the 'datefrequency' parameter is set to 'FY' then this can also be set to 'latest' to show the latest year of full data.

If the year's data is incomplete it shows 'Year-to-Date' calculated from monthly data.

dateperiod
required
integer

If the 'datefrequency' parameter is not set to 'FY' then this defines which year half/quarter/month the data is pulled from.

Responses

Response Schema: application/json
required
Array of objects (RankingReportResults)
Array
id
required
integer

Profile ID.

name
required
string

Profile Name.

iata
required
string

Profile IATA code.

icao
required
string

Profile ICAO code.

yearend
required
string

Month the profile's end-of-financial-year lies in.

required
object

Date the rank applies to.

year
required
integer

Year.

period
required
integer

Integer value of date period.

name
required
string

Name value of date period.

required
object
id
required
integer

Airline business model ID.

name
required
string

Airline business model name.

required
object
id
required
integer

Profile type ID.

name
required
string

Profile type name.

required
object
id
required
integer

Alliance ID.

name
required
string

Alliance name.

required
object

Data on locations the profile is located in - May be empty if not applicable to the profile type.

required
object
id
required
integer

City ID.

name
required
string

City name.

required
object
id
required
integer

Country ID.

name
required
string

Country name.

required
object
id
required
integer

Region ID.

name
required
string

Region name.

required
object
id
required
integer

Metaregion ID.

name
required
string

Metaregion name.

url
required
string

URL of profile CAPA page.

required
Array of objects

list of values. Note: the object key corresponds to the data indicator ID.

Array
id
required
integer

Data indicator ID.

name
required
string

Data indicator name.

value
required
integer

Data value.

ispercent
required
boolean

If true, then the value is a percentage.

range
required
string

Name of date period data applies to.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a list of possible profile groupings and data indicators by tourism report date frequency type.

Responses

Response Schema: application/json
required
object (RankingReportOptions)

A list of possible data indicators and profile groupings for the report type.

required
object

Lists all possible data indicators by date type.

required
Array of objects (RankingDataIndicator) [ items ]

Lists all possible data indicators for full year reports.

Note: the key corresponds to the profile type ID, e.g. the indicators in the '1' array apply to airline profiles.

Array
Array
id
required
integer

Data indicator ID.

name
required
integer

Data indicator name.

fieldorder
required
integer

Indicates where in the list of indicators it should be displayed.

required
Array of objects

Lists second-level breakdowns of this data indicator.

Note: although data indicator breakdowns can theoretically continue infinitely, a max of two levels is returned by this function.

Array
id
required
integer

Child data indicator ID.

name
required
integer

Child data indicator name.

required
Array of objects (RankingDataIndicator) [ items ]

Lists all possible data indicators for half year reports.

Note: the key corresponds to the profile type ID, e.g. the indicators in the '1' array apply to airline profiles.

Array
Array
id
required
integer

Data indicator ID.

name
required
integer

Data indicator name.

fieldorder
required
integer

Indicates where in the list of indicators it should be displayed.

required
Array of objects

Lists second-level breakdowns of this data indicator.

Note: although data indicator breakdowns can theoretically continue infinitely, a max of two levels is returned by this function.

Array
id
required
integer

Child data indicator ID.

name
required
integer

Child data indicator name.

required
Array of objects (RankingDataIndicator) [ items ]

Lists all possible data indicators for quarterly reports.

Note: the key corresponds to the profile type ID, e.g. the indicators in the '1' array apply to airline profiles.

Array
Array
id
required
integer

Data indicator ID.

name
required
integer

Data indicator name.

fieldorder
required
integer

Indicates where in the list of indicators it should be displayed.

required
Array of objects

Lists second-level breakdowns of this data indicator.

Note: although data indicator breakdowns can theoretically continue infinitely, a max of two levels is returned by this function.

Array
id
required
integer

Child data indicator ID.

name
required
integer

Child data indicator name.

required
Array of objects (RankingDataIndicator) [ items ]

Lists all possible data indicators for monthly reports.

Note: the key corresponds to the profile type ID, e.g. the indicators in the '1' array apply to airline profiles.

Array
Array
id
required
integer

Data indicator ID.

name
required
integer

Data indicator name.

fieldorder
required
integer

Indicates where in the list of indicators it should be displayed.

required
Array of objects

Lists second-level breakdowns of this data indicator.

Note: although data indicator breakdowns can theoretically continue infinitely, a max of two levels is returned by this function.

Array
id
required
integer

Child data indicator ID.

name
required
integer

Child data indicator name.

required
object

Lists all possible profile groupings by date type.

FY
required
Array of integers

Lists all possible profile groupings for full year reports.

HY
required
Array of integers

Lists all possible profile groupings for half year reports.

Q
required
Array of integers

Lists all possible profile groupings for quarterly reports.

M
required
Array of integers

Lists all possible profile groupings for monthly reports.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Traffic

Get traffic fields

Given a profile ID, type and range type, this returns available traffic fields.

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

rangeType
required
string
Enum: "annual" "quarterly" "monthly" "half"

Traffic data range type.

Responses

Response Schema: application/json
required
Array of objects (ReportField)
Array
id
required
integer

Report field ID.

name
required
string

Report field name.

years
required
Array of integers

An array of years that have data for this report field.

children
Array of objects (ReportField)

If there are any child fields, they will be listed here.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get IATA premium traffic fields

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects (ReportField)
Array
id
required
integer

Report field ID.

name
required
string

Report field name.

years
required
Array of integers

An array of years that have data for this report field.

children
Array of objects (ReportField)

If there are any child fields, they will be listed here.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get tourism fields

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

rangeType
required
string
Enum: "annual" "quarterly" "monthly" "half"

Traffic data range type.

Responses

Response Schema: application/json
required
Array of objects (ReportField)
Array
id
required
integer

Report field ID.

name
required
string

Report field name.

years
required
Array of integers

An array of years that have data for this report field.

children
Array of objects (ReportField)

If there are any child fields, they will be listed here.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get BITRE domestic report fields

Get the report fields for domestic data from the Australian Bureau of Infrastructure, Transport and Regional Economics (BITRE)

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Report field ID.

name
required
string

Report field name.

Array of objects

If there are any child fields, they will be listed here.

Array
id
integer

Report field ID.

name
string

Report field name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get BITRE international report top fields

Get the top level report fields for international data from the Australian Bureau of Infrastructure, Transport and Regional Economics (BITRE).

Note: due to the total number of fields, the memory and loading times required separating the data to separate functions.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Report field ID.

name
required
string

Report field name.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get BITRE international report airline sub-fields

Get the 2nd level (airline) children of a selected report field for international data from the Australian Bureau of Infrastructure, Transport and Regional Economics (BITRE).

Note: due to the total number of fields, the memory and loading times required separating the data to separate functions.

Authorizations:
OAuth2
path Parameters
field
required
integer

Top level report filed ID from '/data/bitre/international/fields' function.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Report field ID (country).

name
required
string

Report field name (country).

brokenBy
string

Name of the break-down that the current field is part of.

Array of objects

3rd level child fields - airlines (not CAPA profile IDs).

Array
id
integer

Report field ID (airline).

name
string

Report field name (airline).

brokenBy
string

Name of the break-down that the current field is part of.

Array of objects

4th level child fields - flight direction.

Array
id
integer

Report field ID (direction).

name
string

Report field name (direction).

brokenBy
string

Name of the break-down that the current field is part of.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get BITRE international report route sub-fields

Get the 2nd level (route) children of a selected report field for international data from the Australian Bureau of Infrastructure, Transport and Regional Economics (BITRE).

Note: due to the total number of fields, the memory and loading times required separating the data to separate functions.

Authorizations:
OAuth2
path Parameters
field
required
integer

Top level report filed ID from '/data/bitre/international/fields' function.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Report field ID (city/country).

name
required
string

Report field name (city/country).

brokenBy
string

Name of the break-down that the current field is part of.

Array of objects

3rd level child fields - airports (not CAPA profile IDs).

Array
id
integer

Report field ID (airport).

name
string

Report field name (airport).

brokenBy
string

Name of the break-down that the current field is part of.

Array of objects

4th level child fields - flight direction.

Array
id
integer

Report field ID (direction).

name
string

Report field name (direction).

brokenBy
string

Name of the break-down that the current field is part of.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get all BITRE international report sub-fields

Get all 2nd level children of a selected report field for international data from the Australian Bureau of Infrastructure, Transport and Regional Economics (BITRE).

Note: Unlike the '/data/bitre/international/fields/airline/{field}' and '/data/bitre/international/fields/routes/{field}' functions, which only provide a list of sub-fields based on a specific grouping, this provides a list of all possible sub-fields including the content of both previous functions.

Note: due to the total number of fields, the memory and loading times required separating the data to separate functions.

Authorizations:
OAuth2
path Parameters
field
required
integer

Top level report filed ID from '/data/bitre/international/fields' function.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Report field ID.

name
required
string

Report field name.

brokenBy
string

Name of the break-down that the current field is part of.

Array of objects

3rd level child fields.

Array
id
integer

Report field ID.

name
string

Report field name.

brokenBy
string

Name of the break-down that the current field is part of.

Array of objects

4th level child fields.

Array
id
integer

Report field ID.

name
string

Report field name.

brokenBy
string

Name of the break-down that the current field is part of.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List recently updated BITRE report IDs

Returns a list of report IDs and profiles for domestic data from the Australian Bureau of Infrastructure, Transport and Regional Economics (BITRE) that have a new/updated report and the date it was updated.

Authorizations:
OAuth2
query Parameters
since
integer
Default: 1

Most recent number of days to search for.

Responses

Response Schema: application/json
required
object (ReportUpdated)
id
required
integer

Report ID.

updated
required
integer

UNIX timestamp of when the aircraft was updated.

required
object

The type and ID of the profile the report belongs to.

id
required
integer

Profile ID.

type
required
integer

Profile type ID.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get all On-time Performance fields

Get all fields and break-downs for Australia On-time Performance reports from Australia reports.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Report field ID.

name
required
string

Report field name.

Array of objects

2nd level child fields.

Array
id
integer

Report field ID.

name
string

Report field name.

brokenBy
string

Name of the break-down that the current field is part of.

Array of objects

3rd level child fields.

Array
id
integer

Report field ID.

name
string

Report field name.

brokenBy
string

Name of the break-down that the current field is part of.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get traffic data for a field

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

rangeType
required
string
Enum: "annual" "quarterly" "monthly" "half"

Traffic data range type.

field
required
integer

Field ID.

query Parameters
from
integer
Example: from=2012

Start of year range to pull traffic data from.

to
integer
Example: to=2016

End of year range to pull traffic data from.

Responses

Response Schema: application/json
required
object (TrafficData)
id
required
integer

Field ID.

name
required
string

Field name.

isPercent
required
boolean

True if the data returned is a percentage instead of a normal number.

showGrowth
required
boolean

Whether or not to show the growth values in resulting charts based on this data.

required
Array of objects

Traffic values.

Array
year
required
integer

Traffic data year.

required
Array of objects

Traffic data periods.

Array
period
required
integer

Period number. If this is a monthly field, this will be the month of the year. If it is quarterly, it will be the year quarter.

note
required
string

If there's any notes attached to this record, they'll be here in plaintext.

grouping
required
string

If there's an extra string grouping on this field, it will be here.

value
required
number

The period's value.

children
Array of objects (TrafficData)

If there are child fields with data, they will be contained here.

required
object
source
required
string

The traffic data source.

note
Array of strings

A list of notes/comments that applies to the traffic data.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List recently updated traffic report IDs

Returns a list of traffic report IDs and profiles that have a new/updated report and the date it was updated.

Authorizations:
OAuth2
query Parameters
since
integer
Default: 1

Most recent number of days to search for.

Responses

Response Schema: application/json
required
object (ReportUpdated)
id
required
integer

Report ID.

updated
required
integer

UNIX timestamp of when the aircraft was updated.

required
object

The type and ID of the profile the report belongs to.

id
required
integer

Profile ID.

type
required
integer

Profile type ID.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get IATA premium traffic data for a field

This returns IATA premium traffic data. Note that IATA stopped reporting this data in 2015.

Authorizations:
OAuth2
path Parameters
field
integer

Field ID requested. If this is omitted, all fields are returned.

query Parameters
from
integer
Example: from=2012

Start of year range to pull traffic data from.

to
integer
Example: to=2016

End of year range to pull traffic data from.

Responses

Response Schema: application/json
required
object (TrafficData)
id
required
integer

Field ID.

name
required
string

Field name.

isPercent
required
boolean

True if the data returned is a percentage instead of a normal number.

showGrowth
required
boolean

Whether or not to show the growth values in resulting charts based on this data.

required
Array of objects

Traffic values.

Array
year
required
integer

Traffic data year.

required
Array of objects

Traffic data periods.

Array
period
required
integer

Period number. If this is a monthly field, this will be the month of the year. If it is quarterly, it will be the year quarter.

note
required
string

If there's any notes attached to this record, they'll be here in plaintext.

grouping
required
string

If there's an extra string grouping on this field, it will be here.

value
required
number

The period's value.

children
Array of objects (TrafficData)

If there are child fields with data, they will be contained here.

object
source
required
string

The traffic data source.

note
Array of strings

A list of notes/comments that applies to the traffic data.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get domestic BITRE data

Get domestic Australian Bureau of Infrastructure, Transport and Regional Economics (BITRE) report data for a given field.

Authorizations:
OAuth2
path Parameters
field
required
integer

A field ID, if you're only interested in a single field.

Responses

Response Schema: application/json
required
object (ReportResult)
id
required
integer

Field ID.

name
required
string

Field name.

isPercent
required
string

If the values for this field should be treated as a percentage, this will be true.

showGrowth
required
string

If true, then graphs on the CAPA site should display growth year-on-year for this value.

required
Array of objects

An array of values for this field.

Array
year
required
string

The year this applies to.

required
Array of objects

Periods in the year.

Array
period
required
integer

Period number. This will always be a zero if we're looking at annual figures, otherwise it's a 1-based index.

note
required
string

If there's any notes about this value, they'll be here.

grouping
required
string

If there's another grouping for this value, it will be here.

value
required
number

The value of the field.

children
required
Array of objects (ReportResult)

If this field has child fields, then they'll be listed here.

children
Array of objects (ReportResult)

If this field has child fields, then they'll be listed here.

unit
string

If set, this indicates the unit of the values (e.g. tonnes, kg, e.t.c.).

object
source
required
string

The BITRE data source.

note
Array of strings

A list of notes/comments that applies to the traffic data.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get international BITRE data

Get international Australian Bureau of Infrastructure, Transport and Regional Economics (BITRE) report data for a given field.

Authorizations:
OAuth2
path Parameters
field
required
integer

A field ID, if you're only interested in a single field.

Responses

Response Schema: application/json
required
object (ReportResult)
id
required
integer

Field ID.

name
required
string

Field name.

isPercent
required
string

If the values for this field should be treated as a percentage, this will be true.

showGrowth
required
string

If true, then graphs on the CAPA site should display growth year-on-year for this value.

required
Array of objects

An array of values for this field.

Array
year
required
string

The year this applies to.

required
Array of objects

Periods in the year.

Array
period
required
integer

Period number. This will always be a zero if we're looking at annual figures, otherwise it's a 1-based index.

note
required
string

If there's any notes about this value, they'll be here.

grouping
required
string

If there's another grouping for this value, it will be here.

value
required
number

The value of the field.

children
required
Array of objects (ReportResult)

If this field has child fields, then they'll be listed here.

children
Array of objects (ReportResult)

If this field has child fields, then they'll be listed here.

unit
string

If set, this indicates the unit of the values (e.g. tonnes, kg, e.t.c.).

object
source
required
string

The BITRE data source.

note
Array of strings

A list of notes/comments that applies to the traffic data.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get On-time Performance data

Get Australian On-time Performance report data for a given field.

Authorizations:
OAuth2
path Parameters
field
required
integer

A field ID, if you're only interested in a single field.

Responses

Response Schema: application/json
required
object (ReportResult)
id
required
integer

Field ID.

name
required
string

Field name.

isPercent
required
string

If the values for this field should be treated as a percentage, this will be true.

showGrowth
required
string

If true, then graphs on the CAPA site should display growth year-on-year for this value.

required
Array of objects

An array of values for this field.

Array
year
required
string

The year this applies to.

required
Array of objects

Periods in the year.

Array
period
required
integer

Period number. This will always be a zero if we're looking at annual figures, otherwise it's a 1-based index.

note
required
string

If there's any notes about this value, they'll be here.

grouping
required
string

If there's another grouping for this value, it will be here.

value
required
number

The value of the field.

children
required
Array of objects (ReportResult)

If this field has child fields, then they'll be listed here.

children
Array of objects (ReportResult)

If this field has child fields, then they'll be listed here.

unit
string

If set, this indicates the unit of the values (e.g. tonnes, kg, e.t.c.).

object
source
required
string

The On-time Performance data source.

note
Array of strings

A list of notes/comments that applies to the traffic data.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List recently updated on-time performace report IDs

Returns a list of on-time performace report IDs and profiles that have a new/updated report and the date it was updated.

Authorizations:
OAuth2
query Parameters
since
integer
Default: 1

Most recent number of days to search for.

Responses

Response Schema: application/json
required
object (ReportUpdated)
id
required
integer

Report ID.

updated
required
integer

UNIX timestamp of when the aircraft was updated.

required
object

The type and ID of the profile the report belongs to.

id
required
integer

Profile ID.

type
required
integer

Profile type ID.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Search for companies with traffic data

Authorizations:
OAuth2
query Parameters
search
string

Company name to search for. A substring search will be performed. Either this or the code parameter must be sent.

code
string

IATA/ICAO code of the company to search for. Overrides anything in the search parameter.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

required
object

Profile type.

id
required
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (null if unavailable).

icao
string

Profile ICAO code (null if unavailable).

url
required
string

Profile URL.

frequencies
required
Array of strings
Items Enum: "M" "Q" "FY"

The types (aka frequencies) of traffic data available.

object

If available, the country for the profile.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Tourism

Get specific tourism data for a profile

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

range
required
string
Enum: "annual" "quarterly" "monthly" "half"

Tourism result reporting range type.

field
required
integer

Field ID.

Responses

Response Schema: application/json
required
object (TourismResult)
id
required
integer

Field ID.

name
required
string

Field name.

isPercent
required
string

If the values for this field should be treated as a percentage, this will be true.

showGrowth
required
string

If true, then graphs on the CAPA site should display growth year-on-year for this value.

required
Array of objects

An array of values for this field.

Array
year
required
string

The year this applies to.

required
Array of objects

Periods in the year.

Array
period
required
integer

Period number. This will always be a zero if we're looking at annual figures, otherwise it's a 1-based index.

note
required
string

If there's any notes about this value, they'll be here.

grouping
required
string

If there's another grouping for this value, it will be here.

value
required
number

The value of the field.

children
required
Array of objects (TourismResult)

If this field has child fields, then they'll be listed here.

object
source
required
string

The tourism data source.

note
Array of strings

A list of notes/comments that applies to the traffic data.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List recently updated tourism report IDs

Returns a list of tourism report IDs and profiles that have a new/updated report and the date it was updated.

Authorizations:
OAuth2
query Parameters
since
integer
Default: 1

Most recent number of days to search for.

Responses

Response Schema: application/json
required
object (ReportUpdated)
id
required
integer

Report ID.

updated
required
integer

UNIX timestamp of when the aircraft was updated.

required
object

The type and ID of the profile the report belongs to.

id
required
integer

Profile ID.

type
required
integer

Profile type ID.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Sustainability

Get specific sustainability data for a company

Authorizations:
OAuth2
path Parameters
type
required
integer

Profile type ID.

id
required
integer

Profile ID.

field
integer

A field ID, if you're only interested in a single field.

query Parameters
from
integer

Year to get sustainability from.

to
integer

Year to get sustainability data to.

Responses

Response Schema: application/json
required
object (FinancialResult)
id
required
integer

Field ID.

name
required
string

Field name.

isPercent
required
string

If the values for this field should be treated as a percentage, this will be true.

showGrowth
required
string

If true, then graphs on the CAPA site should display growth year-on-year for this value.

required
Array of objects

An array of values for this field.

Array
year
required
string

The year this applies to. Note that this is the financial year, so it depends on the company's locale as to if it's a normal whole year, or if it's a split year, like 2016/17.

required
Array of objects

Periods in the year.

Array
period
required
integer

Period number .This will always be a zero if we're looking at annual figures, otherwise it's a 1-based index.

note
required
string

If there's any notes about this value, they'll be here.

grouping
required
string

If there's another grouping for this value, it will be here.

local
required
number

The value, as expressed in the company's local currency.

usd
number

The value, converted to USD (average USD conversion rate for the period that the value applied to is used). If we have no conversion rate, or the value is already USD then this won't be included.

children
required
Array of objects (FinancialResult)

If this field has child fields, then they'll be listed here.

object
source
required
string

The sustainability data source.

note
Array of strings

A list of notes/comments that applies to the sustainability data.

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List recently updated sustainability report IDs

Returns a list of sustainability report IDs and profiles that have a new/updated report and the date it was updated.

Authorizations:
OAuth2
query Parameters
since
integer
Default: 1

Most recent number of days to search for.

Responses

Response Schema: application/json
required
object (ReportUpdated)
id
required
integer

Report ID.

updated
required
integer

UNIX timestamp of when the aircraft was updated.

required
object

The type and ID of the profile the report belongs to.

id
required
integer

Profile ID.

type
required
integer

Profile type ID.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Search for companies with sustainability data

Authorizations:
OAuth2
query Parameters
search
string

Company name to search for. A substring search will be performed. Either this or the code parameter must be sent.

code
string

IATA/ICAO code of the company to search for. Overrides anything in the search parameter.

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

required
object

Profile type.

id
required
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (null if unavailable).

icao
string

Profile ICAO code (null if unavailable).

url
required
string

Profile URL.

frequencies
required
Array of strings
Items Enum: "M" "Q" "FY"

The types (aka frequencies) of traffic data available.

object

If available, the country for the profile.

id
required
integer

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Financial

List recently updated financial report IDs

Returns a list of financial report IDs and profiles that have a new/updated report and the date it was updated.

Authorizations:
OAuth2
query Parameters
since
integer
Default: 1

Most recent number of days to search for.

Responses

Response Schema: application/json
required
object (ReportUpdated)
id
required
integer

Report ID.

updated
required
integer

UNIX timestamp of when the aircraft was updated.

required
object

The type and ID of the profile the report belongs to.

id
required
integer

Profile ID.

type
required
integer

Profile type ID.

Response samples

Content type
application/json
{
  • "data": {
    }
}

Share Prices

Search for companies with share prices

query Parameters
code
string
Example: code=QF

If this exists, then results will be searched for by IATA/ICAO/country code.

search
string
Example: search=qan

Any results that start with this string will be returned.

Responses

Response Schema: application/json
required
Array of objects (ProfileSearchResult)
Array
rank
integer

Profile type display order (starting from 1).

id
required
integer

Profile ID.

required
object

Profile type.

id
integer

Profile type ID.

name
required
string

Profile type name.

name
required
string

Profile name.

iata
string

Profile IATA code (if available).

icao
string

Profile ICAO code (if available).

url
string

Profile URL. This is only added for the appropriate profile types (Cities, for instance, do not have a profile page)

object

If the profile has a country linked to it, country details are here.

id
required
string

Country ID.

name
required
string

Country name.

code
required
string

2-letter country code.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get share prices

Authorizations:
OAuth2
path Parameters
id
required
integer

Share price ID. Will be the stockid value returned from profile info, or share searches.

query Parameters
range
integer

How many months of shares data to return.

Responses

Response Schema: application/json
required
Array of objects
Array
date
required
integer

UNIX timestamp of the date the share price applies to.

price
required
number

Share price.

usd
required
number

Share price, converted to USD.

usdtype
required
number
Enum: "daily" "monthly"

The date range used when calculating currency conversion to USD - this is only used if the share is not saved in USD.

daily means that the USD was calculated from the conversion for the given date, monthly means that there was no currency conversion for that date and it was calculated as an average for the month.

required
object
name
required
string

Company name.

currency
required
string

3-letter currency code of the share prices.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Shop

List all shop items

Use this resource to pull down a list of items available for purchase/subscription. The list returned will be alphabetically ordered by product name.

query Parameters
num
integer

Number of results to return.

page
integer

Zero-based index of the result page number.

Responses

Response Schema: application/json
required
Array of objects (ShopItem)
Array
id
required
integer

The shop item ID.

name
required
string

The item's name.

shortdesc
required
string <= 255 characters

A short, one sentence text description of the shop item.

description
required
string

A longer, more in-depth HTML description of the shop item.

price
required
number

The price (or setup fee) of the shop item. For single-purchase items like reports or event passes, this will be the price of the item. For subscriptions, this will be treated as a one-off setup fee for the subscription and added to the subscription pricing.

required
object

The currency of the product. This will almost always be USD.

id
required
integer

Currency ID.

symbol
required
string <= 3 characters

Three-letter currency symbol.

mailout
required
boolean

Boolean indicating whether or not this product contains a mailing list component.

type
required
integer

Product type. This is currently used for a simple differentiation between reports and all other types of product.

  • 0 will indicate that the product is not a report.
  • 1 indicates the product is a report.

There is the potential for other values to be added in the future, if more complex shop product types are introduced.

filename
required
string

This is a legacy field indicating the filename for a product if it is downloadable. This will be blank and you should rely on the files array instead.

required
Array of objects >= 0 items
Array (>= 0 items)
id
required
integer

The product's subscription ID.

period
required
integer

The length of time (in months) that the subscription is valid for.

price
required
number

The price for the subscription period.

files
required
Array of strings >= 0 items

An array of files that are provided by the product.

image
string

If an image for this product is available, then this is its URL. Check here for info on resizing images.

If there is no image available, this will be a null value.

convertedprice
number

If the product currency is not in USD, this lists the price in USD.

url
required
string

The URL for the information/purchase page for this product.

requires
object (ShopItem) Recursive

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a shop item

Returns a single shop item based on the ID provided.

path Parameters
itemid
required
integer
Example: 39

Shop item ID.

This is a bit of a weird situation. You can either use the shop item ID, or the shortname value for the shop item. Both will return the same result. Note that this only applies to this resource and not file downloads.

Responses

Response Schema: application/json
required
object (ShopItem)
id
required
integer

The shop item ID.

name
required
string

The item's name.

shortdesc
required
string <= 255 characters

A short, one sentence text description of the shop item.

description
required
string

A longer, more in-depth HTML description of the shop item.

price
required
number

The price (or setup fee) of the shop item. For single-purchase items like reports or event passes, this will be the price of the item. For subscriptions, this will be treated as a one-off setup fee for the subscription and added to the subscription pricing.

required
object

The currency of the product. This will almost always be USD.

id
required
integer

Currency ID.

symbol
required
string <= 3 characters

Three-letter currency symbol.

mailout
required
boolean

Boolean indicating whether or not this product contains a mailing list component.

type
required
integer

Product type. This is currently used for a simple differentiation between reports and all other types of product.

  • 0 will indicate that the product is not a report.
  • 1 indicates the product is a report.

There is the potential for other values to be added in the future, if more complex shop product types are introduced.

filename
required
string

This is a legacy field indicating the filename for a product if it is downloadable. This will be blank and you should rely on the files array instead.

required
Array of objects >= 0 items
Array (>= 0 items)
id
required
integer

The product's subscription ID.

period
required
integer

The length of time (in months) that the subscription is valid for.

price
required
number

The price for the subscription period.

files
required
Array of strings >= 0 items

An array of files that are provided by the product.

image
string

If an image for this product is available, then this is its URL. Check here for info on resizing images.

If there is no image available, this will be a null value.

convertedprice
number

If the product currency is not in USD, this lists the price in USD.

url
required
string

The URL for the information/purchase page for this product.

requires
object (ShopItem) Recursive

Response samples

Content type
application/json
{
  • "data": {
    }
}

Calculate total values of items in cart

Given a list of items and a user's country and payment method, this will calculate what the total charged to the user will be.

query Parameters
cart
required
Array of any
Example: cart=39/1/30

The cart parameter should contain a comma separated list of cart items, of which the parameters themselves are separated by slashes. There should always be three parameters.

A cart item looks like this: 39/1/30

  • The first parameter is the ID of the product
  • The second parameter is the quantity required (if it's a subscription product, then this is the number of licences required).
  • If it's a subscription, then this is the subscription ID of the product. If it is not a subscription, this value should be 0.
coupon
string

If the user has a discount code, this will be it.

country
required
integer

This is the user's country ID and it is used to calculate whether tax should be applied to the order or not. A list of country IDs can be pulled down at /site/countries.

method
integer

The payment method selected.

ID Method
1 Credit card
2 Bank transfer
3 Cheque

Responses

Response Schema: application/json
required
Array of objects
Array
name
required
string

The name of the total.

value
required
number

The value of the total.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Make a purchase

Authorizations:
OAuth2
Request Body schema: application/json
required
required
Array of objects

Array of items to purchase.

Array
id
required
integer

Item ID.

quantity
required
integer >= 1

Item quantity.

period
integer

Item subscription ID.

coupon
string

Discount coupon code for the order.

method
required
integer

The payment method. These are:

ID Method
1 Credit card
2 Bank Transfer
3 Cheque
name
required
string

The user's name. This can be the same as the user's name, or a different name. It is used for invoicing.

email
required
string

The user's email address. If this is not the same as the account's email address, then the invoice will be sent to both the account's email address and the email address listed here.

suburb
required
string

The user's suburb, for invoicing purposes.

postcode
string

The user's postcode, for invoicing.

country
required
integer

The user's country ID. Get a list of countries from /site/countries.

ccNumber
integer

The user's credit card number.

ccExpiry
string^\d{2}\/\d{2}$

The user's credit card expiry date. It is in MM/YY format.

ccCVV
integer

The card verification value. This is normally a three-digit number on the back of the user's credit card.

Responses

Response Schema: application/json
required
object
id
required
integer

The order ID.

paid
required
boolean

Whether the order has been paid or not. This will be true if the order was paid by credit card, otherwise it will be false and will remain unpaid until payment has been received.

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "coupon": "string",
  • "method": 0,
  • "name": "string",
  • "email": "string",
  • "suburb": "string",
  • "postcode": "string",
  • "country": 0,
  • "ccNumber": 0,
  • "ccExpiry": "05/17",
  • "ccCVV": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Download a file from an item

If a shop item had files available for download, make a get request to this URL and it will respond with the file contents.

Authorizations:
OAuth2
path Parameters
itemid
required
integer
filename
required
string

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Supplier

Get airport suppliers

This lists all profiles that provides airports with Ground Handling or Fuel & Oil services.

Authorizations:
OAuth2

Responses

Response Schema: application/json
required
Array of objects
Array
id
required
integer

Profile ID.

name
required
string

Profile name.

url
required
string

URL of the profile's CAPA page.

type
required
integer

Profile type ID.

required
object

Profile sector - the service the profile provides.

id
integer

Sector ID.

name
string

Sector name.

required
object

The country the profile is located in.

id
integer

Country profile ID.

name
string

Country profile name.

url
string

URL of the country profile's CAPA page.

Array of objects

Lists the airports this profile services.

Array
id
required
integer

Airport profile ID.

name
required
string

Airport profile name.

iata
required
string

Airport IATA code.

icao
required
string

Airport ICAO code.

url
required
string

URL of the airport profile's CAPA page.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Webinars

List existing/completed webinars

This returns an array of ten (or as requested in the 'num' parameter) completed webinars in chronological order, off-set by the given 'page' parameter.

query Parameters
page
integer

This number lists the group of data (ten at a time) that is required starting from 0.

num
integer

This indicates the number of items in the current page's object (to a max of 10)

Responses

Response Schema: application/json
required
Array of objects (Webinar)
Array
id
required
integer

Webinar ID.

name
required
string

Webinar name.

url
required
string

URL for the webinar page.

date
required
number

Date the Webinar takes place.

info
required
string

String containing a basic description of the webinar.

logo
required
string

URL for the smaller webinar logo image.

splash
required
string

URL for the larger webinar page splash image.

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get a webinar's details

This returns the full details of a webinar (defined by the 'id' parameter) structured as an object.

path Parameters
id
required
integer

This is the ID of the requested Webinar.

Responses

Response Schema: application/json
required
object (Webinar)
id
required
integer

Webinar ID.

name
required
string

Webinar name.

url
required
string

URL for the webinar page.

date
required
number

Date the Webinar takes place.

info
required
string

String containing a basic description of the webinar.

logo
required
string

URL for the smaller webinar logo image.

splash
required
string

URL for the larger webinar page splash image.

Response samples

Content type
application/json
{
  • "data": {
    }
}