Skip to navigation
Hotel APIHotels

Get rates

Retrieves detailed hotel room rate information for one hotel.

Use case

This endpoint can be used on a hotel rates page that allows users to view each of the room types/rates of a hotel. The response includes the lowest average room rate in the localized currency, accepted credit cards, promotional offers, basic rate, cancellation, and out-of-policy information.

What’s next?

The hotel ID in the response can be used to get descriptive text and area attractions near a hotel via the get_detailed_info endpoint. The rate_key can be used to get additional details on a hotel room/rate via the get_rate_details endpoint, or to book the hotel via the book endpoint.

Path parameters

versionstringRequired

Headers

AuthorizationstringOptional

Request signature for authentication. Format: Signature YOUR_SIGNATURE. Calculated using HMAC-SHA256 with your secret key.

Query parameters

api_keystringOptional

Your public API key. Example: api_key=testkey.

timestampstringOptional

The UNIX (UTC) timestamp created by your application for this request (in seconds). Must be within 2.5 minutes of the current time.

noncestringOptional
A unique cryptographic identifier created by your application to secure the request. Must be 32 characters or less and cannot be reused within 5 minutes.
localestringOptional

The language preference of your user. Valid values: en_US, fr_FR, de_DE, es_ES, it_IT, pt_PT, ja_JP, ko_KR. Default is en_US.

customer_ipstringOptional
The IP address of your user. Allows determination of the user's location for fraud recovery and analytics purposes.
session_idstringOptional
A unique user session identifier created by your application. Do not use the real user's session identifier. Allows identification of all requests throughout a user session for error handling and troubleshooting.
user_agentstringOptional

The user agent (device, application or browser) of your user. Allows retrieval of mobile rates and discounts from some providers. Must be properly encoded. Max 32 characters. Required to get discounted mobile rates.

configuration_idintegerOptional

Configuration ID for proper company settings. Obtain via the get_configurations endpoint.

systemstringOptional

The booking channel. Valid values include: aft, obt, web.

checkinstringOptional

The check-in date for the hotel search. Format: YYYY-MM-DD.

checkoutstringOptional
currencystringOptional
guest_countintegerOptional
hotel_idintegerOptional
loyalty_program_codesstringOptional
timeoutintegerOptional
date_format_typestringOptional
dont_wait_for_resultsbooleanOptional
search_idstringOptional