👉

Available Now - API docs can be found here.

Overview

Property preview is a lightweight and performance oriented endpoint intended to be used for quick and high level property level information on 3rd party apps and websites. This endpoint is great for clients, developers and 3rd party integrations who share mutual clients with Ripe.

• Integration with AI chatbots - Keep your AI chat localized and authentic by including Ripe content such as property name, content, reviews, URL and ARI.
• Website property tiles - Map website property tiles show accurate ARI, links and content, taking the user directly to that property detail page.

With the increase in conversational AI chatbots and website integration requests we created an API endpoint built specifically for these cases. While other pre-existing Ripe endpoints include significantly more data they also come with more complexity and far more response object necessary for certain types of of integrations.

Performance

To optimize response speed, Ripe implements a lightweight caching layer for all availability, rates, and inventory (ARI) data returned by this endpoint. Cached results can persist for up to 24 hours per property/date combination, allowing requests to return nearly instantly without repeatedly hitting live connectivity sources. In most use cases—such as AI assistants, preview cards, or property tiles—this minimal delay has no meaningful impact on accuracy but provides a substantial boost in performance and stability.

Request

At its most simple form, you can authenticate, including nothing else in the request and get a complete set of property data in return. However, we highly suggest optimizing your request to exactly what you need, and nothing more. This will return the fastest results, structured in a consistent way each time for your application to consume.

Request parameters return various object based on what is included.

properties (string) optional

• With properties, provide one or more comma-separated property IDs.
• Without properties, returns all properties for the account.

checkin and checkout (string)optional

• With check-in/out dates - Returns static property data, plus lead rate per night and the cost of the total stay.
• Without check-in/out dates - Returns static property data without rates.

include_default_dates (boolean) optional

adults (number) required defaults to 2

children (number) optional

images_qty (number) designates the number of image URLs returned. Max/unspecified returns up to 10 ​

Response

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 Guest review star rating, 0.0-5.0

user_review_count Total number of guest reviews

hotel_star_rating Official hotel star rating, 1-5, if available.

• This is the hotel star rating, "This is a 4-star hotel". This isnot the guest reviews rating.

amenities Comma separated list available amenities for the property. Note, amenities may differ by room type or room rate selected.

Dynamic Data Responses

The following dynamic fields are returned when explicit or default dates (include_default_rates = true) are included in the request.

If a property is unavailable for the requested dates, no lead rates are returned. Your frontend should handle this gracefully (e.g., display a “Check Availability” CTA).

availability_status This is a simple value to identify if the property is available for the nights requested. There are three possible response:

• available The property is confirmed available for the specified dates
• unavailable The property is confirmed unavailable for the specified dates
• unknown The property is did not return explicit availability, or is a referral property. Referral properties are represented on Ripe but reservations are placed on a 3rd party platform. For example, a home is on AirBnB but is not supported with a live connection and integration to Ripe.

Lead Rate Parameters

The following objects 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.

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.

Example Response

Here is an example response, for a single property when checkin and checkoutdates were included in the request.

