Searching Listings By Address
When using our API, you might need to search for property listings by a specific address. There are a couple of ways to do this. Below are the methods you can use to search for listings at a given address, such as 101 Yonge St.
This method allows you to search listings by specifying the address directly in the query. Here’s how you can find listings at 101 Yonge St:
https://api.repliers.io/listings?search=101 Yonge St&searchFields=address.streetName,address.streetNumber
In this example:
search=101 Yonge St specifies the address you are searching for.
searchFields=address.streetName,address.streetNumber tells the API to search within the street name and street number fields.
Alternatively, you can use specific address parameters to search for listings. Here’s how you can do this:
https://api.repliers.io/listings?streetName=Yonge&streetNumber=101
In this example:
streetName=Yonge specifies the street name.
streetNumber=101 specifies the street number.
By default, the above methods will only return active listings. If you want to search for both active and unavailable listings, you need to add a status parameter to your request. Here’s how you can modify the second method to include both statuses:
https://api.repliers.io/listings?streetName=Yonge&streetNumber=101&status=["A","U"]
In this example:
status=["A","U"] includes both active (A) and unavailable (U) listings in the search results.
Method 1: Use the search parameter combined with searchFields.
Method 2: Use specific address parameters.
Include Both Active and Unavailable Listings: Add the status parameter with the values ["A","U"].
These methods provide flexibility depending on your needs and how you prefer to structure your API requests. If you have any further questions or need additional assistance, please feel free to reach out to our support team.
Method 1: Use search and searchFields
This method allows you to search listings by specifying the address directly in the query. Here’s how you can find listings at 101 Yonge St:
https://api.repliers.io/listings?search=101 Yonge St&searchFields=address.streetName,address.streetNumber
In this example:
search=101 Yonge St specifies the address you are searching for.
searchFields=address.streetName,address.streetNumber tells the API to search within the street name and street number fields.
Method 2: Use Address Parameters
Alternatively, you can use specific address parameters to search for listings. Here’s how you can do this:
https://api.repliers.io/listings?streetName=Yonge&streetNumber=101
In this example:
streetName=Yonge specifies the street name.
streetNumber=101 specifies the street number.
Including Both Active and Unavailable Listings
By default, the above methods will only return active listings. If you want to search for both active and unavailable listings, you need to add a status parameter to your request. Here’s how you can modify the second method to include both statuses:
https://api.repliers.io/listings?streetName=Yonge&streetNumber=101&status=["A","U"]
In this example:
status=["A","U"] includes both active (A) and unavailable (U) listings in the search results.
Summary
Method 1: Use the search parameter combined with searchFields.
Method 2: Use specific address parameters.
Include Both Active and Unavailable Listings: Add the status parameter with the values ["A","U"].
These methods provide flexibility depending on your needs and how you prefer to structure your API requests. If you have any further questions or need additional assistance, please feel free to reach out to our support team.
Updated on: 05/06/2024
Thank you!