How to Search Listings Using Keywords
Our real estate APIs offer a robust keyword search feature that allows API users to search listings using specific keywords. This feature is highly versatile and can be used to create a general search input for your users, enabling them to find listings by MLS® number, address, or by searching text in descriptions. Additionally, you can implement an auto-complete function using this feature.
The "search" Parameter
The search parameter enables users to find listings that contain specific keywords anywhere in the listing details. For example, to find listings containing the keyword "cul-de-sac", you can make the following request:
GET https://api.repliers.io/listings?search=cul-de-sacThis request will return all listings where "cul-de-sac" appears in any part of the listing.
Search for Multiple Keywords or Phrases
You can search for multiple keywords or phrases by separating them with commas. This ensures that all specified terms are present in the listing data.
Example:
https://api.repliers.io/listings?search=cul-de-sac,high ceilingsThis will retrieve listings where both "cul-de-sac" and "high ceilings" appear in the listing data.
The "searchFields" Parameter
The searchFields parameter allows you to isolate the search to specific fields. This is particularly useful for searches focused on addresses. For example, to find listings at "1 Yonge St", you can restrict the search to the address fields:
GET https://api.repliers.io/listings?search=1 Yonge St&searchFields=address.streetNumber,address.streetNameExclude Specific Keywords or Phrases
To exclude listings containing specific keywords, use the not: prefix. This allows you to filter out unwanted terms from the results.
Example:
https://api.repliers.io/listings?search=cul-de-sac,high ceilings,not:bungalow&searchFields=details.descriptionThis will retrieve listings where both "cul-de-sac" and "high ceilings" appear in the details.description field but exclude any listings where the word "bungalow" is present.
Summary of Search Parameters
- search: Specifies the keywords or phrases to search for.
- searchFields: Specifies which fields to search within (e.g., details.description).
- not:: Excludes listings containing specific keywords or phrases.
Combining Parameters
The search and searchFields parameters can be combined with other parameters to refine your query further. For example, to find listings at "1 Yonge St" with at least 3 bedrooms, you can use the following request:
GET https://api.repliers.io/listings?search=1 Yonge St&searchFields=address.streetNumber,address.streetName&minBeds=3Conclusion
The keyword search feature in our real estate APIs provides powerful capabilities for searching listings by various criteria. By leveraging the search and searchFields parameters, along with other search filters, you can offer a highly customizable search experience for your users. For further assistance or advanced implementation tips, please contact our support team.
What questions does this article answer?
- How does the
searchparameter work for keyword-based listing search? - How do I search across descriptions, addresses, MLS® numbers, etc. using free text?
- How can I limit keyword search to specific fields using
searchFields? - How do I include or exclude specific words/phrases in a search?
Updated on: 15/06/2026
Thank you!
