GET Lowest Rate

GetLowestRate() gets the lowest rate available at a property for a given itinerary.  Many properties charge different rates depending on length of stay or number of adults, so this endpoint can give more exact rates than simply downloading the rates for a property


End Point

business_id (64-bit integer)

The property's unique id

check_in (Date YYYY-MM-dd)

The check in date of the requested itinerary

check_out (Date YYYY-MM-dd)

The check out date of the requested itinerary

num_adults (32 bit integer - optional)

The number of adults for the requested itinerary. If not specified, double occupancy (2) will be assumed


>curl --user username:passkey
--url ""


response_errors (See Response Errors)

The type of quote generated

check_in (Date YYYY-MM-dd)
The check in date for the quote

check_out (Date YYYY-MM-dd)
The check out date for the quote

available (char)
"Y" if the quote is available, "N" otherwise

rate_adjustment (string)
The amount or percentage that the property increases or decreases rates by globally for your channel

This field is only available to partners who act as resellers and do not display booking rates directly to guests, and is hidden by default. Please contact us if you believe you qualify to receive this information

base_rate (decimal)
The total nightly rate of the quoted itinerary not including taxes or fees

taxes (decimal)
The taxes of the quoted itinerary

fees (decimal)
The fees of the quoted itinerary

amountCharged (decimal)
The estimated amount the guest will be charged at the time of booking the reservation

unit_group_id (64 bit integer)
The unit group id of the unit quoted

booking_link (string)
A direct link to the property's booking engine for this quote.

This is for comparison only. Partners should use the AddReservation() endpoint

currency (string)
The three letter currency code for the currency used to generate the quote (i.e. "USD")

occupancy (32 bit integer)
The number of guests the quote was generated for

rate_for_date_list (list of objects)
One or more date-rate objects, detailing the rate calculated for each date in the itinerary

date-rate object:
Rate (decimal)
The rate for the specified date

ResDate (Date YYYY-MM-dd)
The date that this rate applies


     "pricing_type": "LowestForItinerary",
     "check_in": "2023-04-01",
     "check_out": "2023-04-04",
     "available": "Y",
     "base_rate": 300.00,
     "taxes": 0.00,
     "fees": 15.20,
     "amountCharged": 100.00,
     "unit_group_id": 27795,
     "booking_link": "",
     "currency": "AUD",
     "occupancy": 2,
     "rate_for_date_list": [
               "Rate": 100.00,
               "ResDate": "2023-04-01"
               "Rate": 100.00,
               "ResDate": "2023-04-02"
                "Rate": 100.00,
               "ResDate": "2023-04-03"
     "response_errors": []

Response Errors

response_errors(list of strings)

  •  business_id should be a long
  •  dates should be formatted 'YYYY-MM-dd'
  •  num_adults should be an int or omitted

  • This site requires a secure connection over HTTPS
  • The credentials supplied are incorrect or you do not have access to this resource

  • Something went wrong (Internal Server Error)

  • Server in maintenance mode


>curl --user username:passkey
--url ""

    dates should be formatted 'YYYY-MM-dd'