Property Preview Endpoint
Coming soon - A simple and lightweight endpoint to retrieve key property details.
The property_preview
endpoint will provide 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
(unique property identifier)
property_name
property_detail_url
(property detail page on Ripe platform)
area
- (the client defined area for the property)
geo
(latitude, longitude)
image_url
(always return one, support a parameter to that returns up to 10 images)
property_type
(hotel, resort, vacation rental, boutique inn, etc.)
description
(returns the Ripe property description for the specific client)
google_review_rating
(Google Review start rating, 1β5)
google_review_count
(Google Review total count, integer)
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 object
original_amount_per_night
(numeric, single lead rate value, same as the search results page)
actual_amount_per_night
original_amount_total_stay
(numeric rounded)
actual_amount_total_stay
is_available
(true / false)
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 2 days ago