Access your portal leads through a single unified end-point.
With our Leads API you can programmatically access your portal email and phone enquiries then publish them within your own CRM, website or app. The Leads API provides a single, HTTP based query method for accessing the lead data we import every hour into your EAF account. Using a set of query parameters your data can be filtered down by date range of up to a month in the past and by portal name, enabling you to keep on top of current or view past enquires.
API responses are returned in JSON format which is a widely recognised format for light weight data transmission that web and software developers can access and start pulling data from in as little as 10 mins.
Access to the Leads API to retrieve your email enquires is done using the GET HTTP method while callng the below fixed URL end-point.
Access to the Leads API to retrieve a log of received phone calls is done using the GET HTTP method while callng the below fixed URL end-point.
When calling these URLs it's important to note that there are some mandatory and optional parameters that are used in order to both authenticate the account being accessed as well as provide some basic filtering options of the data returned.
Note: our phone call logs are only supported by Rightmove and OnTheMarket.
Authentication against the Leads API is done using the Basic Auth HTTP method. A username and password will be required to generate your authorization header.
The authorization value is a concatenated string of username:password which is then encoded using Base64.
To get your account or individual branch API username and password, please contact account support.
The following are the accepted parameters which should be added to the GET request. By default, enquiries across all relevant portals are returned which can be filtered down by using the optional type parameter.
key: [string] - required your API key which is unique to your account. date_from: [string] [YYYY-MM-DD] - required a past date to begin filtering the results from. date_to: [string] [YYYY-MM-DD] - required a past or the current date to return results to. Must not be greater than 1 month beyond date_from. type: [rightmove, zoopla, onthemarket] - limit results to the specified portal.
The Leads API generates responses in JSON format. Examples of which can be seen below.
API responses include a head section which inludes details about the call, the number of results and an array of zero or more emails or calls.
The emails array includes an object with the following keys and values.
The calls array includes an object with the following keys and values.
If you've accessed the API with invalid parameters such as using an incorrect date range in the call, the following example is returned:
Querying: We recommend querying the API no more than every 2 hours. Date range: Use a past date range of at least 1 day to make sure you capture all leads. Save data: When accessing the API, save the data returned to your own local database.
Please email support@estateagentfeeds.com if you require help with our Leads API.
Ok message
Error message