Serveur MCP

EscapeStays by Luxury Lodging

com.luxurylodgingpm.stay/luxury-lodging
Commerce et retail Voyage et hôtellerie Public et accessible MCP 2026-07-28

Ce que fait ce MCP

Searches vacation rentals, checks availability, compares properties, provides live stay totals, and links users to complete bookings.

compare_properties
Compare homes side by side
Compares 2 to 5 homes in one call: size, the amenities guests choose by, review counts, each home's own check-in time, deposit and pet policy, and with dates, availability and the stay total for each, for a guest deciding between specific homes. Each home carries `accommodation_type` and `bathroom_sharing`: a private room or shared room is not an entire home. Without dates no price is returned.
Lecture seule Accès externe Idempotent
Schéma d’entrée
{'type': 'object', 'required': ['property_ids'], 'properties': {'pets': {'type': ['integer', 'boolean'], 'maximum': 4, 'minimum': 0, 'description': 'How many pets the guest is bringing, 0 to 4; 0 or leave out for none. true means one pet and false none. Totals include the pet fee for that many pets.'}, 'guests': {'type': 'integer', 'maximum': 50, 'minimum': 1, 'description': 'Everyone staying, including children and infants.'}, 'check_in': {'type': 'string', 'description': 'Check-in date, YYYY-MM-DD. Totals are returned only when both dates are given.'}, 'check_out': {'type': 'string', 'description': 'Check-out date, YYYY-MM-DD.'}, 'property_ids': {'type': 'array', 'items': {'type': 'string'}, 'maxItems': 5, 'minItems': 2, 'description': 'Property ids or slugs from search results or booking links.'}}, 'additionalProperties': False}
Schéma de sortie
{'type': 'object', 'required': ['compared', 'dates_checked', 'homes', 'note'], 'properties': {'note': {'type': 'string'}, 'homes': {'type': 'array', 'items': {'type': 'object', 'required': ['property_id', 'booking_url'], 'properties': {'city': {'type': 'string'}, 'name': {'type': 'string'}, 'state': {'type': ['string', 'null']}, 'nights': {'type': ['integer', 'null']}, 'reason': {'type': 'string'}, 'sleeps': {'type': ['integer', 'null']}, 'pet_fee': {'type': ['number', 'null'], 'description': 'The fee for one pet, from the fee table the quote charges from; with several pets a live quote charges it as pet_fee_basis says (per pet, per pet per night) and states the total in price_breakdown.pet_fee. Null when the home charges none; omitted when it could not be verified, and pet_fee_note says why.'}, 'bedrooms': {'type': ['number', 'null']}, 'available': {'type': 'boolean', 'description': "Only present when dates were given. A reason of not_checked means this home's availability could not be read, not that it is booked."}, 'bathrooms': {'type': ['number', 'null']}, 'highlights': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Up to three short phrases describing what sets the home apart.'}, 'stay_total': {'type': 'number'}, 'booking_url': {'type': 'string'}, 'detail_note': {'type': 'string'}, 'property_id': {'type': 'integer'}, 'check_out_by': {'type': 'string'}, 'pet_fee_note': {'type': 'string'}, 'pets_allowed': {'type': 'boolean', 'description': 'Omitted when pet policy could not be verified.'}, 'review_count': {'type': 'integer', 'description': 'How many 4- and 5-star reviews this home has. It is a count, not a rating; no average rating exists for any home.'}, 'avg_per_night': {'type': 'number', 'description': 'No longer returned; stay_total is the price of the stay.'}, 'check_in_from': {'type': 'string'}, 'neighbourhood': {'type': ['string', 'null'], 'description': 'Neighbourhood-level location only; the exact address is shared after booking.'}, 'pet_fee_basis': {'enum': ['per stay', 'per night', 'per pet', 'per pet per night'], 'type': 'string'}, 'top_amenities': {'type': 'array', 'items': {'type': 'string'}}, 'review_sources': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Which platforms those reviews came from.'}, 'from_price_note': {'type': 'string', 'description': 'Deprecated, no longer returned along with from_price_per_night.'}, 'pet_policy_note': {'type': 'string'}, 'bathroom_sharing': {'enum': ['private', 'shared', 'unknown'], 'type': 'string', 'description': 'Whether the guest has a private bathroom or shares one. unknown means it is not recorded for this home.'}, 'details_available': {'type': 'boolean', 'description': "Only present, and only false, when this home's record could not be loaded. Such a row carries no name, place, amenity or review fields at all; detail_note says why."}, 'accommodation_type': {'enum': ['entire_home', 'private_room', 'shared_room', 'unknown'], 'type': 'string', 'description': 'What the guest rents: an entire home, a private room in a shared building or a shared room. A private room or shared room is not an entire home. unknown means the type is not recorded for this home.'}, 'stay_total_display': {'type': 'string'}, 'from_price_per_night': {'type': ['number', 'null'], 'description': 'Deprecated, no longer returned: only a row with a confirmed stay_total carries a price. Kept in this schema so existing clients still validate.'}, 'security_deposit_hold': {'type': ['number', 'null']}}}}, 'compared': {'type': 'integer'}, 'dates_checked': {'type': 'boolean'}}}
get_availability
Get availability calendar
Open and blocked nights for one property over a date range of up to 93 days, with its minimum stay. It shows which alternative dates are open; it does not price or confirm a stay.
Lecture seule Accès externe Idempotent
Schéma d’entrée
{'type': 'object', 'required': ['property_id', 'start_date', 'end_date'], 'properties': {'end_date': {'type': 'string', 'description': 'Last date to check, YYYY-MM-DD. At most 93 days after start_date.'}, 'start_date': {'type': 'string', 'description': 'First date to check, YYYY-MM-DD.'}, 'property_id': {'type': 'string', 'description': 'Property id or slug.'}}, 'additionalProperties': False}
Schéma de sortie
{'type': 'object', 'required': ['property_id', 'start_date', 'end_date', 'nights_open', 'nights_blocked', 'open_dates', 'blocked_dates', 'note'], 'properties': {'note': {'type': 'string'}, 'end_date': {'type': 'string'}, 'open_dates': {'type': 'array', 'items': {'type': 'string'}, 'description': 'YYYY-MM-DD nights that are open. They still have to satisfy minimum stay and arrival rules.'}, 'start_date': {'type': 'string'}, 'nights_open': {'type': 'integer'}, 'property_id': {'type': 'integer'}, 'blocked_dates': {'type': 'array', 'items': {'type': 'string'}}, 'minimum_nights': {'type': ['number', 'null']}, 'nights_blocked': {'type': 'integer'}}}
get_booking_link
Get a booking link
A link to Luxury Lodging's own site that opens checkout for one home, dates, party size and rate, for the same stay, rate and attribution as a live quote's booking_url, carrying a freshly signed quote token. It checks the stay the way a live quote does: valid dates, the home's guest limit and its pet policy, and it re-prices the stay to sign the link without returning the total. Opening the link does not reserve the home, hold dates or take payment; the guest completes checkout on EscapeStays. When the guest has dates and wants to book, call get_booking_link and give the guest that URL. Never return a nightly rate as the price; quote all-in totals only. Never return an exact street address.
Lecture seule Accès externe Idempotent
Schéma d’entrée
{'type': 'object', 'required': ['property_id', 'check_in', 'check_out', 'guests'], 'properties': {'pets': {'type': ['integer', 'boolean'], 'maximum': 4, 'minimum': 0, 'description': 'How many pets the guest is bringing, 0 to 4; 0 or leave out for none. true means one pet and false none. The link keeps the number of pets, and the stay is refused when the home does not allow them.'}, 'rate': {'enum': ['refundable', 'non_refundable'], 'type': 'string', 'description': "Which rate the link opens on. Defaults to non_refundable, the rate a live quote's booking_url opens on. refundable is offered only while check-in is more than 30 days away."}, 'guests': {'type': 'integer', 'maximum': 50, 'minimum': 1, 'description': 'Everyone staying, including children and infants. The link opens on this party size.'}, 'check_in': {'type': 'string', 'description': 'Check-in date, YYYY-MM-DD.'}, 'quote_id': {'type': 'string', 'maxLength': 64, 'description': 'The quote.quote_id from a live quote for this stay, echoed back unchanged. It is not checked against current pricing.'}, 'check_out': {'type': 'string', 'description': 'Check-out date, YYYY-MM-DD.'}, 'property_id': {'type': 'string', 'description': 'Property id or slug.'}}, 'additionalProperties': False}
Schéma de sortie
{'type': 'object', 'required': ['booking_url', 'property_id', 'canonical_url', 'check_in', 'check_out', 'guests', 'pets', 'rate', 'confirms_booking', 'note', 'pricing_note'], 'properties': {'note': {'type': 'string'}, 'pets': {'type': 'integer', 'maximum': 4, 'minimum': 0}, 'rate': {'enum': ['refundable', 'non_refundable'], 'type': 'string', 'description': 'The rate the link opens on.'}, 'guests': {'type': 'integer'}, 'check_in': {'type': 'string'}, 'quote_id': {'type': 'string', 'description': 'The quote_id sent with the request, echoed unchanged. Absent when none was sent.'}, 'check_out': {'type': 'string'}, 'booking_url': {'type': 'string', 'description': "Where the guest completes the booking on Luxury Lodging's own site. The link a live quote returns for this stay and rate: the same home, dates, party, rate and attribution, with a freshly signed quote token (so its quote_ref differs from the quote's)."}, 'property_id': {'type': 'integer'}, 'pricing_note': {'type': 'string', 'description': 'States that the stay was re-priced to sign the link, and that the total is not returned here.'}, 'canonical_url': {'type': 'string', 'description': "The home's property page, not the booking link."}, 'confirms_booking': {'enum': [False], 'type': 'boolean', 'description': 'False on every response: the link does not book, hold or pay for anything.'}}, 'description': 'A booking link for one stay. Opening it does not reserve the home.'}
get_live_quote
Get a live total price
Live price for one property and one stay. stay_total includes cleaning, fees and taxes; nightly rates exclude them. Also returns the refundable deposit hold, which is separate from the total, the payment schedule, and that home's own cancellation and check-in terms. The top-level totals and cancellation are the non-refundable rate; rate_options lists every rate on offer with its own terms, total and booking_url, including a refundable rate with its free-cancellation deadline when check-in is more than 30 days away. Returns a booking_url the guest opens to complete the booking and accept the rental terms on Luxury Lodging's own site; this tool does not book or take payment. Amounts ending in _minor are integer cents in `currency`.
Lecture seule Accès externe Idempotent
Schéma d’entrée
{'type': 'object', 'required': ['property_id', 'check_in', 'check_out'], 'properties': {'pets': {'type': ['integer', 'boolean'], 'maximum': 4, 'minimum': 0, 'description': 'How many pets the guest is bringing, 0 to 4; 0 or leave out for none. true means one pet and false none. This changes the price: some homes charge per pet or per pet per night.'}, 'guests': {'type': 'integer', 'maximum': 50, 'minimum': 1, 'description': 'Everyone staying, including children and infants.'}, 'check_in': {'type': 'string', 'description': 'Check-in date, YYYY-MM-DD.'}, 'check_out': {'type': 'string', 'description': 'Check-out date, YYYY-MM-DD.'}, 'property_id': {'type': 'string', 'description': 'Property id or slug.'}}, 'additionalProperties': False}
Schéma de sortie
{'type': 'object', 'required': ['property_id', 'available', 'booking_url'], 'properties': {'name': {'type': 'string'}, 'note': {'type': 'string'}, 'pets': {'type': 'integer', 'maximum': 4, 'minimum': 0, 'description': 'How many pets this quote is for. pet_fee in price_breakdown is the fee for that many.'}, 'quote': {'type': 'object', 'required': ['availability_status', 'inventory_held', 'checked_at', 'canonical_url', 'incomplete', 'missing'], 'properties': {'nights': {'type': ['integer', 'null']}, 'charges': {'type': 'array', 'items': {'type': 'object', 'required': ['type', 'name', 'amount_minor', 'paid_at'], 'properties': {'name': {'type': 'string'}, 'type': {'enum': ['nightly', 'fee', 'tax', 'discount', 'card_fee', 'security_hold', 'adjustment'], 'type': 'string'}, 'paid_at': {'enum': ['checkout', 'outside_checkout'], 'type': 'string', 'description': 'checkout: part of the total. outside_checkout: not part of it (the security hold).'}, 'amount_minor': {'type': 'integer'}}}, 'description': 'Every charge, itemised. The amounts of the rows with paid_at checkout add up to total_stay_price_minor exactly; a discount row is negative.'}, 'missing': {'type': 'array', 'items': {'type': 'string'}, 'description': "rent_tax_rate: the provider's fee table could not be read, so the refundable rate cannot be priced. price_breakdown: the provider sent only a total. line_items_mismatch: the itemised charges add up to more than the total."}, 'currency': {'type': 'string', 'description': 'ISO 4217 code, e.g. USD.'}, 'quote_id': {'type': 'string', 'description': 'Stable id for this priced stay: the same home, dates, guests, pets, rate and total give the same id; any change gives a new one. Not a hold or a reservation.'}, 'timezone': {'type': ['string', 'null'], 'description': "IANA zone of the home: the provider's own zone when it states one, otherwise the zone of the home's US state (timezone_source says which). Null when unknown."}, 'checked_at': {'type': 'string', 'description': 'When this quote was fetched, ISO 8601.'}, 'expires_at': {'type': 'string', 'description': 'When the quote lapses, ISO 8601; the same instant as quote_expires_at.'}, 'incomplete': {'type': 'boolean', 'description': 'True when a required input or tax could not be determined; missing says which.'}, 'refundable': {'type': 'boolean', 'description': 'True when the rate this quote prices can be cancelled for a refund until its free-cancellation deadline; false for the non-refundable rate.'}, 'tax_source': {'enum': ['provider', 'jurisdiction_table'], 'type': 'string', 'description': "Where the tax comes from: the provider's own quote, or our verified rate table for the home's jurisdiction when the provider's quote had none. Either way the tax is collected and in the total."}, 'taxes_minor': {'type': ['integer', 'null'], 'minimum': 0, 'description': 'Lodging tax.'}, 'canonical_url': {'type': 'string', 'description': "The home's property page, not the booking link."}, 'due_now_minor': {'type': 'integer', 'minimum': 0, 'description': 'Charged when the guest books: 50% of the total when check-in is more than 60 days away, otherwise all of it.'}, 'card_fee_minor': {'type': ['integer', 'null'], 'minimum': 0, 'description': 'The 3.5% card processing fee, added at checkout and included in the total.'}, 'inventory_held': {'type': 'boolean', 'description': 'False: a quote does not hold the home.'}, 'taxes_included': {'type': 'boolean', 'description': 'True: the total includes lodging tax, which is collected on every stay.'}, 'discounts_minor': {'type': ['integer', 'null'], 'minimum': 0, 'description': 'A positive amount subtracted from the total; 0 when there is none.'}, 'due_later_minor': {'type': 'integer', 'minimum': 0, 'description': 'The rest, charged automatically to the same card 60 days before check-in; 0 when everything is due now.'}, 'timezone_source': {'enum': ['listing', 'market', 'unknown'], 'type': 'string'}, 'availability_status': {'enum': ['available', 'unavailable'], 'type': 'string'}, 'optional_fees_minor': {'type': ['integer', 'null'], 'minimum': 0, 'description': 'Fees the guest chose, the pet fee for the pets in this quote.'}, 'cancellation_summary': {'type': 'string'}, 'mandatory_fees_minor': {'type': ['integer', 'null'], 'minimum': 0, 'description': 'Cleaning and every other required fee.'}, 'cancellation_policy_id': {'enum': ['non_refundable', 'refundable'], 'type': 'string', 'description': 'The rate this quote prices; rate_options lists both.'}, 'nightly_subtotal_minor': {'type': ['integer', 'null'], 'minimum': 0, 'description': 'Rent for the nights before any discount, plus the refundable-rate premium when that rate is quoted.'}, 'total_stay_price_minor': {'type': 'integer', 'minimum': 0, 'description': 'The whole price of the stay, equal to stay_total in cents.'}, 'refundable_security_hold_minor': {'type': 'integer', 'minimum': 0, 'description': "A refundable hold on the card on file, separate from the total. The home's own amount, or the standard hold when it states none."}}, 'description': 'The authoritative, machine-readable quote for this stay, for the rate stay_total prices (the non-refundable rate). Amounts ending in _minor are integer cents in `currency`. total_stay_price_minor is exactly what the guest is charged in total, including taxes and the card processing fee, and the amounts add up: total_stay_price_minor = nightly_subtotal_minor + mandatory_fees_minor + optional_fees_minor + taxes_minor + card_fee_minor - discounts_minor. When available is false only availability_status, inventory_held, checked_at, canonical_url, incomplete and missing are present. The itemised _minor amounts are null only when missing includes price_breakdown.'}, 'guests': {'type': 'integer'}, 'nights': {'type': ['integer', 'null']}, 'reason': {'type': 'string', 'description': 'Why the stay cannot be booked. Only present when available is false.'}, 'check_in': {'type': 'string'}, 'currency': {'type': 'string'}, 'available': {'type': 'boolean'}, 'check_out': {'type': 'string'}, 'quoted_at': {'type': 'string'}, 'stay_total': {'type': ['number', 'null'], 'description': 'The price of the stay, including cleaning, fees and taxes. Nightly rates exclude them.'}, 'booking_url': {'type': 'string'}, 'property_id': {'type': 'integer'}, 'cancellation': {'type': 'string', 'description': "This home's own cancellation terms for the non-refundable rate, which stay_total prices. Each entry in rate_options carries its own terms, and those are the only refund terms that apply to that rate."}, 'check_out_by': {'type': 'string'}, 'rate_options': {'type': 'array', 'items': {'type': 'object', 'required': ['plan', 'refundable', 'stay_total', 'total_due_now', 'cancellation', 'booking_url'], 'properties': {'plan': {'enum': ['non_refundable', 'refundable'], 'type': 'string'}, 'refundable': {'type': 'boolean', 'description': 'True when this rate can be cancelled for a refund until free_cancel_until; false when a confirmed reservation cannot be cancelled for a refund.'}, 'stay_total': {'type': 'number'}, 'booking_url': {'type': 'string'}, 'cancellation': {'type': 'string', 'description': "This rate's terms."}, 'total_due_now': {'type': 'number'}, 'price_breakdown': {'type': 'object'}, 'payment_schedule': {'type': 'object'}, 'free_cancel_until': {'type': 'string', 'description': 'Refundable rate only. The last instant, in UTC, the stay can be cancelled for a full refund.'}}}, 'description': 'Every rate on offer for this stay. The first is the non-refundable rate (the same totals as the top level). When check-in is more than 30 days away a refundable rate follows: 8% more on the nightly subtotal, taxed as rent, cancellable for a full refund of everything paid until free_cancel_until. Each rate has its own booking_url.'}, 'check_in_from': {'type': 'string'}, 'total_display': {'type': 'string', 'description': 'stay_total, formatted.'}, 'total_due_now': {'type': ['number', 'null'], 'description': 'What the guest pays at booking: the whole stay_total, or 50% of it when check-in is more than 60 days away; payment_schedule says which.'}, 'maximum_nights': {'type': ['number', 'null']}, 'minimum_nights': {'type': ['number', 'null']}, 'price_breakdown': {'type': ['object', 'null'], 'properties': {'taxes': {'type': ['number', 'null'], 'description': 'Lodging tax. It is collected on every stay and included in the total.'}, 'total': {'type': ['number', 'null']}, 'pet_fee': {'type': ['number', 'null']}, 'discount': {'type': ['number', 'null']}, 'other_fees': {'type': ['number', 'null']}, 'cleaning_fee': {'type': ['number', 'null']}, 'extra_guest_fee': {'type': ['number', 'null']}, 'nightly_subtotal': {'type': ['number', 'null']}, 'card_processing_fee': {'type': ['number', 'null']}, 'refundable_rate_premium': {'type': ['number', 'null'], 'description': 'The 8% of the nightly subtotal the refundable rate adds; 0 on the non-refundable rate.'}}}, 'payment_schedule': {'type': 'object', 'properties': {'plan': {'enum': ['full', 'deposit'], 'type': 'string'}, 'balance': {'type': 'number'}, 'due_at_booking': {'type': 'number'}, 'balance_charged_on': {'type': 'string'}}, 'description': "When the guest pays. plan 'deposit': due_at_booking now and the balance charged automatically to the same card on balance_charged_on (60 days before check-in). plan 'full': everything at booking."}, 'quote_expires_at': {'type': 'string', 'description': 'When this quote lapses. After it, the price of the stay can differ from stay_total until it is quoted again.'}, 'security_deposit_hold': {'type': ['number', 'null'], 'description': 'A refundable hold, not part of stay_total.'}}, 'description': 'A live total for one stay. When available is false only property_id, available, reason, booking_url and a short quote block are present.'}
get_property_details
Get property details
Full detail for one property: bedrooms, capacity, amenities recorded by the property manager, photos, house rules and the real check-in, check-out, deposit and pet policies for that specific home. Location is given at neighbourhood level; the exact address is shared after booking. Guest reviews are a selection of 4- and 5-star reviews, each with its source; no average rating exists. `accommodation_type` and `bathroom_sharing` say whether the guest rents an entire home or a room: a private room or shared room is not an entire home.
Lecture seule Accès externe Idempotent
Schéma d’entrée
{'type': 'object', 'required': ['property_id'], 'properties': {'property_id': {'type': 'string', 'description': 'Property id or the slug from a booking link.'}}, 'additionalProperties': False}
Schéma de sortie
{'type': 'object', 'required': ['property_id', 'name', 'location', 'amenities', 'amenities_source', 'photos', 'policies', 'house_rules', 'guest_reviews', 'booking_url', 'support_email'], 'properties': {'beds': {'type': ['number', 'null']}, 'name': {'type': 'string'}, 'alias': {'type': ['string', 'null']}, 'photos': {'type': 'array', 'items': {'type': 'string'}}, 'sleeps': {'type': ['integer', 'null']}, 'bedrooms': {'type': ['number', 'null']}, 'location': {'type': 'object', 'required': ['city', 'country'], 'properties': {'city': {'type': 'string'}, 'state': {'type': ['string', 'null']}, 'country': {'type': ['string', 'null'], 'description': 'Null when the provider gave none; the country is then unknown.'}, 'neighbourhood': {'type': ['string', 'null'], 'description': 'Neighbourhood-level location only; the exact address is shared after booking.'}}}, 'policies': {'type': 'object', 'required': ['check_in_from', 'check_out_by', 'cancellation', 'security_deposit_hold', 'policies_source'], 'properties': {'pet_fee': {'type': ['number', 'null'], 'description': 'The fee for one pet, from the fee table the quote charges from; with several pets a live quote charges it as pet_fee_basis says (per pet, per pet per night) and states the total in price_breakdown.pet_fee. Null when the home charges none; omitted when it could not be verified, and pet_fee_note says why.'}, 'quiet_hours': {'type': ['object', 'null'], 'required': ['from', 'to'], 'properties': {'to': {'type': 'string'}, 'from': {'type': 'string'}}}, 'cancellation': {'type': 'string'}, 'check_out_by': {'type': 'string'}, 'pet_fee_note': {'type': 'string'}, 'pets_allowed': {'type': 'boolean', 'description': 'Omitted when pet policy could not be verified.'}, 'check_in_from': {'type': 'string'}, 'pet_fee_basis': {'enum': ['per stay', 'per night', 'per pet', 'per pet per night'], 'type': 'string', 'description': 'How pet_fee applies. Per night multiplies by the nights; per pet by the number of pets; per pet per night by both.'}, 'check_in_until': {'type': ['string', 'null']}, 'minimum_nights': {'type': ['number', 'null']}, 'pet_policy_note': {'type': 'string'}, 'policies_source': {'enum': ['provider', 'portfolio-default'], 'type': 'string'}, 'security_deposit_hold': {'type': 'number', 'description': 'A refundable hold, not part of the total charged at booking.'}}, 'description': 'This home\'s own policies, not portfolio defaults, when policies_source is "provider".'}, 'amenities': {'type': 'array', 'items': {'type': 'string'}}, 'bathrooms': {'type': ['number', 'null']}, 'booking_url': {'type': 'string'}, 'description': {'type': ['string', 'null']}, 'house_rules': {'type': 'array', 'items': {'type': 'string'}}, 'property_id': {'type': 'integer'}, 'guest_reviews': {'type': 'object', 'required': ['selection', 'reviews'], 'properties': {'reviews': {'type': 'array', 'items': {'type': 'object', 'required': ['source'], 'properties': {'text': {'type': ['string', 'null']}, 'stars': {'type': ['number', 'null']}, 'source': {'type': 'string', 'description': 'The platform the review was left on.'}, 'published': {'type': ['string', 'null']}}}}, 'selection': {'type': 'string'}}, 'description': 'A selection of 4- and 5-star reviews, not a summary of every review. No overall or average rating is implied or available.'}, 'property_type': {'type': ['string', 'null']}, 'support_email': {'type': 'string'}, 'amenities_source': {'enum': ['provider', 'unavailable'], 'type': 'string'}, 'bathroom_sharing': {'enum': ['private', 'shared', 'unknown'], 'type': 'string', 'description': 'Whether the guest has a private bathroom or shares one. unknown means it is not recorded for this home.'}, 'common_questions': {'type': 'array', 'items': {'type': 'object', 'required': ['question', 'answer'], 'properties': {'answer': {'type': 'string'}, 'question': {'type': 'string'}}}}, 'accommodation_type': {'enum': ['entire_home', 'private_room', 'shared_room', 'unknown'], 'type': 'string', 'description': 'What the guest rents: an entire home, a private room in a shared building or a shared room. A private room or shared room is not an entire home. unknown means the type is not recorded for this home.'}}}
list_markets
List destinations
Every city where Luxury Lodging has directly bookable homes, with the state or region, the country, how many homes and the largest group each can sleep. Counts are given for the city alone and for the wider area a search covers, split into whole homes and rooms. It shows whether a destination is covered, including when a guest has not named a place.
Lecture seule Accès externe Idempotent
Schéma d’entrée
{'type': 'object', 'properties': {}, 'additionalProperties': False}
Schéma de sortie
{'type': 'object', 'required': ['markets_count', 'homes_count', 'markets', 'note'], 'properties': {'note': {'type': 'string'}, 'markets': {'type': 'array', 'items': {'type': 'object', 'required': ['city', 'homes', 'sleeps_max'], 'properties': {'city': {'type': 'string'}, 'homes': {'type': 'integer'}, 'state': {'type': ['string', 'null'], 'description': 'State, province or region as the provider files it.'}, 'counts': {'type': 'object', 'properties': {'area': {'type': 'object', 'required': ['total', 'homes', 'private_rooms', 'shared_rooms', 'unknown_type'], 'properties': {'homes': {'type': 'integer', 'description': 'Entire homes, plus homes whose type is not recorded (unknown_type).'}, 'total': {'type': 'integer'}, 'shared_rooms': {'type': 'integer'}, 'unknown_type': {'type': 'integer', 'description': 'Counted inside homes: nothing on record says whether these are whole homes.'}, 'private_rooms': {'type': 'integer'}}}, 'city': {'type': 'object', 'required': ['total', 'homes', 'private_rooms', 'shared_rooms', 'unknown_type'], 'properties': {'homes': {'type': 'integer', 'description': 'Entire homes, plus homes whose type is not recorded (unknown_type).'}, 'total': {'type': 'integer'}, 'shared_rooms': {'type': 'integer'}, 'unknown_type': {'type': 'integer', 'description': 'Counted inside homes: nothing on record says whether these are whole homes.'}, 'private_rooms': {'type': 'integer'}}}}, 'description': 'The same stays split into whole homes and rooms, for the city alone and for the area. homes includes unknown_type; a room is not a whole home.'}, 'country': {'type': ['string', 'null'], 'description': 'Not every destination is in the United States; two cities can share a name across countries.'}, 'summary': {'type': 'string', 'description': 'The counts as a guest reads them, e.g. "41 stays in Chicago · 47 in the Chicago area, including 13 private rooms".'}, 'area_name': {'type': 'string'}, 'sleeps_max': {'type': 'integer', 'description': 'The largest group any single home in this market sleeps.'}, 'homes_in_area': {'type': 'integer', 'description': 'Stays a search for this market returns before dates, including nearby cities (Chicago: 65 miles around the city). At least homes.'}, 'collection_url': {'type': 'string', 'description': 'The public page for this market, when it has enough homes to have one. It lists the homes and their neighbourhoods.'}}}}, 'homes_count': {'type': 'integer'}, 'markets_count': {'type': 'integer'}}}
search_properties
Search Luxury Lodging homes
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.
Lecture seule Accès externe Idempotent
Schéma d’entrée
{'type': 'object', 'properties': {'page': {'type': 'integer', 'minimum': 1, 'description': 'Page number, starting at 1, counted in units of page_size. Cannot be sent together with cursor.'}, 'pets': {'type': ['integer', 'boolean'], 'maximum': 4, 'minimum': 0, '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.'}, 'sort': {'enum': ['total_price_asc', 'total_price_desc', 'from_price_asc', 'sleeps_desc'], 'type': 'string', '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', 'maximum': 20, 'minimum': 1, 'description': 'How many properties to return (default 8).'}, '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."}, 'budget': {'type': 'object', 'required': ['amount', 'currency', 'scope'], 'properties': {'scope': {'enum': ['total', 'nightly'], 'type': 'string', 'description': 'total: the whole stay, with dates. nightly: the starting nightly rate, excluding fees and taxes.'}, 'amount': {'type': 'number', 'maximum': 1000000, 'description': 'The limit, in the stated currency.', 'exclusiveMinimum': 0}, 'currency': {'enum': ['USD'], 'type': 'string', 'description': 'Only USD is supported.'}}, '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.", 'additionalProperties': False}, 'cursor': {'type': 'string', 'description': 'The next_cursor value of the previous response, valid only with the same other inputs. Returns the page after it.'}, 'guests': {'type': 'integer', 'maximum': 50, 'minimum': 1, 'description': 'Everyone staying, including children and infants.'}, '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.'}, 'amenities': {'type': 'array', 'items': {'enum': ['pool', 'hot_tub', 'parking', 'wifi', 'kitchen', 'washer', 'pets'], 'type': 'string'}, '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.'}, 'check_out': {'type': 'string', 'description': 'Check-out date, YYYY-MM-DD.'}, '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.'}, 'page_size': {'type': 'integer', 'maximum': 20, 'minimum': 1, 'description': 'Results per page, up to 20. Takes the place of limit when both are sent.'}, 'bedrooms_min': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Fewest bedrooms acceptable.'}, 'radius_miles': {'type': 'integer', 'maximum': 25, 'minimum': 1, '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.'}, 'bathrooms_min': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Fewest bathrooms acceptable.'}, 'bedrooms_exact': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Exactly this many bedrooms; 0 is a studio. Cannot be sent together with bedrooms_min.'}, '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.'}, 'accommodation_type': {'enum': ['entire_home', 'private_room', 'shared_room'], 'type': 'string', 'description': 'What the guest rents. Homes whose type is not recorded are left out and counted in accommodation_type_unknown.'}, 'amenities_required': {'type': 'array', 'items': {'enum': ['pool', 'hot_tub', 'parking', 'wifi', 'kitchen', 'washer', 'pets'], 'type': 'string'}, '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': {'enum': ['pool', 'hot_tub', 'parking', 'wifi', 'kitchen', 'washer', 'pets'], 'type': 'string'}, 'description': 'Amenities that order homes when the requested sort ties, and appear in match_reasons. Homes lacking them stay in the results.'}}, 'additionalProperties': False}
Schéma de sortie
{'type': 'object', 'required': ['matches', 'total_matching', 'total_matching_groups', 'unpriced_in_time', 'unpriced_property_ids', 'dates_checked', 'availability_note', 'properties', 'completeness', 'search_scope', 'has_more', 'next_cursor'], 'properties': {'offset': {'type': 'integer', 'description': 'How many results precede this page in the full ordering.'}, 'status': {'enum': ['OK', 'NO_MATCHES'], 'type': 'string', 'description': 'NO_MATCHES: nothing matched and nothing is unknown (unpriced_in_time and pet_policy_unknown are both 0). It is a normal answer, not an error. Any other search is OK, even with no results, and unpriced_in_time and pet_policy_unknown say what is still unknown.'}, 'matches': {'type': 'integer', 'description': 'How many results this response carries.'}, 'has_more': {'type': 'boolean', 'description': 'True when more results follow this page in the same ordering, within the priced sample. Homes counted in unpriced_in_time are not part of any page and have no effect on this.'}, 'page_size': {'type': 'integer', 'description': 'How many results this page asked for.'}, 'properties': {'type': 'array', 'items': {'type': 'object', 'required': ['property_id', 'name', 'city', 'top_amenities', 'review_count', 'review_sources', 'highlights', 'booking_url', 'match_reasons', 'availability_status', 'missing_or_unverified'], 'properties': {'city': {'type': 'string'}, 'name': {'type': 'string'}, 'photo': {'type': ['string', 'null']}, 'state': {'type': ['string', 'null']}, 'nights': {'type': 'integer'}, 'sleeps': {'type': ['integer', 'null']}, 'bedrooms': {'type': ['number', 'null']}, 'bathrooms': {'type': ['number', 'null']}, 'highlights': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Up to three short phrases describing what sets the home apart.'}, 'stay_total': {'type': 'number', 'description': 'Total for the requested dates including cleaning, fees and taxes. Only present when dates were given and the home was priced.'}, 'booking_url': {'type': 'string', 'description': "Where the guest completes the booking on Luxury Lodging's own site."}, 'property_id': {'type': 'integer'}, 'review_count': {'type': 'integer', 'description': 'How many 4- and 5-star reviews this home has. It is a count, not a rating; no average rating exists for any home.'}, 'avg_per_night': {'type': 'number', 'description': 'No longer returned; stay_total is the price of the stay.'}, 'distance_type': {'enum': ['straight_line'], 'type': 'string', 'description': 'Only with distance_miles: how the distance was measured. straight_line is the direct distance, shorter than any route.'}, 'match_reasons': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Short statements of why this home passed the filters that were sent, e.g. "2 bedrooms (exact)" or "has parking". On a landmark search the first is the distance, e.g. "1.5 mi from McCormick Place (straight line)" or "under 0.5 mi from McCormick Place (straight line)". Empty when no filter was sent.'}, 'neighbourhood': {'type': ['string', 'null'], 'description': 'Neighbourhood-level location only; the exact address is shared after booking.'}, 'property_type': {'type': ['string', 'null']}, 'similar_units': {'type': 'object', 'required': ['count', 'note', 'property_ids'], 'properties': {'note': {'type': 'string'}, 'count': {'type': 'integer'}, 'property_ids': {'type': 'array', 'items': {'type': 'integer'}}}, 'description': 'Only present when interchangeable units of this type exist; any of these ids can be quoted and booked.'}, 'top_amenities': {'type': 'array', 'items': {'type': 'string'}}, 'distance_miles': {'type': 'number', 'description': 'Only on a landmark or area search: how far this home is from it, in miles, rounded to the nearest 0.5 (0.5 means under 0.5 mile), as a straight line over the ground, not a driving or walking route.'}, 'review_sources': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Which platforms those reviews came from.'}, 'data_checked_at': {'type': 'string', 'description': "When this home's availability and price were fetched, ISO 8601. Only present on a row whose stay was priced."}, 'from_price_note': {'type': 'string', 'description': 'Deprecated, no longer returned along with from_price_per_night.'}, 'bathroom_sharing': {'enum': ['private', 'shared', 'unknown'], 'type': 'string', 'description': 'Whether the guest has a private bathroom or shares one. unknown means it is not recorded for this home.'}, 'accommodation_type': {'enum': ['entire_home', 'private_room', 'shared_room', 'unknown'], 'type': 'string', 'description': 'What the guest rents: an entire home, a private room in a shared building or a shared room. A private room or shared room is not an entire home. unknown means the type is not recorded for this home.'}, 'content_updated_at': {'type': 'string', 'description': "When the property manager's record of this home last changed, ISO 8601, as the provider states it. Omitted when the provider gives no such time."}, 'stay_total_display': {'type': 'string'}, 'availability_status': {'enum': ['available', 'not_checked'], 'type': 'string', 'description': 'available: confirmed available for the requested dates when this answer was produced. not_checked: no dates were given, so availability was not checked.'}, 'from_price_per_night': {'type': ['number', 'null'], 'description': 'Deprecated, no longer returned: only a row with a confirmed stay_total carries a price. Kept in this schema so existing clients still validate.'}, 'avg_per_night_display': {'type': 'string'}, 'missing_or_unverified': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Facts about this home that could not be verified, drawn from: pet policy, amenities, accommodation type.'}}}}, 'next_cursor': {'type': ['string', 'null'], 'description': 'The value to send as cursor, with every other input unchanged, to get the next page. Null when has_more is false.'}, 'completeness': {'enum': ['complete', 'partial'], 'type': 'string', 'description': 'complete: no matching home is unpriced, and none was left out for an unknown pet policy, accommodation type, amenity data, starting rate or position. partial: at least one is, so the results may omit a home that matches.'}, 'search_scope': {'type': 'object', 'required': ['place', 'type'], 'properties': {'type': {'enum': ['all_homes', 'metro', 'state', 'city', 'nearby_or_text', 'landmark', 'area'], 'type': 'string', 'description': 'metro: the metro area around the named city, within radius_miles. state: the whole state. city: homes in the named city. nearby_or_text: homes near the place or whose listing text matches it. landmark: homes within radius_miles of a named landmark, nearest first, by straight-line distance. area: the same, measured from the centre of a named area such as the South Loop.'}, 'place': {'type': ['string', 'null'], 'description': 'The place searched; null when no place was given and every home was searched.'}, 'radius_miles': {'type': 'number', 'description': 'How far from its centre or point homes are included; given for a metro, landmark or area.'}}, 'description': 'The place actually searched and how it was read.'}, 'dates_checked': {'type': 'boolean', 'description': 'False means availability is unknown and no stay has been priced; no row carries a stay_total.'}, 'budget_applied': {'type': 'object', 'required': ['scope', 'amount', 'currency', 'compared_to', 'includes_fees_and_taxes', 'note'], 'properties': {'note': {'type': 'string'}, 'scope': {'enum': ['total', 'nightly'], 'type': 'string'}, 'amount': {'type': 'number'}, 'currency': {'type': 'string'}, 'compared_to': {'enum': ['stay_total', 'from_price_per_night'], 'type': 'string', 'description': 'stay_total includes cleaning, fees and taxes; from_price_per_night is a starting nightly rate that excludes them.'}, 'homes_not_checked': {'type': 'integer', 'description': 'Matching homes the budget could not be checked against: unpriced for a total budget, no starting rate for a nightly one.'}, 'includes_fees_and_taxes': {'type': 'boolean'}}, 'description': 'Only returned when a budget was sent: what it was compared with.'}, 'total_matching': {'type': 'integer', 'description': 'How many individual homes matched, counting every interchangeable unit.'}, 'distance_unknown': {'type': 'integer', 'description': 'Only on a landmark or area search: otherwise matching homes left out because no position is recorded for them, so their distance is unknown. They are not confirmed to be outside the radius.'}, 'unpriced_in_time': {'type': 'integer', 'description': 'Matching homes whose availability was not established for these dates, because their pet policy could not be verified, a quote failed, the request ran out of budget, or it did not reach them. They are unknown, not unavailable. `price_all_matches`, a higher `limit`, or a narrower place establishes more of them. These counts cover the whole search, not one page, and the homes they count are not part of any page. A later page quotes more homes, so the count can fall.'}, 'amenities_unknown': {'type': 'integer', 'description': 'Otherwise matching homes left out of an amenities_required search because no amenity data is available for them. They are not confirmed to lack the amenity. 0 when the filter was not sent.'}, 'availability_note': {'type': 'string'}, 'budget_unverified': {'type': 'integer', 'description': 'Otherwise matching homes left out of a nightly budget search because no starting nightly rate is on record. 0 when the budget was not sent or was a total budget.'}, 'searched_location': {'type': ['string', 'null']}, 'pet_policy_unknown': {'type': 'integer', 'description': 'Otherwise matching homes omitted from a pet-friendly search because their pet policy is unknown, not confirmed to prohibit pets. Applies with or without dates; included in unpriced_in_time when dated. A positive count means the pet-friendly inventory is incomplete.'}, 'total_matching_groups': {'type': 'integer', 'description': 'How many distinct unit types matched.'}, 'unpriced_property_ids': {'type': 'array', 'items': {'type': 'integer'}, 'maxItems': 30, 'description': 'The property_id of up to 30 of the homes counted in unpriced_in_time; each can be priced individually with a live quote. Homes whose quote failed or timed out come first, then homes the request did not reach. A home listed here is unknown, not unavailable.'}, 'accommodation_type_unknown': {'type': 'integer', 'description': 'Otherwise matching homes left out of an accommodation_type search because no type is recorded for them. They are not confirmed to be another type. 0 when the filter was not sent.'}, 'budget_unverified_property_ids': {'type': 'array', 'items': {'type': 'integer'}, 'maxItems': 30, 'description': 'The property_id of up to 30 of the homes counted in budget_unverified; each can be priced for specific dates with a live quote.'}}}
Ajouté
get_booking_link
5 October 2026 02:43
Modifié
compare_properties
5 October 2026 02:43
Modifié
get_live_quote
5 October 2026 02:43
Modifié
get_property_details
5 October 2026 02:43
Modifié
search_properties
5 October 2026 02:43
Modifié
compare_properties
3 October 2026 02:50
Modifié
get_property_details
3 October 2026 02:50
Modifié
list_markets
3 October 2026 02:50
Modifié
search_properties
3 October 2026 02:50
Modifié
compare_properties
29 September 2026 02:50
Modifié
get_live_quote
29 September 2026 02:50
Modifié
search_properties
29 September 2026 02:50
Modifié
compare_properties
27 September 2026 02:42
Modifié
get_live_quote
27 September 2026 02:42
Modifié
get_availability
27 September 2026 02:42
Modifié
get_property_details
27 September 2026 02:42
Modifié
list_markets
27 September 2026 02:42
Modifié
search_properties
27 September 2026 02:42
Modifié
compare_properties
25 September 2026 02:49
Modifié
get_property_details
25 September 2026 02:49
Modifié
list_markets
25 September 2026 02:49
Modifié
search_properties
25 September 2026 02:49
Ajouté
compare_properties
23 September 2026 02:41
Modifié
get_live_quote
23 September 2026 02:41
Modifié
get_availability
23 September 2026 02:41
Modifié
get_property_details
23 September 2026 02:41
Modifié
list_markets
23 September 2026 02:41
Modifié
search_properties
23 September 2026 02:41
Ajouté
get_live_quote
19 September 2026 02:40
Ajouté
get_availability
19 September 2026 02:40