Get Started
Search Use Cases
Booking Use Cases
Reservation Modification Use Cases
API Documentation
Webhooks
API Reference
Changelog
API Reference
Hotel Search
Returns hotel search results
POST
/
rest
/
v1
/
hotel
/
search
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_providence": "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": "ExtraLarge",
"category": 1
}
],
"amenities": [
{
"description": "Ice machine",
"code": 52,
"category": "Bar / Lounge"
}
],
"rooms": [
{
"room_name": "Standard Room Garden Views with Balcony",
"room_name_with_beds": "Standard Room Garden Views with Balcony, One Double Bed, Two Single Beds",
"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": "ExtraLarge",
"category": "Room"
}
],
"rates": [
{
"booking_code": "2QN57JU",
"channel_code": "SBT1",
"rate_type": "flexible_rate",
"pcc": "KR5",
"rate_name": "Flexible Rate",
"room_name": "Standard Room Garden Views with Balcony",
"room_name_with_beds": "Standard Room Garden Views with Balcony, One Double Bed, Two Single Beds",
"price": {
"total_price": 164.24,
"base_price": 139,
"total_taxes": 25.24,
"additional_fees": 0,
"currency_code": "USD"
},
"terms": {
"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
application/json
Response
200
application/json
OK
The response is of type object
.
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_providence": "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": "ExtraLarge",
"category": 1
}
],
"amenities": [
{
"description": "Ice machine",
"code": 52,
"category": "Bar / Lounge"
}
],
"rooms": [
{
"room_name": "Standard Room Garden Views with Balcony",
"room_name_with_beds": "Standard Room Garden Views with Balcony, One Double Bed, Two Single Beds",
"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": "ExtraLarge",
"category": "Room"
}
],
"rates": [
{
"booking_code": "2QN57JU",
"channel_code": "SBT1",
"rate_type": "flexible_rate",
"pcc": "KR5",
"rate_name": "Flexible Rate",
"room_name": "Standard Room Garden Views with Balcony",
"room_name_with_beds": "Standard Room Garden Views with Balcony, One Double Bed, Two Single Beds",
"price": {
"total_price": 164.24,
"base_price": 139,
"total_taxes": 25.24,
"additional_fees": 0,
"currency_code": "USD"
},
"terms": {
"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"
]
}
Assistant
Responses are generated using AI and may contain mistakes.