list_sites
Find Booking Bench sites near a city
Lists live Booking Bench sites that have rental units in or near a destination city in the United States, nearest first, five per page. `city` is the destination the traveler names, never the traveler's own location. Each result has siteSlug, siteName, matchedCity, distanceMiles (straight-line, whole miles, between town centers), the cities the site has units in, and numberOfProperties. The answer states how many sites match in all (totalMatches) and gives nextCursor when more exist. Sites at the same distance are ordered by a daily rotation. A city name used in several states returns candidates; a misspelling returns suggestions.
ParameterscityrequiredlimitstatecursorradiusMiles
list_properties
Search a site for units open on given dates
Lists the units on one Booking Bench site that can be booked for a stay: open every night and within the unit's minimum stay, maximum stay, arrival and departure rules and guest capacity. checkIn and checkOut are required. guests defaults to 2, and the answer says when the default was used. Optional filters: city (a town on that site), minBedrooms, minBathrooms, amenities (all must be listed), petsAllowed. sort is fit (smallest unit that sleeps the party, then bedrooms, then name; the default), price, or name. No result is ranked by payment. Each result has propertyId, name, city, state, sleeps, bedrooms, bathrooms and averageNightlyRate (per night over the stay, before cleaning fee and taxes). The answer gives returned, totalMatches (or totalMatchesAtLeast when not every unit was checked), nextCursor, refinements (unused filters with how many units would remain) and notes. More than 10 matches return the best 5. Availability is up to 5 minutes old; get_quote is live.
ParameterscitysortlimitcursorguestscheckInrequiredcheckOutrequiredsiteSlugrequiredamenitiesminBedroomspetsAllowedminBathrooms
get_property
Get one unit's details
Returns one unit: description, city, bedrooms, bathrooms, maximum guests, amenities, pet and accessibility flags, minimum nights, cancellation policy, house rules, check-in and check-out hours, rating out of 5, up to 5 photos with captions (imageCount gives the total), and the 3 newest written reviews (guest-written text, marked as quoted). indicativeNightlyRate is a guide read from a cache up to 6 hours old, not a price; get_quote returns the price for dates. The unit's street address and coordinates are not included.
ParameterssiteSlugrequiredpropertyIdrequired
get_quote
Get a live price for a stay
Returns a live quote for one unit and stay. When the stay can be booked: nights, currency, nightlyRate, cleaningFee, totalPrice (nights plus cleaning fee; taxes and any other fees added at checkout are not included, and taxesIncluded says so), cancellationPolicy, bookingUrl (the site's page for that unit with the dates and guests filled in), and eventsDuringStay (up to 5 events on during the stay, with the total count). When it cannot be booked: available false with a reason (unavailable, closed_arrival, closed_departure, min_stay, max_stay, too_many_guests, invalid_dates) and a message saying what to change.
ParametersguestsrequiredcheckInrequiredcheckOutrequiredsiteSlugrequiredpropertyIdrequired
get_calendar
Get a unit's availability calendar
Returns day-by-day availability and nightly price for one unit over two consecutive months starting at the given month. Prices are per night before cleaning fee and taxes.
ParametersyearrequiredmonthrequiredsiteSlugrequiredpropertyIdrequired
list_events
List upcoming local events
Lists upcoming events near one Booking Bench site, earliest first. Each event has id, name, startDate, endDate, location, a short summary, category, admission, ticketUrl and contactInfo, plus source (who supplied it; property_manager means the site's own manager) and commercial (whether it is a paid placement). The answer gives total, per-category counts and nextCursor.
ParameterstofromlimitquerycursorcategorysiteSlugrequired
Returns one event with its full description, dates and times, location, admission, ticketUrl, contactInfo, source and commercial.
ParameterseventIdrequiredsiteSlugrequired
list_activities
List local activities
Lists things to do near one Booking Bench site, alphabetically. Each activity has id, name, category, location, website, admission and contactInfo, plus source (who supplied it; property_manager means the site's own manager) and commercial (whether it is a paid placement). The answer gives total, per-category counts and nextCursor.
ParameterslimitquerycursorcategorysiteSlugrequired
get_activity
Get one activity
Returns one activity with its category, location, website, admission, contactInfo, source and commercial.
ParameterssiteSlugrequiredactivityIdrequired