Skip to main content
POST
/
flights
/
offers
Search flight offers
curl --request POST \
  --url https://api.staging.rovemiles.com/functions/v1/flights/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "origin": "JFK",
  "destination": "LHR",
  "departureDate": "2023-10-15",
  "adults": 2,
  "returnDate": "2023-10-25",
  "children": 1,
  "infants": 0,
  "cabinClass": "BUSINESS",
  "bookingType": "direct",
  "sort": "duration",
  "limit": 10
}
'
{
  "data": [
    {
      "id": "offer123",
      "bookingType": "direct",
      "price": {
        "miles": 75000,
        "taxes": {
          "amount": "129.40",
          "currency": "USD"
        },
        "milesPerPassenger": {
          "adult": 37500,
          "child": 37500,
          "infant": 0
        }
      },
      "passengers": {
        "adults": 2,
        "children": 1,
        "infants": 0
      },
      "cabinClass": "BUSINESS",
      "itineraries": [
        {
          "segments": [
            {
              "departureAirport": "JFK",
              "arrivalAirport": "LHR",
              "departureTime": "2023-10-15T18:30:00",
              "arrivalTime": "2023-10-16T06:45:00",
              "flightNumber": "BA178",
              "airline": {
                "code": "BA",
                "name": "British Airways"
              },
              "duration": "PT7H15M"
            }
          ],
          "duration": "PT7H15M"
        },
        {
          "segments": [
            {
              "departureAirport": "LHR",
              "arrivalAirport": "JFK",
              "departureTime": "2023-10-25T10:20:00",
              "arrivalTime": "2023-10-25T13:25:00",
              "flightNumber": "BA175",
              "airline": {
                "code": "BA",
                "name": "British Airways"
              },
              "duration": "PT7H05M"
            }
          ],
          "duration": "PT7H05M"
        }
      ],
      "availability": "LIMITED"
    },
    {
      "id": "offer456",
      "bookingType": "transfer",
      "price": {
        "miles": 65000,
        "taxes": null,
        "milesPerPassenger": {
          "adult": 32500,
          "child": 32500,
          "infant": 0
        }
      },
      "passengers": {
        "adults": 2,
        "children": 1,
        "infants": 0
      },
      "cabinClass": "BUSINESS",
      "itineraries": [
        {
          "segments": [
            {
              "departureAirport": "JFK",
              "arrivalAirport": "LHR",
              "departureTime": "2023-10-15T18:30:00",
              "arrivalTime": "2023-10-16T06:45:00",
              "flightNumber": "BA178",
              "airline": {
                "code": "BA",
                "name": "British Airways"
              },
              "duration": "PT7H15M"
            }
          ],
          "duration": "PT7H15M"
        },
        {
          "segments": [
            {
              "departureAirport": "LHR",
              "arrivalAirport": "JFK",
              "departureTime": "2023-10-25T10:20:00",
              "arrivalTime": "2023-10-25T13:25:00",
              "flightNumber": "BA175",
              "airline": {
                "code": "BA",
                "name": "British Airways"
              },
              "duration": "PT7H05M"
            }
          ],
          "duration": "PT7H05M"
        }
      ],
      "availability": "AVAILABLE"
    }
  ],
  "meta": {
    "count": 2,
    "totalCount": 42,
    "sort": "duration",
    "links": {
      "self": "https://api.rovemiles.com/v1/flights/offers?origin=JFK&destination=LHR&departureDate=2023-10-15&returnDate=2023-10-25&adults=2&children=1&sort=duration",
      "next": "https://api.rovemiles.com/v1/flights/offers?origin=JFK&destination=LHR&departureDate=2023-10-15&returnDate=2023-10-25&adults=2&children=1&sort=duration&page=2"
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Add your API key to the Authorization header with this format: 'Bearer your_api_key_here'

Body

application/json
​
origin
string
required

Origin airport IATA code

Pattern: ^[A-Z]{3}$
Example:

"JFK"

​
destination
string
required

Destination airport IATA code

Pattern: ^[A-Z]{3}$
Example:

"LHR"

​
departureDate
string<date>
required

Departure date (YYYY-MM-DD)

Example:

"2023-10-15"

​
adults
integer
default:1
required

Number of adult passengers (age 12+)

Required range: 1 <= x <= 9
Example:

2

​
returnDate
string<date>

Return date (YYYY-MM-DD) - omit for one-way flights

Example:

"2023-10-25"

​
children
integer
default:0

Number of child passengers (age 2-11)

Required range: 0 <= x <= 8
Example:

1

​
infants
integer
default:0

Number of infant passengers (under 2 years)

Required range: 0 <= x <= 4
Example:

0

​
cabinClass
enum<string>
default:ECONOMY

Preferred cabin class

Available options:
ECONOMY,
PREMIUM_ECONOMY,
BUSINESS,
FIRST
Example:

"BUSINESS"

​
bookingType
enum<string>
default:direct

Type of booking to search for

Available options:
direct,
transfer
Example:

"direct"

​
sort
enum<string>
default:price

Sort order for results

Available options:
price,
duration,
best,
departure_time,
arrival_time
Example:

"duration"

​
limit
integer
default:20

Maximum number of results to return

Required range: 1 <= x <= 100
Example:

10

Response

Successfully retrieved flight offers

​
data
object[]
required
​
meta
object
required