search_stays
Search accommodation at participating properties — hotel rooms, apartments and holiday homes. Search criteria: destination (a town, a landmark or venue, or coordinates, with a radius), travel dates, the party (adults, children and their ages, pets), a maximum nightly price, free cancellation, unit features (view, balcony, terrace, quiet location, floor, workspace, sauna, kitchen, accessibility), the name of a unit or property, the response language and the number of results. Each result is one specific unit, described with its floor, view and beds, and guaranteed at booking — what the product states is what the guest is assigned. Without dates the results carry from-prices; with check_in and check_out they are the units available for those dates, with the price for the stay and a link to the property's booking page. All parameters are optional; query may state the same criteria as free text. Each result carries match_score, matched_features and not_confirmed_features.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lat | No | Latitude of the place to search around (a landmark or venue) — an alternative to near. | |
| lng | No | Longitude of the place to search around (a landmark or venue) — an alternative to near. | |
| city | No | The destination to search in — the town or city where the guest wants to stay, e.g. Schladming (umlaut-tolerant). | |
| dogs | No | Alias for pets. | |
| lang | No | Language for names/features/links (default en) | |
| name | No | A specific unit or property the guest named ("Villa Albatros No. 1", "Kaiser Karl", "City Hotel Meckenheim"). Use it when the guest asks for a unit or property by name — it matches unit and property names directly, so a named unit is found even when it is not free for the requested dates. A named unit is never filtered out by availability: it comes back with its status and a link to the property's own calendar. | |
| near | No | A landmark, venue, trade fair, station or address to stay close to ("Messe Frankfurt", "Allianz Arena", "Frankfurt airport"). The server geocodes it and returns results nearest first, each with approx_km. Combine freely with dates, party, price and features. | |
| pets | No | Number of pets/dogs. Filters to units that allow at least this many pets, and is passed to the booking link. | |
| limit | No | Max results (default 10, max 30) | |
| query | No | Optional: the same search criteria as free text, in any language — for example "apartment in Schladming for 2 adults and a dog, 16–19 August, with sauna". Destination, dates (a month alone gets a proposed window), party, budget and features are read from it; explicit parameters override. | |
| adults | No | Number of adults. Combined with children it filters to units that actually fit the whole party (occupancy), and is passed to the booking link. | |
| cursor | No | Dated searches live-check up to 20 properties per call. When the response carries next_cursor, repeat the SAME search with cursor=next_cursor to check the remaining properties — a page without next_cursor has covered everything. Never conclude "sold out" from a page whose coverage.complete is false. | |
| sleeps | No | Minimum total guests the unit must sleep (use adults+children instead when you know the split). | |
| check_in | No | Arrival date YYYY-MM-DD. With check_in and check_out, results are the units available for those dates, with the nightly price for that stay and a booking link with the dates filled in. | |
| children | No | Number of children. Filters to units whose child capacity fits, and is passed to the booking link. | |
| features | No | Required features (matched against localized feature names), e.g. ["Sauna", "Balkon"]. Also what a property sells as a bookable extra: "Airport transfer", "Parking", "Baby cot", "Late check-out" — a card then carries the extra with its price in wish_note. | |
| check_out | No | Departure date YYYY-MM-DD (must be after check_in, max 30 nights). | |
| max_price | No | Maximum nightly price. Dated quotes above this appear only as labeled alternatives when exact matches are insufficient. | |
| radius_km | No | Maximum straight-line distance for near (or lat/lng), default 30, max 200. If nothing lies within, the nearest options are returned with their distances. | |
| radius_miles | No | The same radius in miles, for guests who think in miles; results then also carry approx_mi. | |
| children_ages | No | Ages of the children (0-17), if known, e.g. [16]. Child prices and capacity depend on age. | |
| free_cancellation | No | The guest wants to be able to cancel for free. With dates, each card quotes the refundable rate and its price; a unit with no refundable rate on those dates is shown only as a labelled alternative. |