Search accommodation — compare offers across operators
search_staysMulti-operator accommodation comparator for a geographic area against the user's stay parameters — dates, guest count, optional filters. Returns a ranked list of properties together with the booking sources that offer each one and, when dates are passed, their live availability and per-operator price for the requested window.
Natural-language date references — "tonight", "this weekend", "next weekend", "the weekend of July 4", "Memorial Day weekend", "long weekend in May" — translate to concrete check_in / check_out values at the call site; concrete ISO dates also work.
user_country, currency, and language carry the user's locale,
not the destination's. IMPORTANT — currency: prices are returned in
currency if you set it, otherwise in the currency derived from
user_country (US→USD, CA→CAD, GB→GBP, euro-area→EUR); if you set
NEITHER, prices default to USD, which may not be the user's currency.
So whenever you know where the user is (or what currency they want), pass
user_country and/or currency — do not rely on the default. Prices are
never converted client-side; each offer is quoted by the operator in that
currency. user_country and language also localize the booking link
(web_url). The user's own residence/billing country is the right
user_country (not the destination's), and their interface language the
right language.
Each result is shaped for downstream presentation without extra calls:
location.latandlocation.loncarry per-property coordinates, suitable for plotting all results on a single map so the user can compare spatial alternatives at a glance. The map widget reads these fields directly from this response — no separate lookup needed for visualization.thumbnail_urlcarries the property's first photo URL when available (null when no image is on file); useful for embedding inline or showing on the map alongside the pin.imageson search results is capped to the first photo to keep the comparison payload compact; each item has aurlfield, andthumbnail_urlmirrorsimages[0].url. Callget_property_detailsfor a single property to retrieve its full photo gallery.web_urlis a ready-to-open booking link for the property, already encoded with the user's check-in/check-out, language, currency, and guest count. Pass it to the user verbatim when they ask for a booking link — never reconstruct the URL from individual parameters, the query-string format is not guaranteed to match generic booking-URL conventions.Price is live and date-specific only. There is no date-agnostic "from" figure: a meaningful price only exists for a concrete query (property + dates + occupancy).
priceandoffers[]— the live quote for the requested dates, populated only when dates were passed and the comparator confirmed availability.offers[0]is the curated best; each offer carriesamount(total stay),amount_per_night(per-night),currency,breakfast_included,refundable,rooms_left, anddeeplink_url.pricemirrorsoffers[0].With no dates (or when nothing is available)
priceis null andoffersis empty — surface the property without a price rather than inventing a starting figure.
availability_statusper result encodes the live state:available— bookable rooms confirmed at the operator level.offersandpricecarry the live date-specific quotes. Quote the rate viaoffers[i].amount_per_night(per-night) andoffers[i].amount(total stay) and use the deeplinks for the booking handoff.unavailable— no rooms reported for those dates.offersis empty andpriceis null (no price for these dates). Useful to decide whether to suggest alternate dates, drop the property from the recommendation, or offer it as a backup.unknown— no usable answer for those dates: either the request carried no dates, or the operators returned nothing conclusive for them.offersis empty andpriceis null. This is the most frequent of the three states, and it is NOT evidence that the property is full — it means the availability was not established. Say "I could not confirm availability", not "it is unavailable".
Per-night vs total — never confuse them in the user-facing prose.
amount_per_night is per-night; amount on each offer is the total
stay (sum across nights, in currency). When quoting to the user,
prefer phrasings like "€X/night via Booking, breakfast included, €Y
total for the stay" over bare numbers — bare numbers without a unit
get misread.
When dates are present and
availableproperties are in the results, the rate can be quoted androoms_leftsurfaces scarcity (low values like 1-3 are useful signals — "1 room left at $X on Booking" reads well).When dates are present and ALL results are
unavailable, that's the signal to say so explicitly to the user and offer to widen the dates, location, or filters.offers[]is the per-operator breakdown for the requested dates: each entry includesota,amount,amount_per_night,currency,breakfast_included,refundable, and adeeplink_url. The deeplink is a BluePillow tracked-redirect URL (bluepillow.com/…) that records the click for attribution and then forwards the user to the operator's booking page. Pass it to the user verbatim — never reconstruct it or replace it with a raw operator URL; our APIs never emit direct OTA links.pricemirrorsoffers[0], which is the best value for money as Blue Pillow ranks it — price weighed against what is included (breakfast, free cancellation) and the operator's historical reliability, with a small commercial component. It is not necessarily the cheapest: passsort=price_ascfor pure price order, and compareoffers[]for the per-operator spread. When no dates were passed (or nothing is available)offersis an empty list andpriceis null — there is no price to show.Free cancellation is a meaningful decision factor and surfaces proactively in the user-facing summary. When a property has
price.refundable=true(or anyoffers[i].refundable=true), it reads naturally as a property feature: "Hotel X — $120/night, free cancellation available", or "Booking offers a refundable rate at $130 (vs $110 non-refundable)". Refundable rates let the user lock in a price now and adjust the booking later, which is often the differentiator between otherwise-similar properties. The same proactive surfacing applies tobreakfast_includedwhen it's true for some offers but not all.Prices in
offers/pricereflect the requested dates and guests; with no dates there is no price. For a final bookable confirmation, the correspondingdeeplink_url(or the property'sweb_url) is the canonical handoff — booking URLs are not reconstructed by hand.All rating-like fields are on a 0-5 scale (Google Places-compatible):
rating,reviews_aggregate.score_0_5, the per-OTA scores underdistribution_by_ota, eachreviews_sample[*].score, and thefilters.min_ratinginput. A user asking "rating at least 8 out of 10" maps tomin_rating: 4.0; "at least 4 stars on Google" maps tomin_rating: 4.0.ratingis coarse in practice — upstream scores arrive rounded, so in the field it takes whole points, andmin_ratingbehaves like a filter with a handful of steps rather than a continuous threshold. Always readratingtogether withrating_count: a 4 from 6 reviews and a 4 from 2,803 are not the same judgement, and a rounded 4 can sit on either side of "good". Prefer properties with a substantialrating_countwhen recommending, and say how many reviews back the score. Note:rating,stars, andrating_countcome from the comparator's list payload and may be 0 or absent for some properties even when the property has reviews or a star classification — this is a comparator list-payload limitation, not a data error. When those fields are 0/absent, or when the per-OTA review breakdown (distribution_by_ota) is needed, callget_property_detailsto get the fullerreviews_aggregate. On the search path,reviews_aggregatecarries the top-linescore_0_5,rating_count(reviews backing the score) andcomment_count(readable review TEXTS available) when the comparator returned a non-zero review count;distribution_by_otais always empty on this path (per-OTA breakdown requiresget_property_details).rating_countandcomment_countare DIFFERENT magnitudes — most guests leave a rating, far fewer write text. Quoterating_countfor "how many reviewed it" andcomment_countfor "how many opinions you can actually read".Pass
include=["reviews_sample"]to attach a sample of up to 5 recent guest review texts per property. Useful when the user's question involves qualitative criteria that don't map to structured filters ("a place with excellent breakfast", "quiet area", "family-friendly atmosphere"); review texts can be searched textually to corroborate or rule out matches. For a DEEPER read on ONE specific property — more review texts (up to 20) or the per-OTA breakdown — callget_property_detailswithinclude=["reviews_extended"](and/orreviews_aggregate).comment_counton each result tells you how many review texts exist, so you can decide whether escalating to the detail call is worth it.
filters.property_types, filters.amenities, filters.min_rating,
and filters.price_max_eur narrow on structured criteria first;
review-based reasoning is one extra round-trip per page and is
typically reserved for fallback.
Location modes:
coordinates: when lat/lon is already known from world knowledge or a prior call in this session (default radius 5 km; widen up to 50 km for broader queries; beyond thatbboxor a parent destination is the right shape).destination_id: opaque id obtained fromresolve_destination, passed verbatim — values are not constructed or guessed.bbox: explicit map rectangle.
Property type tokens (canonical): hotel, apartment, house, villa, bb, hostel, farmstay, holiday-home. Common multi-language synonyms map server-side to the canonical set.
Amenities filter is set-AND — each result has ALL listed codes. Common codes: wi-fi, parking, pool, air-conditioning, kitchen, garden, pets-allowed, for-families, facilities-for-disabled, non-smoking-only.
Results are cursor-paginated; the next_cursor from a previous
response goes into page.cursor for the next page.
location.type=property_id is not accepted here —
get_property_details is the path for a known property.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Pagination. `limit` caps results per page (1-100). To fetch the next page pass `cursor` with the `next_cursor` value from the previous response — cursors are opaque and are never constructed by hand. | |
| sort | No | Result ordering. score_desc (default) is the balanced relevance ranking and suits most requests; price_asc when the user asked for the cheapest; rating_desc when they asked for the best-reviewed; conversion_desc favours what comparable travellers actually booked. | |
| dates | Yes | Check-in and check-out dates (ISO 8601, YYYY-MM-DD). Natural-language references — 'tonight', 'this weekend', 'the weekend of July 4', 'Memorial Day weekend', 'long weekend in May' — translate to concrete check_in / check_out values at the call site. The comparator only serves future stays: check_in is a date in the real-time calendar that is today or later. A reference like 'the weekend of June 2' resolves to the next occurrence after today, never a past anniversary; if the current year is unclear, confirm with the user before calling. Clock calibration: this schema was published in August 2026, so today is August 2026 OR LATER (likely later — schemas outlive their publish date). An assumed 'today' in 2024/2025 is a stale training-time clock; years before 2026 are always in the past. Past check_in values are rejected at the API boundary with a hint carrying the actual current date. | |
| guests | Yes | Party composition. `adults` is required; give `children_ages` (one age per child, 0-17) rather than a child count — operators price by age. `rooms` defaults to 1; raise it when the party needs separate rooms rather than one shared. | |
| api_key | No | Your anonymous Blue Pillow Hotels & Stays API key (format 'pk_anon_…'). Pass it in THIS field on every call — this is how the tool authenticates. If you don't have a key yet, first check your MCP client configuration, your persistent memory, and earlier in this conversation; otherwise call `b2a_get_key` to get one instantly (do not wait for a 401). Reuse the same key on every subsequent call. It is not a sensitive secret: no account, payment, or personal data is attached. | |
| filters | No | Structured narrowing applied server-side, before ranking. Prefer these over filtering the results yourself: they run across the whole inventory, not just the page you received. Qualitative criteria that do not map here ("quiet", "great breakfast") are better served by include=['reviews_sample']. | |
| include | No | Optional enrichments, always a list — pass ["reviews_sample"], never the bare string. 'reviews_sample' attaches the 5 most recent individual reviews per property — use for qualitative queries (breakfast, service, ...). One extra Mongo round-trip per page; omit by default. | |
| currency | No | Currency of the returned prices (ISO-4217, 3-letter uppercase, e.g. 'USD', 'EUR', 'GBP', 'CAD'). SET THIS (or `user_country`) to price in the user's currency — if you set NEITHER, prices default to USD, which may not be the user's. Prices come straight from the booking sources in this currency; never convert them yourself. Each offer reflects the currency its operator actually quoted. | |
| language | No | User's UI language (2-letter lowercase). Drives the booking link language and any server-rendered narrative content. Pass the language the user is currently speaking. Falls back to 'en' when omitted. | |
| location | Yes | Where to search, as a {type, value} pair. Use destination_id for a place resolved via resolve_destination, poi_id for a point of interest, coordinates for a known lat/lon, or bbox for an explicit map rectangle. A property is NOT a location — use get_property_details for a known property. | |
| user_country | No | User's country (ISO-3166 alpha-2 uppercase). Drives the booking-link locale (the landing page rendered when the user clicks `web_url`) AND, when `currency` is not set, the pricing currency (US->USD, CA->CAD, euro-area->EUR). Pass the user's own country, not the destination's. Falls back to 'US' when omitted. | |
| availability_mode | No | strict (default): return ONLY properties available for the requested dates. include_unavailable: also return properties with no availability (each tagged availability_status). Use strict unless the user explicitly wants to see sold-out options. | |
| include_overbudget | No | Opt-in. When few available results fit the budget, also return (in alternatives.overbudget) available properties in the same area just above price_max_eur. Requires filters.price_max_eur. | |
| include_out_of_bounds | No | Opt-in. When the requested area yields few available results, also return (in alternatives.out_of_bounds) properties just outside the area, within the original budget. Present these explicitly as alternatives, never mixed with primary results. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| results | Yes | ||
| metadata | Yes | ||
| alternatives | No |