api-guideOUT

Sample Use Cases

Supported Markets

API Guide

EXAMPLES

Sample Use Cases

Here are some ways in which data from our APIs are used.

Basic

$9.99/month + Usage

Ideal for planning vacations

10,000 calls included

$0.003 /excess call

Email support

Get started

Standard

$19.99/month + Usage

Traveling nomads

25,000 calls included

$0.002 /excess call

Priority email support

Get started

Premium

$59.99/month + Usage

Frequent flyers

80,000 calls included

$0.001 /excess call

Detailed analytics & Reporting

Personalised + Priority service

Get started

Price API

Sample display

Price API Inputs

origin*

MIA (line 32)

destination*

DEN (line 27)

departureDate*

2024-02-10 (line 26)

aggregate

market (line24)

* indicates required input parameter. Some parameters such as "aggregate" have a default setting (in this case market). Additional parameter definitions are included in the documentation page for each specific API.

Price Outputs (used for sample display)

low (today's lowest price)

50.98 (line 8)

minCarrier

F9 (line 12)

In this example, the low price has been rounded up in the display sample to $51. The minCarrier is the airline with the lowest price. F9 is the airline code for Frontier Airlines.

Price API response

1{
2  "items": [
3    {
4      "airline": null,
5      "aggregate": "market",
6      "currency": "USD",
7      "high": 1064.27,
8      "low": 50.98,
9      "median": 311.43132267689685,
10      "searchClass": "E",
11      "updated": "2024-01-10",
12      "minCarrier": "F9",
13      "maxCarrier": "AA",
14      "mostPriceRangeMin": 321.86411764705883,
15      "mostPriceRangeMax": 442.06733333333335
16    }
17  ],
18  "pagination": {
19    "pageSize": 10,
20    "pageNum": 1,
21    "total": 8
22  },
23  "search": {
24    "aggregate": "market",
25    "airline": null,
26    "departureDate": "2024-02-10",
27    "destination": "DEN",
28    "includeSummary": false,
29    "locale": "en-US",
30    "maxStops": null,
31    "minStops": null,
32    "origin": "MIA",
33    "returnedDate": null,
34    "searchClass": [
35      "E"
36    ],
37    "searchId": "202571",
38    "searchDate": "2024-01-11",
39    "modelVersion": -1
40  }
41}

Trend API

Sample display

Trend API Inputs

origin*

JFK (line 79)

destination*

HNL (line 74)

departureDate*

2024-06-01 (line 73)

airline*

HA (line 94)

* indicates required input parameter. Additional parameter definitions are included in the documentation page for each specific API.

Price Outputs (used for sample display)

predictionMin

457.74 (line 14)

outboundDTD

148 (line 11)

In this example, the sample display leverages the predictionMin (lowest predicted price) and outboundDTD (number of days until departure) parameters to display an interactive graph plotting the predicted minimum price for every day until the day of departure so users can see how prices are expected to change over time.

Additionally, the summary block (lines 53 - 62) indicates the booking window to get the lowest price of $433.42 (line 61) is March 12 - March 18, 2024 (lines 56-57).

Price API response (snippet only to show sample)

1{
2  "items": [
3    {
4      "airline": "HA",
5      "aggregate": "airline",
6      "currency": "USD",
7      "searchClass": "E",
8      "updatedAt": "2024-01-05",
9      "data": [
10        {
11          "outboundDTD": 148,
12          "predictionAvg": 598.3224999999999,
13          "predictionMax": 807.7,
14          "predictionMin": 457.7440000000001
15        },
16        {
17          "outboundDTD": 147,
18          "predictionAvg": 598.902174634754,
19          "predictionMax": 809.9658153101461,
20          "predictionMin": 458.0590590427434
21        },
22        {
23          "outboundDTD": 146,
24          "predictionAvg": 599.5190984401654,
25          "predictionMax": 812.3314217033068,
26          "predictionMin": 458.44620100976465
27        },
28        {
29          "outboundDTD": 145,
30          "predictionAvg": 600.1439260001556,
31          "predictionMax": 814.6969947317103,
32          "predictionMin": 458.88687528509
33        },
34        {
35          "outboundDTD": 144,
36          "predictionAvg": 600.7468690372491,
37          "predictionMax": 816.9561745606729,
38          "predictionMin": 459.36061676871736
39        },
40        {
41          "outboundDTD": 143,
42          "predictionAvg": 601.2999190760089,
43          "predictionMax": 819.0026221094327,
44          "predictionMin": 459.846313397965
45        },
46        {
47          "outboundDTD": 142,
48          "predictionAvg": 601.7790765283768,
49          "predictionMax": 820.7371886297009,
50          "predictionMin": 460.32353515443975
51        },
52      ],
53      "summary": [
54        {
55          "bookingRange": {
56            "minDate": "2024-03-12",
57            "maxDate": "2024-03-18"
58          },
59          "bookingDate": "2024-03-15",
60          "confidence": 98,
61          "lowestTrendPrice": 433.4210479690491,
62          "trend": "desc"
63        }
64      ]
65    }
66  ],
67  "pagination": null,
68  "search": {
69    "aggregate": "airline",
70    "airline": [
71      "HA"
72    ],
73    "departureDate": "2024-06-01",
74    "destination": "HNL",
75    "includeSummary": false,
76    "locale": "en-US",
77    "maxStops": null,
78    "minStops": null,
79    "origin": "JFK",
80    "returnedDate": null,
81    "searchClass": [
82      "E"
83    ],
84    "searchId": "202496",
85    "searchDate": "2024-01-11",
86    "modelVersion": 4
87  }
88}

SUPPORTED MARKETS

Common Paramters & Supported Markets

Common Parameters

Here are definitions for some of the more common API parameters. A full list of parameters can be found for each API within its dedicated API page. You can click on each card for an expanded view.

Basic

$9.99/month + Usage

Ideal for planning vacations

10,000 calls included

$0.003 /excess call

Email support

Get started

Standard

$19.99/month + Usage

Traveling nomads

25,000 calls included

$0.002 /excess call

Priority email support

Get started

Premium

$59.99/month + Usage

Frequent flyers

80,000 calls included

$0.001 /excess call

Detailed analytics & Reporting

Personalised + Priority service

Get started

Source from which you can get any origin, destination and airline codes. https://www.iata.org/en/publications/directories/code-search/

Not all codes are supported in FareX. For a list of currently supported markets, see below.

Supported Market Data Combinations

Number of current markets = 1,556 | Number of airlines = 76

This interactive table shows the market data combinations currently supported by FareX. New data is added regularly. To see a collapsed view, right-click on the origin field and select collapse all. Then, you can drill into any origin to see the supported destinations, airlines supported and the search_class (e.g. cabin of service where E = Economy, P = Premium Economy, B = Business and F = First).

Notes:

Supported airlines includes major US carriers (excluding WN).
Supported airlines may not appear if there is insufficient data for the specific market, date or cabin of service searched.
Optimal results are often obtained when searching for one-way or roundtrip for 3, 5, or 7 days; other durations may yield fewer results.
API results may come back without data if the date for which the search is executed does not yet have supporting data.

TRY IT OUT

API Access Guide

Step-by-step instructions to help you navigate trying out our APIs. Step-by-step instructions with screen shot samples can be found in the PDF guide.

Step 1. Sign-in to the Developer Portal (or sign-up)

Sign-into your FareX Developer Portal account
If you do not have an account, you can follow the in application steps to sign-up for a free trial account here https://developer.farex.ai/

Step 2. Subscribe to the API you wish to test

Note: Some users are automatically subscribed to all APIs for a trial period. If already subscribed, skip ahead to step 3.
‍

From the API page, select the View button
On the detail page, select the Subscribe button

Step 3. Try it out

Select Settings from the left hand menu and select Keys tab
Select +Create a key and copy the key (the same key can be used to test any APIs to which you are subscribed)
Return to the API page you want to test and select the Authorize button
Enter your key in the box and select Authorize. Close the box using the x in the upper right corner
Select the arrow in the GET line you wish to test to open the section and select the Try it out button
Enter data for the required fields and select Execute
When done testing, select the Authorize button again and logout