Get Started
Search Use Cases
Booking Use Cases
Reservation Modification Use Cases
API Documentation
Webhooks
API Reference
Changelog
Hotel Search
Returns hotel search results
curl --request POST \
--url https://sandbox.travel.selfbook.com/rest/v1/hotel/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"stay_info": {
"check_in_date": "2024-11-20",
"check_out_date": "2024-11-21",
"guests": {
"adults": 1
}
},
"filter": {
"location": {
"type": "iata_code",
"details": {
"iata_code": "ORD"
},
"radius": {
"value": 5,
"type": "mi"
}
}
}
}'{
"pagination": {
"page_number": 1,
"page_size": 25,
"total_pages": 3,
"total_items": 63,
"pagination_token": "103f701e-39ad-4453-a375-2a9510b4d1c3"
},
"currency_exchange_rates": [
{
"conversion_factor": 1.1037528,
"source_currency": "EUR",
"target_currency": "USD"
}
],
"results": [
{
"chain_code": "HI",
"property_code": "E8597",
"name": "HOLIDAY INN EXP STES DTWN OLD MARKE",
"address": {
"street": "2431 FARNAM STREET",
"city": "OMAHA",
"state_provience": "NE",
"country_code": "US",
"postal_code": 68131
},
"geolocation": {
"latitude": 41.2573,
"longitude": -95.9484
},
"availability": true,
"phone": 14025093451,
"fax": 14025093461,
"ada_compliant": true,
"check_in_time_local": "15:00",
"check_out_time_local": "11:00",
"lowest_rate": {
"total_price": 122.89,
"base_price": 104,
"total_taxes": 18.89,
"currency_code": "USD"
},
"rating": {
"value": 2,
"provider": "NTM"
},
"michelin_keys_rating": "<string>",
"forbes_travel_guide_rating": "<string>",
"hotel_network_affiliation": "<string>",
"images": [
{
"url": "https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg",
"caption": "Hotel Exterior",
"size": "Medium",
"category": 1
}
],
"amenities": [
{
"description": "Ice machine",
"code": 52,
"category": "Bar / Lounge"
}
],
"rooms": [
{
"short_description": "2 Queen Bed(s) Standard Room",
"room_type_ota_code": 82,
"bed_types": [
{
"bed_type": "Queen Bed(s)",
"quantity": 2,
"size": "160 cm X 200 cm"
}
],
"room_amenities": [
{
"description": "Non-smoking",
"code": 74
}
],
"max_occupancy": 5,
"room_characteristics": {
"category": {
"description": "Room",
"code": 42
},
"class": {
"description": "Standard",
"code": 82
},
"view": {
"description": "City views",
"code": 3
},
"other_features": [
"Walk In Shower"
]
},
"room_images": [
{
"url": "https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg",
"caption": "Hotel Exterior",
"size": "Medium",
"category": 1
}
],
"rates": [
{
"booking_code": "2QN57JU",
"channel_code": "SBT1",
"rate_type": "best_available_rate",
"rate_description": "Best Flexible Rate",
"room_description": "2 Queen Standard 450 Square Feet Standard With Microwave And Minifridge",
"price": {
"total_price": 164.24,
"base_price": 139,
"total_taxes": 25.24,
"currency_code": "USD"
},
"terms": {
"description": [
"Prepay in full, King room"
],
"rate_payment_info": "PrePay",
"guarantee_type": "DepositRequired",
"refundable": true,
"cancel_note": "",
"cancel_penalties": {
"deadline_local": "2024-09-17T00:00:00-05:00",
"cancel_short_description": "An estimated cancellation fee of 177.44 USD applies starting from 2024-09-17T00:00-05:00[America/Chicago].",
"penalty": {
"estimated_amount": true,
"currency_amount": {
"amount": 177.44,
"currency": "USD"
},
"original_penalty_info": "100%"
}
}
},
"included_perks": {
"Complimentary Wi-Fi": "Complimentary Wi-Fi",
"Complimentary breakfast": "Daily breakfast included"
},
"expiration": "2024-05-20T00:00:00Z"
}
]
}
]
}
],
"missing_tripadvisor_ids": [
"555doesnotexist"
]
}Authorizations
Basic authentication where:
- user-id is a partner account ID
- user-password is an API key token associated with the partner account
Body
Parameters related to stay duration and guest count
Parameters related to filtering by location or hotel information
Location filtering parameters
Location filter type. Either 'iata_code' or 'coordinates'
iata_code, coordinates "iata_code"
Detail paramters related to location filter type
City or airport iata code for location based search. Note - only used when location type is set to iata_code.
"ORD"
Latitude value used for gps point of location based search. Note - only used when location type is set to coordinates.
40.7580033
Longitude value used for gps point of location based search. Note - only used when location type is set to coordinates.
-73.9868562
Search by a specific hotel chain and property code. A name can be included for additional filtering.
Return hotel data even if there is no availability. NOTE - no rates will be returned if this is true.
false
A TripAdvisor ID string
["248749"]
Response
Current page number
1
Number of items per page
25
Total number of pages returned for search query
3
Total number of items available for search query
63
Token used to retrieve paginated search results. It's a UUID, so it's unique to each query.
"103f701e-39ad-4453-a375-2a9510b4d1c3"
Conversion rate used to calculate conversion to USD. Conversions should always be treated as estimates.
1.1037528
ISO 4217 currency code of source rates. Source rates are those returned in the search results, e.g. the rate in the hotel's local currency.
"EUR"
ISO 4217 currency code of target rate. Always USD.
"USD"
Hotel chain code identifier
"HI"
Hotel property code identifier
"E8597"
Hotel name
"HOLIDAY INN EXP STES DTWN OLD MARKE"
Property address object
Street address
"2431 FARNAM STREET"
City
"OMAHA"
State or Provience
"NE"
Country code
"US"
Postal code
68131
Does the hotel have availability based on the search query?
true
Phone number
14025093451
Fax number
14025093461
Is this property ADA compliant?
true
Local check in time (24h format)
"15:00"
Local check out time (24h format)
"11:00"
Michelin Keys rating value
Forbes Travel Guide rating value
Hotel network affiliation value
Hotel images data
Hotel image item
Image URL
"https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg"
Image caption
"Hotel Exterior"
Image size
"Medium"
Image category identifier
1
Hotel rooms data
Hotel room information
Short room description
"2 Queen Bed(s) Standard Room"
Room type OTA code
82
Maximum room occupancy
5
Hotel room characteristics
Hotel room other features characteristic
Other features items
Hotel room images data
Hotel room image item
Image URL
"https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg"
Image caption
"Hotel Exterior"
Image size
"Medium"
Image category identifier
1
Hotel room rate data
Room rate information
Booking code for room rate
"2QN57JU"
Channel code for room rate
"SBT1"
Rate type identifier. Currently can be best_available_rate, restricted_rate, or private_access_rate
"best_available_rate"
Rate description
"Best Flexible Rate"
Room description
"2 Queen Standard 450 Square Feet Standard With Microwave And Minifridge"
Price information for room rate
Rate and payment terms
Rate terms description
Rate terms strings
Type of rate payment (usually PrePay or PostPay)
"PrePay"
Type of guarantee required
"DepositRequired"
Is the rate refundable?
Note left if cancel penalties are unavailable
""
Penalties for cancellation
Included perks for room rate
{
"Complimentary Wi-Fi": "Complimentary Wi-Fi",
"Complimentary breakfast": "Daily breakfast included"
}
ISO 8601.
"2024-05-20T00:00:00Z"
TripAdvisor ids that were not able to be mapped to known hotel chain and property codes. Only shows if tripadvisor_ids are included in the request.
curl --request POST \
--url https://sandbox.travel.selfbook.com/rest/v1/hotel/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"stay_info": {
"check_in_date": "2024-11-20",
"check_out_date": "2024-11-21",
"guests": {
"adults": 1
}
},
"filter": {
"location": {
"type": "iata_code",
"details": {
"iata_code": "ORD"
},
"radius": {
"value": 5,
"type": "mi"
}
}
}
}'{
"pagination": {
"page_number": 1,
"page_size": 25,
"total_pages": 3,
"total_items": 63,
"pagination_token": "103f701e-39ad-4453-a375-2a9510b4d1c3"
},
"currency_exchange_rates": [
{
"conversion_factor": 1.1037528,
"source_currency": "EUR",
"target_currency": "USD"
}
],
"results": [
{
"chain_code": "HI",
"property_code": "E8597",
"name": "HOLIDAY INN EXP STES DTWN OLD MARKE",
"address": {
"street": "2431 FARNAM STREET",
"city": "OMAHA",
"state_provience": "NE",
"country_code": "US",
"postal_code": 68131
},
"geolocation": {
"latitude": 41.2573,
"longitude": -95.9484
},
"availability": true,
"phone": 14025093451,
"fax": 14025093461,
"ada_compliant": true,
"check_in_time_local": "15:00",
"check_out_time_local": "11:00",
"lowest_rate": {
"total_price": 122.89,
"base_price": 104,
"total_taxes": 18.89,
"currency_code": "USD"
},
"rating": {
"value": 2,
"provider": "NTM"
},
"michelin_keys_rating": "<string>",
"forbes_travel_guide_rating": "<string>",
"hotel_network_affiliation": "<string>",
"images": [
{
"url": "https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg",
"caption": "Hotel Exterior",
"size": "Medium",
"category": 1
}
],
"amenities": [
{
"description": "Ice machine",
"code": 52,
"category": "Bar / Lounge"
}
],
"rooms": [
{
"short_description": "2 Queen Bed(s) Standard Room",
"room_type_ota_code": 82,
"bed_types": [
{
"bed_type": "Queen Bed(s)",
"quantity": 2,
"size": "160 cm X 200 cm"
}
],
"room_amenities": [
{
"description": "Non-smoking",
"code": 74
}
],
"max_occupancy": 5,
"room_characteristics": {
"category": {
"description": "Room",
"code": 42
},
"class": {
"description": "Standard",
"code": 82
},
"view": {
"description": "City views",
"code": 3
},
"other_features": [
"Walk In Shower"
]
},
"room_images": [
{
"url": "https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg",
"caption": "Hotel Exterior",
"size": "Medium",
"category": 1
}
],
"rates": [
{
"booking_code": "2QN57JU",
"channel_code": "SBT1",
"rate_type": "best_available_rate",
"rate_description": "Best Flexible Rate",
"room_description": "2 Queen Standard 450 Square Feet Standard With Microwave And Minifridge",
"price": {
"total_price": 164.24,
"base_price": 139,
"total_taxes": 25.24,
"currency_code": "USD"
},
"terms": {
"description": [
"Prepay in full, King room"
],
"rate_payment_info": "PrePay",
"guarantee_type": "DepositRequired",
"refundable": true,
"cancel_note": "",
"cancel_penalties": {
"deadline_local": "2024-09-17T00:00:00-05:00",
"cancel_short_description": "An estimated cancellation fee of 177.44 USD applies starting from 2024-09-17T00:00-05:00[America/Chicago].",
"penalty": {
"estimated_amount": true,
"currency_amount": {
"amount": 177.44,
"currency": "USD"
},
"original_penalty_info": "100%"
}
}
},
"included_perks": {
"Complimentary Wi-Fi": "Complimentary Wi-Fi",
"Complimentary breakfast": "Daily breakfast included"
},
"expiration": "2024-05-20T00:00:00Z"
}
]
}
]
}
],
"missing_tripadvisor_ids": [
"555doesnotexist"
]
}