Property Preview Endpoint
A simple and lightweight endpoint to retrieve key property details.
Available Now - Full API docs can be found here.
The property_preview endpoint provides a lightweight and performant response to be used for AI chatbots, LLMs, property tiles on your primary website and more.
Overview
Clients and agency partners increasingly need fast, lightweight property previews to power DMO sites, AI travel assistants, and event-driven lodging tools. Current endpoints may be too bulky for conversational AI or quick display use cases.
With the upcoming property preview endpoint, you will be able to quickly retrieve core property details, including optional nightly and total stay lead rates.
API Request
Request parameters return various levels of response based on what is included.
Property ID
- With property ID(s) - results are limited to those properties, one or many.
- Without property ID - returns all properties for the account
Dates
- With check-in/out dates - returns static property data, plus lead rate per night and total stay
- Without check-in/out dates - returns static property data without rates.
Static Data Response
ripe_property_id Ripe's unique property ID
property_name The name of the property to show the user
property_detail_url Property detail page URL on Ripe platform
area - The client defined geographic area for the property
geo Latitude, longitude
preferred_property True, False. This preference is set by the client.
image_url Image URLs for the property. Request 1-10 in the request object.
property_type Hotel, resort, vacation rental, boutique inn, etc
property_description Returns the Ripe property description for the specific client
user_review_rating Google Review start rating, 1–5
user_review_count Google Review total count, integer
hotel_star_rating Official hotel star rating, 1-5, if available
amenities Full list of available amenities for the property
Dynamic Data Response
Additional dynamic fields are returned when dates are included in the request
These responses require a defined check-in and check-out date.
Lead Rate Parameters
The following parameters are returned if dates are sent in the request, and the property is available. If the property is unavailable, no rates can be returned for the specified date range so that case should be handled on your front-end application so that it fails gracefully, such as showing a "Check Availability Now" call to action.
Responses for lead_rate object
original_amount_per_night
The original nightly rate for the lead-in room rate. If the property has a promotional rate, this is the "original price", meaning the higher rate that would display with slash-through pricing, for example. In most cases this is the same as the actual amount per night=. If you are only displaying a single value, use the actual_amount_per_night seen below.
actual_amount_per_night
The actual nightly rate for the lead-in room rate. This is the rate to show if you only show a single rate. If the property has a promotional rate, this is the discounted rate, if the property is no discounted, this will be the same as the original rate, and one of the lowest rates they can book. Once the user continues to the booking engine they will see all available rooms and rates.
original_amount_total_stay
The original total value for all nights.
actual_amount_total_stay
The actual value for all nights. This is the preview rate, subject to adjust with taxes and fees, that the guest would pay for the dates selected for the lead-in room type.
is_available (true, false) Used as a simple value to identify if the property is available for the nights requested.
currency (USD, CAD)
The currency used for the displayed rate.
Referral Properties. This property type is not connected to a live availability, rate and inventory source. For these properties a blank object is returned for rates in order to create a consistent response structure across properties.
Updated 4 days ago