RegionSearch

The Availability Search operation determines availability in each region or specific hotel(s) for the dates and occupancy passed. It returns a list of matching hotels, room options, and prices together with a Quote Id for each hotel room. The Quote Id should then be passed to the BookingPrepare operation to move forwards with the booking.

Availability response times can vary between 3 – 20 seconds depending on the search criteria you have selected. Please discuss with our integrations team if you have any specific requirements for availability response time that are not being met.

Specifying search Target

You can target your search at either:

  • One Region Id
  • Single or multiple Hotel Ids

Depending on the availability search endpoint used, when both Region ID and Hotel ID are provided the request for the specified endpoint takes precedence, allowing the search to execute correctly.
 
Example: If the endpoint is RegionSearch and both Region ID and Hotel ID are provided, the Region ID will be used, and the Hotel ID will be ignored.

Request Schema

Request Header

POST            /RegionSearch
Content-Type:    “application/json”
AuthApiKey:      <Your API Key>
Accept-Encoding: “gzip,br”

Request Body Schema

Field Name Data Type Description

Nationality 

String

The nationality of the customer, The two-letter nationality code of the customer.

Timeout (optional)

Integer

Timeout value, in seconds (e.g., 20 seconds).

RegionId

Integer

The ID of the region where the hotel or property is located (e.g., 18870).

ArrivalDate

String (Date)

The date of the first night of the stay (e.g., “2025-11-22”).

Nights

Integer

The duration of the stay as a number of nights

Rooms

Array

A list of rooms with their occupancy details.

Adult

Integer

The number of adults in the room (e.g., 1). 

Child

Array

A list of children in the room.

Age

Integer

The age of the child (e.g., 3). 

Response Body Schema

Field Name Data Type Description

Currency

String

The currency code for prices (e.g., “EUR”). All rates will be displayed in the default currency associated with your Stuba account 

HotelAvailability

Array

List of available hotels and their quotes. 

Hotel

Object

Information about the hotel.

Id

Integer

Unique identifier for the hotel.

Name

String

Name of the hotel.

Result

Array of Object

List of different quote options for the hotel. 

QuoteId

String

Unique identifier for each quote. This ID is used to complete a booking. 

Rooms

Array of Object

List of rooms available under this quote. 

RoomType

Object

Information about the type of room.

Code

String

Room type code.

Text

String

Description of the room type.

MealType

Object

Information about the meal plan. 

Code

String

Meal type code.

Text

String

Description of the meal type (e.g., “Room only”, “Breakfast”).

Price

Float

Price for the room for the specified stay. 

CancellationPolicyStatus

String

Status of cancellation policy (e.g., “Refundable“, “Nonrefundable”, “Unknown”).  

Please refer to BookingPrepare response for the complete cancellation policy.

Cancelpolicyfrom

Date

Date from which cancellation policy applies. (YYYY-MM-DD)

HAPI Response Samples

Samples

Copy
{ "Nationality": "GB", "Timeout": 30, "RegionId": {{RegionId}}, "ArrivalDate": "{{arrivaldate}}", "Nights": 1, "Rooms": [ { "Adult": 2 } ] }
{ "currency": "USD", "hotelAvailability": [ { "hotel": { "id": 118173, "name": "Quality Suites" }, "results": [ { "quoteId": "1090225884-0", "rooms": [ { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 104.62, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225884-1", "rooms": [ { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 116.17, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225884-2", "rooms": [ { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 104.62, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225884-3", "rooms": [ { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 116.17, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225884-4", "rooms": [ { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 113.57, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225884-5", "rooms": [ { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 126.15, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] } ] } ] }
Copy
{ "Nationality": "GB", "Timeout": 30, "RegionId": {{RegionId}}, "ArrivalDate": "{{arrivaldate}}", "Nights": 1, "Rooms": [ { "Adult": 2, "Child": [ { "Age": 7 } ] } ] }
{ "currency": "USD", "hotelAvailability": [ { "hotel": { "id": 118173, "name": "Quality Suites" }, "results": [ { "quoteId": "1090225882-0", "rooms": [ { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 104.62, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225882-1", "rooms": [ { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 116.17, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225882-2", "rooms": [ { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 104.62, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225882-3", "rooms": [ { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 116.17, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225882-4", "rooms": [ { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 113.57, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225882-5", "rooms": [ { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 126.15, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] } ] } ] }
Copy
{ "Nationality": "GB", "Timeout": 30, "RegionId": {{RegionId}}, "ArrivalDate": "{{arrivaldate}}", "Nights": 2, "Rooms": [ { "Adult": 2 }, { "Adult": 2 } ] }
{ "currency": "USD", "hotelAvailability": [ { "hotel": { "id": 118173, "name": "Quality Suites" }, "results": [ { "quoteId": "1090225886-0", "rooms": [ { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225886-1", "rooms": [ { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 232.34, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225886-2", "rooms": [ { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225886-3", "rooms": [ { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 232.34, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225886-4", "rooms": [ { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 227.14, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 227.14, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225886-5", "rooms": [ { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 252.30, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 227.14, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] } ] } ] }
Copy
{ "Nationality": "GB", "Timeout": 30, "RegionId": {{RegionId}}, "ArrivalDate": "{{arrivaldate}}", "Nights": 2, "Rooms": [ { "Adult": 2, "Child": [ { "Age": 5 } ] }, { "Adult": 2, "Child": [ { "Age": 9 } ] } ] }
{ "currency": "USD", "hotelAvailability": [ { "hotel": { "id": 118173, "name": "Quality Suites" }, "results": [ { "quoteId": "1090225890-0", "rooms": [ { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225890-1", "rooms": [ { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 232.34, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "97555203", "text": "2 Queen Beds, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225890-2", "rooms": [ { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225890-3", "rooms": [ { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 232.34, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "145976170", "text": "1 King Bed, Junior Studio, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 209.24, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225890-4", "rooms": [ { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 227.14, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 227.14, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] }, { "quoteId": "1090225890-5", "rooms": [ { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 252.30, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" }, { "roomType": { "code": "102457300", "text": "1 King Bed, Suite, Nonsmoking" }, "mealType": { "code": "1", "text": "Breakfast" }, "price": 227.14, "cancellationPolicyStatus": "Refundable", "cancelPolicyFrom": "2025-11-20" } ] } ] } ] }