Changing the Cover Image of Property Listings with AI-Powered CoverImage Parameter

When using our real estate API, you can enhance the user experience by utilizing the coverImage parameter. This feature allows you to change the first image of each listing in the response to a desired type of image, such as a "Kitchen." Typically, the exterior photo of a property is the first image shown, but with the coverImage parameter, you can modify this behavior to better suit your users' needs.

Understanding the CoverImage Parameter


The coverImage parameter is powered by AI and provides flexibility in presenting property images. Unlike the AI Image Search (imageSearchItems) that sorts results by relevance, the coverImage parameter maintains the default sorting order (updatedOnDesc) or any specified order using the sortBy parameter. This distinction is crucial when users are comparing different features of properties.

For instance, if users have narrowed down their search to 50 listings and want to view all the kitchens first, they can use the coverImage parameter to achieve this, making it easier to compare and decide which property they like best.

Supported Values for CoverImage


The coverImage parameter supports the following values, allowing users to choose which image type they want to be displayed first:

kitchen
powder room
ensuite
family room
exterior front
backyard
staircase
primary bedroom
laundry room
office
garage

Example Request


Here’s how you can make a request to change the cover image to show the kitchen first:

https://api.repliers.io/listings?coverImage=kitchen

How to Use the CoverImage Parameter


Include the coverImage Parameter: Add the coverImage parameter to your API request URL and set it to one of the supported values.
API Request Example: Use the example request provided above, modifying the coverImage value as needed.
Response Handling: The API response will now feature the specified image type as the first image for each listing, while maintaining the default or specified sorting order.

Benefits of Using CoverImage


Enhanced Comparison: Users can quickly compare specific features, such as kitchens or primary bedrooms, across multiple listings.
Improved User Experience: By showing the most relevant images first, users can make more informed decisions, leading to a better overall experience on your platform.
Customization: Tailor the presentation of listings to meet the unique needs and preferences of your users.

By leveraging the coverImage parameter, you can provide a more tailored and efficient property search experience, helping your users find their ideal home faster and more conveniently.

For further assistance or inquiries, please contact our support team.

Updated on: 24/07/2024

Was this article helpful?

Share your feedback

Cancel

Thank you!