{
  "meta_data": {
    "total_properties": 1,
    "response_time": 41,
    "source": "LAYER_1",
    "strategy": "Strategy_1",
    "sources_breakdown": {
      "fromCache": 1,
      "fromAvailability": 0,
      "fromStatic": 0
    }
  },
  "data": [
    {
      "ripe_property_id": 5302,
      "property_name": "Pendry Park City",
      "property_detail_url": "https://lodging.stayparkcity.com/property/5302/pendry-park-city",
      "area": "Park City",
      "geo": {
        "latitude": 40.683759,
        "longitude": -111.556062
      },
      "image_url": "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-5045a5513e69c5ace5a4755ef4818953.jpg",
      "property_type": "Hotel",
      "description": "",
      "user_review_rating": 4.4,
      "user_review_count": 225,
      "hotel_star_rating": 5,
      "preferred_property": true,
      "amenities": [
        "Bar/Lounge",
        "Fitness Center",
        "Pool",
        "Restaurant",
        "Room Service",
        "Spa"
      ],
      "lead_rate": {
        "original_amount_per_night": 242.5,
        "actual_amount_per_night": 242.5,
        "original_amount_total_stay": 1213.71,
        "actual_amount_total_stay": 1213.71,
        "is_available": true,
        "currency": "USD",
        "checkin": "2026-06-01",
        "checkout": "2026-06-05"
      },
      "availability_status": "available",
      "short_description": "",
      "long_description": "<p>Pendry Park City offers a luxurious alpine retreat nestled in the heart of Canyons Village at Park City Mountain. Combining modern elegance with mountain charm, this resort provides a perfect base for both adventure and relaxation. Guests enjoy impeccable service, upscale accommodations, and direct access to year-round outdoor activities. Whether hitting the slopes or indulging at the spa, Pendry Park City elevates every stay with style and comfort.</p>\n<ul>\n<li>Ski-in/ski-out access at Park City Mountain Resort</li>\n<li>Rooftop pool with stunning mountain views</li>\n<li>Full-service spa and wellness center</li>\n<li>Multiple on-site dining and après-ski options</li>\n<li>Family-friendly amenities and activities</li>\n</ul>",
      "location_short_description": "",
      "attractions": "",
      "directions": "",
      "why_we_like_it_list": "",
      "what_you_need_to_know": "",
      "staff_pick": "New",
      "images": [
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-5045a5513e69c5ace5a4755ef4818953.jpg",
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-cf3a3fa00a504544a373537b1cc8dd1b.jpg",
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-dffe9108e17eada4476622e14547b3df.jpg",
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-a7a7c76705e9af644dffc09d7c71c224.jpg",
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-3d3f96b50051b6a020de97af0529f08c.jpg"
      ]
    }
  ]
}

{
  "meta_data": {
    "total_properties": 1,
    "response_time": 35,
    "source": "LAYER_2",
    "strategy": "Static_Only",
    "sources_breakdown": {
      "fromCache": 0,
      "fromAvailability": 0,
      "fromStatic": 1
    }
  },
  "data": [
    {
      "ripe_property_id": 5302,
      "property_name": "Pendry Park City",
      "property_detail_url": "https://lodging.stayparkcity.com/property/5302/pendry-park-city",
      "area": "Park City",
      "geo": {
        "latitude": 40.683759,
        "longitude": -111.556062
      },
      "image_url": "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-5045a5513e69c5ace5a4755ef4818953.jpg",
      "property_type": "Hotel",
      "description": "",
      "user_review_rating": 4.4,
      "user_review_count": 225,
      "hotel_star_rating": 5,
      "preferred_property": true,
      "amenities": [
        "Bar/Lounge",
        "Fitness Center",
        "Pool",
        "Restaurant",
        "Room Service",
        "Spa"
      ],
      "lead_rate": {},
      "availability_status": "unknown",
      "short_description": "",
      "long_description": "<p>Pendry Park City offers a luxurious alpine retreat nestled in the heart of Canyons Village at Park City Mountain. Combining modern elegance with mountain charm, this resort provides a perfect base for both adventure and relaxation. Guests enjoy impeccable service, upscale accommodations, and direct access to year-round outdoor activities. Whether hitting the slopes or indulging at the spa, Pendry Park City elevates every stay with style and comfort.</p>\n<ul>\n<li>Ski-in/ski-out access at Park City Mountain Resort</li>\n<li>Rooftop pool with stunning mountain views</li>\n<li>Full-service spa and wellness center</li>\n<li>Multiple on-site dining and après-ski options</li>\n<li>Family-friendly amenities and activities</li>\n</ul>",
      "location_short_description": "",
      "attractions": "",
      "directions": "",
      "why_we_like_it_list": "",
      "what_you_need_to_know": "",
      "staff_pick": "New",
      "images": [
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-5045a5513e69c5ace5a4755ef4818953.jpg",
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-cf3a3fa00a504544a373537b1cc8dd1b.jpg",
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-dffe9108e17eada4476622e14547b3df.jpg",
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-a7a7c76705e9af644dffc09d7c71c224.jpg",
        "https://dn6ese28u9bxz.cloudfront.net/property_images/5302/pendry-park-city-3d3f96b50051b6a020de97af0529f08c.jpg"
      ]
    }
  ]
}