πŸ“† Aircraft Availability & Pricing

Please, visit our Swagger for a complete list and description of our endpoints.

🚧

⚠️ Important

Each API token provides access to one specified system instance (one operator). The token can be issued only by consent of the given operator's system administrator.

Aircraft Availability

To determine if a specific aircraft is available on specific dates, there are two methods you can use:

  1. GET /aircraft/{tailNumber}/schedule (Docs)

You can find the available tails following this guide.

This endpoint allows you to check the schedule of a specific aircraft using a date range as a parameter.

We advise invoking this endpoint using a date range that does not exceed one month per request. If your application requires data spanning a longer period, you can make multiple calls to this endpoint, systematically shifting the one-month window over the desired duration.

We strongly recommend that you regulate the frequency of your calls to this endpoint. To maintain optimal performance, the suggested rate limit is one call per minute. If your application requires data from an extended period, adjust your requests accordingly. By scheduling your calls at this rate, you can efficiently cover a larger date range while ensuring smooth operation.

Should your application need more tails, you can simultaneously make calls to this endpoint using different tails. This means that multiple requests can be dispatched concurrently, each with a unique tail, to retrieve a larger amount of data without exceeding the recommended call frequency. However, remember to maintain the advised rate of no more than one call per minute per tail to ensure optimal performance.

If you receive a 200 OK response with an empty body, it means that the aircraft is not scheduled for any flights during the selected dates.

  1. POST api/external/quote/lookup

This endpoint lets you simulate a quote request without creating a quote in the system.

In the response body, you can check for warning events such as:

  • Schedule Overlap
  • Schedule Overlap Task (maintenance, etc)
  • Schedule Overlap POS (positioning flight)

If one of these warnings appears the selected aircraft is already scheduled for a flight, maintenance, or positioning during the selected dates.

"warnings": [
  {
    "type": "SCHEDULE_OVERLAP"
  },
  {
    "type": "SCHEDULE_OVERLAP_TASK"
  },
  {
    "type": "SCHEDULE_OVERLAP_POS"
  }
]

Aircraft Pricing

🚧

Pricing Model

The endpoint /api/external/aircraft/{tailNumber}/pricing provides access to the internal pricing model of the operator. This data is proprietary and sensitive, and as such, it is not available for use by third-party applications.

  1. You can read the pricing of a simulated quote POST api/external/quote/lookup

This endpoint lets you simulate a quote request without creating a quote in the system.

In the response body, you can read the pricing information of a quote

"price":
{
        "charterCost": 0,
        "gross": 167410,
        "net": 167410,
        "vat": 0,
        "fet": 0,
        "tax": 738.22,
        "vatPerc": 0,
        "currency": "USD",
        "exchangeRate": 1
,
  1. You can read the price details of an existing quote GET api/external/quote/price/{quoteReference}

A quoteReference can be the bookingID or the booking externalReference.