Real-time Search API - Crawler Trigger

Overview

Trigger a Flight Search

Submits a flight search to the processing queue. Award availability is retrieved asynchronously.

A task_id may be provided by the client, but it is not required. If omitted, the backend generates a task_id and returns it in the response. Use that identifier to retrieve the search results.

A client-defined task_id is useful when multiple requests need to be grouped into a single search task.

Recommended Sample Code

Real-Time Search API sample code

Query Constraints

• Each request must search exactly one travel date. Date ranges are not supported.

Request Fields

pax

• Type: Integer

• Required: Yes

• Description: Number of passengers included in the search.

programs

• Type: Array of strings

• Required: Yes

• Description: Loyalty-program codes to search.

cabins

• Type: Array of strings

• Required: Yes

• Description: Cabin classes to include.

• Supported values:

  • Economy

  • Premium Economy

  • Business

  • First

origin

• Type: String

• Required: Yes

• Description: Origin airport’s three-letter IATA code, such as SFO.

arrival

• Type: String

• Required: Yes

• Description: Destination airport’s three-letter IATA code, such as JFK.

date

• Type: Object

• Required: Yes

• Description: Travel date to search.

• Constraint: Must represent exactly one date. Date ranges are not supported.

task_id

• Type: String

• Required: No

• Description: Identifier used to track the search and retrieve its results from the backend.

• Usage:

  • Provide your own task_id when you need to group multiple same-date requests, such as requests split across several program batches.

  • Omit task_id when submitting a standalone request. The backend will generate one and return it in the response.

  • Store the returned task_id and use it when calling the result-retrieval endpoint.

  • All requests using the same client-defined task_id must use the same travel date.

When task_id is omitted, each request receives a separate backend-generated identifier. To combine multiple requests into one task, provide and reuse your own task_id.