Search
A search is a set of search results from a given criteria. These search results can be found in its results property.
Schema
Search for accommodation
Returns all available accommodations that match your search criteria. You can search either by location or accommodation, but not both.
Each accommodation is returned with information on the cheapest available rate.
The room and rate information is not guaranteed to be complete or accurate on this endpoint and can vary across different accommodations. cheapest_rate_total_amount
will always be accurate.
Body parameters
POST https://api.duffel.com/stays/search
curl -X POST --compressed "https://api.duffel.com/stays/search" \-H "Accept-Encoding: gzip" \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Duffel-Version: v2" \-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \-d '{"data": {"rooms": 1,"location": {"radius": 5,"geographic_coordinates": {"longitude": -0.1416,"latitude": 51.5071}},"check_out_date": "2023-06-07","check_in_date": "2023-06-04"}}'
{"data": {"results": [{"rooms": 1,"id": "ssr_0000ASVBuJVLdmqtZDJ4ca","check_out_date": "2023-05-28","check_in_date": "2023-05-24","cheapest_rate_total_amount": "799.00","cheapest_rate_currency": "GBP","accommodation": {"supported_loyalty_programme": "duffel_hotel_group_rewards","rooms": [{"rates": [{"total_currency": "GBP","total_amount": "799.00","tax_currency": "GBP","tax_amount": "82.23","supported_loyalty_programme": "duffel_hotel_group_rewards","quantity_available": 12,"public_currency": "GBP","public_amount": "699.99","payment_type": "pay_now","id": "rat_0000BTVRuKZTavzrZDJ4cb","fee_currency": "GBP","fee_amount": "50.94","due_at_accommodation_currency": "GBP","due_at_accommodation_amount": "39.95","deal_types": ["closed_user_group","mobile"],"conditions": [{"title": "Parking","description": "Public parking is available nearby for £15 per day"}],"cancellation_timeline": [{"refund_amount": "799.00","currency": "GBP","before": "2023-05-23T13:00:00Z"}],"board_type": "room_only","base_currency": "GBP","base_amount": "665.83","available_payment_methods": [["balance","card"]]}],"photos": [{"url": "https://assets.duffel.com/img/stays/image.jpg"}],"name": "Double Suite","beds": [{"type": "king","count": 2}]}],"review_score": 8.8,"rating": 3,"photos": [{"url": "https://assets.duffel.com/img/stays/image.jpg"}],"phone_number": "+442074938181","name": "Duffel Test Hotel","location": {"geographic_coordinates": {"longitude": -0.1416,"latitude": 51.5071},"address": {"region": "England","postal_code": "EC2A 4TP","line_one": "100 Clifton Street","country_code": "GB","city_name": "London"}},"key_collection": {"instructions": "Please collect the keys from accommodation's reception."},"id": "acc_0000AWr2VsUNIF1Vl91xg0","email": "reservations@duffel-hotel-group.com","description": "Ornate quarters, some with grand pianos, in a luxurious hotel offering acclaimed dining & a spa.","check_in_information": {"check_out_before_time": "11:30","check_in_after_time": "14:30"},"chain": {"name": "Duffel Hotel Group"},"brand": {"name": "Duffel Test","id": "bra_0000Alr8BYNsbmDMThHSbI"},"amenities": [{"type": "parking","description": "Parking"}]}}],"created_at": "2022-12-20T15:21:01Z"}}