Access your developments through our XML export API.
With our export API you can programmatically access your developments, styles and plots for publishing on your own website or App. The developments API provides a single, HTTP based query method for accessing all or some of the new home property data stored within your EAF account. Using a set of query parameters your data can also be filtered down to more specific sets of development or style information. In simple terms it's a bulk data feed you can leverage in order to publish your property data within your own systems at the same time as website portals, which can dramatically save you valuable time when managing your listings across multiple platforms. API responses are provided in a bulk XML format - bulk meaning it may contain 1 or more records. XML is a widely recognised format for data transmission that web and software developers can access and start pulling data from in as little as 10 mins.
Access to the export API is done using the GET HTTP method while callng the below fixed URL end-point.
When calling the URL 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.
To get your account or individual branch API key, please contact account support.
By default the API only returns developments within your account and nothing else. In order to include styles and their plots found within those developments, you can use one of two additonal values with the include parameter as part of your GET query.
key: [string] - required your API key which is unique to your account or to the individual branch within your account. include: [string] [styles, styles_plots] - the development data plus style information only, styles_plots includes style info and all related plots. unpublished: [string] [yes, no] - whether to include unpublished developments and style records in the results. By default this is yes. ref: [string] - limit results to the development or the style by its reference. style_type: [string] [apartment, detached_house, mews etc.] - if styles are included, filter them by their type. style_max_price: [number] - if styles are included, filter them by the maximum style price. style_flagged: [string] [yes] - if styles are included, only display those flagged as favourite. plot_status: [string] [available, reserved, sold] - if plots are included, filter them by their availability status. plot_qualifier: [string] [from, poa, shared_ownership, shared_equity, equity_loan, coming_soon] - if plots are included, filter them by their qualifier type. plot_max_beds: [number] - if plots are included, filter them by the number of bedrooms entered. plot_max_price: [number] - if plots are included, filter them by the maximum sales price entered.
Note: the export API will not include records that have been deleted regardless of which parameters are used.
Although you are free to access the API as frequently as your system may require, be aware that your feed is cached for at least 2 hours after it is generated and will only be refreshed when something on a development or style level has been modified or if a parameter forces a new results set that hasn't previously been cached, to be returned. While your property data remains the same, the API will return the previously generated feed. You can easily confirm when the feed was last generated by vewing the feed_updated tag at the top of the feed.
The export API generates an XML feed of your developments and new homes data in a close to 1 to 1 mirror as seen within your account. In short, the feed will contain whatever values, images or attachments you've assigned to records within your dashboard with no material alterations, in human readable form using self explainatory XML tags. As such, the best way to start working with the API is to first create a development, a style and some plots, then query your feed to see what is presented.
Sample feed: eaf_new_homes_export_sample.xml
Below is a breakdown and summary of the basic feed structure. Please see the sample feed above for a complete example.
If you've accessed the API with invalid parameters or an invalid value of a parameter, an XML error response is returned such as the following:
Querying: We recommend querying the API once or twice a day or no more than every 2 hours. Save data: When accessing the API, save the data returned to your own local database. Media files: Download all media files if these need to be displayed anywhere, Never publish any URL's directly. Updating records: Use the development or styles reference codes in combination with their updated dates to refresh your database. Publishing: Use the development or styles publish status to decide whether the property should be removed from your software.
Please email support@estateagentfeeds.com if you require help with our developments API.
Ok message
Error message