Quickstart

From a route and date to structured fare observations.

This walkthrough describes the pre-release contract. Examples are illustrative and do not call a live endpoint.

1. Define your source and search

   Pick an airline, airport pair, departure date, passenger mix, cabin, market and currency. A return trip includes a return date. These fields form the search identity.

2. Agree access and limits

   Your pilot specifies enabled carriers, source weights, maximum concurrency, data-use terms and delivery targets. Production credentials will be issued after activation.

3. Submit a search

   The proposed POST /v1/searches creates an asynchronous job. Retain its ID and reuse an idempotency key if retrying the same submission.

4. Read results and their status

   Poll GET /v1/searches/{id}. A job can complete with partial source results; check each source status and the requested-versus-returned scope before using its observations.

Example request

{
  "carriers": ["FR"],
  "origin": "OPO",
  "destination": "FCO",
  "departure_date": "2027-03-12",
  "return_date": null,
  "passengers": { "adults": 1, "children_ages": [], "infants": 0 },
  "cabin": "economy",
  "market": "PT",
  "currency": "EUR",
  "freshness": "fresh_collection",
  "max_credits": 5
}

The airline in this example illustrates a request shape, not an active integration.

Before you display a fare

Check collection status, observation age, original currency, passenger and journey price basis, taxes and baggage. Keep source links with the observation. If the source exposes only a generic route page, label it accordingly instead of presenting it as a direct offer.

Read the search reference, data quality guide and credit model next.