Route prediction

Endpoints for demand predictions between specific origin-destination pairs.

Get Route Demand Prediction

get
/traveldemand/{product_dimension}/routes/prediction/{time_resolution}/{origin}/{destination}

Retrieves travel demand predictions for a specified route, product dimension, and time resolution.

This endpoint provides predictions for a particular origin-destination pair. It allows filtering of the predictions based on the specified product dimension (e.g., search date or travel date) and the desired time resolution (e.g., weekly, monthly).

Parameters

  • product_dimension: Specifies whether the predictions are for the period when travellers are searching for flights (search_date) or when travellers are boarding the flight (travel_date).

  • time_resolution: Specifies the temporal granularity of the prediction data, such as WEEKLY or MONTHLY.

  • origin: The 3-letter IATA code representing the city of origin.

  • destination: The 3-letter IATA code representing the city of destination.

Returns

  • PredictionResponse: A response object containing the requested route-specific predictions.

Authorizations
x-api-keystringRequired
Path parameters
product_dimensionstring · enumRequired

Defines the target product dimension for history and prediction data points.

Attributes

SEARCH : str Represents the 'search_date' dimension, indicating interest in the period when travelers are searching for their flights.

TRAVEL : str Represents the 'travel_date' dimension, indicating interest in the period when travelers will board their flights.

Possible values:
time_resolutionstring · enumRequired

Defines the granularity of time for predictions or historical data.

Attributes

MONTHLY : str Represents a monthly granularity, providing predictions or historical data aggregated on a monthly basis.

WEEKLY : str Represents a weekly granularity, offering predictions or historical data aggregated on a weekly basis.

Possible values:
originstring · min: 3 · max: 3RequiredPattern: [A-Z]{3}
destinationstring · min: 3 · max: 3RequiredPattern: [A-Z]{3}
Responses
chevron-right
200

Successful Response

application/json
get
/traveldemand/{product_dimension}/routes/prediction/{time_resolution}/{origin}/{destination}

Last updated