Searches Luxury Lodging's directly bookable vacation rentals by destination, dates, group size, bedrooms and amenities. With dates, only homes confirmed available are returned, each with a stay total that includes cleaning, fees and taxes; nightly rates exclude them. Interchangeable units of the same type are returned once, with every unit's id listed in `similar_units` so any of them can still be quoted and booked; `limit` counts those results, while `total_matching` counts the individual homes confirmed available. A busy market can hold more homes than one request can price, so `unpriced_in_time` counts matching homes whose availability was not established: they are unknown, not unavailable, and `unpriced_property_ids` lists the property_id of up to 30 of them, each of which can be priced individually with a live quote. Pet-friendly searches also report `pet_policy_unknown`: otherwise matching homes with unverified pet policies, with or without dates. While either count is above zero, the results are not the whole market; `price_all_matches`, a higher `limit`, or a narrower place covers more of it. Without dates no price is returned. Each result carries `accommodation_type` and `bathroom_sharing`: a private room or shared room is not an entire home. Optional filters cover accommodation type, exact bedrooms, required amenities and a budget; results can be paged with `cursor`, and `completeness` is partial when a matching home was left unpriced or unchecked. A query that names a known landmark or area ("near McCormick Place") returns homes within `radius_miles` of it, nearest first, each with `distance_miles` and `distance_type` straight_line: a direct distance, not a driving or walking route.
View input schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Free text place, e.g. 'Tampa', a neighbourhood, or a landmark such as 'near McCormick Place, Chicago'. A known Chicago landmark or area (McCormick Place, Navy Pier, Wrigley Field, O'Hare Airport, the South Loop and others) returns homes within radius_miles, nearest first, with a straight-line distance. Text that names no city, state, neighbourhood or landmark is refused with INVALID_INPUT; it is not answered as an empty, complete result."
},
"radius_miles": {
"type": "integer",
"minimum": 1,
"maximum": 25,
"description": "How far from a named landmark or area to search, in whole miles, 1 to 25. Homes are included by the distance they state, to the nearest half mile. Defaults to 5 for a landmark and 3 for an area. Ignored for any other place."
},
"market": {
"type": "string",
"description": "Market or city name, when the guest named one exactly."
},
"check_in": {
"type": "string",
"description": "Check-in date, YYYY-MM-DD. Availability is checked only when both dates are given."
},
"check_out": {
"type": "string",
"description": "Check-out date, YYYY-MM-DD."
},
"guests": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "Everyone staying, including children and infants."
},
"bedrooms_min": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Fewest bedrooms acceptable."
},
"bedrooms_exact": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Exactly this many bedrooms; 0 is a studio. Cannot be sent together with bedrooms_min."
},
"accommodation_type": {
"type": "string",
"enum": [
"entire_home",
"private_room",
"shared_room"
],
"description": "What the guest rents. Homes whose type is not recorded are left out and counted in accommodation_type_unknown."
},
"bathrooms_min": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Fewest bathrooms acceptable."
},
"pets": {
"type": [
"integer",
"boolean"
],
"minimum": 0,
"maximum": 4,
"description": "How many pets the guest is bringing, 0 to 4; 0 or leave out for none. true means one pet and false none. Results are limited to pet-friendly homes, dated totals include the pet fee for that many pets, and booking links keep the number of pets."
},
"amenities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pool",
"hot_tub",
"parking",
"wifi",
"kitchen",
"washer",
"pets"
]
},
"description": "Amenities every returned home has, as recorded by the property manager. The same hard filter as amenities_required, except a home with no amenity data is left out without being counted."
},
"amenities_required": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pool",
"hot_tub",
"parking",
"wifi",
"kitchen",
"washer",
"pets"
]
},
"description": "Amenities every returned home has. A home whose amenity data is unavailable fails the filter and is counted in amenities_unknown."
},
"amenities_preferred": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pool",
"hot_tub",
"parking",
"wifi",
"kitchen",
"washer",
"pets"
]
},
"description": "Amenities that order homes when the requested sort ties, and appear in match_reasons. Homes lacking them stay in the results."
},
"budget": {
"type": "object",
"description": "A spending limit. scope total compares amount with each home's stay total including cleaning, fees and taxes, and needs check_in and check_out. scope nightly compares it with each home's starting nightly rate, which excludes cleaning, fees and taxes. amount, currency and scope are all required.",
"properties": {
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000,
"description": "The limit, in the stated currency."
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Only USD is supported."
},
"scope": {
"type": "string",
"enum": [
"total",
"nightly"
],
"description": "total: the whole stay, with dates. nightly: the starting nightly rate, excluding fees and taxes."
}
},
"required": [
"amount",
"currency",
"scope"
],
"additionalProperties": false
},
"max_total": {
"type": "integer",
"minimum": 1,
"description": "Budget for the whole stay in dollars, including cleaning, fees and taxes. Applies only when dates are given."
},
"sort": {
"type": "string",
"enum": [
"total_price_asc",
"total_price_desc",
"from_price_asc",
"sleeps_desc"
],
"description": "total_price_* needs dates and orders by the stay total; from_price_asc orders by a starting rate that is not returned, and with dates by the stay total; sleeps_desc puts the largest homes first."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"description": "How many properties to return (default 8)."
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"description": "Results per page, up to 20. Takes the place of limit when both are sent."
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Page number, starting at 1, counted in units of page_size. Cannot be sent together with cursor."
},
"cursor": {
"type": "string",
"description": "The next_cursor value of the previous response, valid only with the same other inputs. Returns the page after it."
},
"price_all_matches": {
"type": "boolean",
"description": "Prices every matching home rather than a fast sample, so total_matching is the real count and the cheapest result is genuinely the cheapest. Slower, and still bounded: unpriced_in_time counts any homes it did not reach."
}
},
"additionalProperties": false
}