Create, update and manage branch-level property records programmatically.
With our Properties API you can create, update and manage branch-level property records programmatically from within your own software, CRM or property management system, then automatically push these property records for syndication across multiple real estate portals including Rightmove, Zoopla, OnTheMarket and Sturents. With flexible portal-specific options across sales, lettings and commercial, you can easily manage the advertising of your own or customer portfolio without leaving your own eco-system. Our Properties API includes a wide range of options to describe records across, pricing, features, rooms and media with near real-time publishing to portals.
To access the API you'll first need to request an API Key, API username and API password related to either your main advertising account or an individual branch connected to your main account.
Note Customers on a multi-branch management account can manage properties across all of their connected branches using a single set of API credentials.
To get your API Key, username and password, please contact account support.
Your API requests must include the following headers:
eaf-client-key the unique API key for the account making the request eaf-nonce a unique string for every request. This will also be included in your authorization hash and used to prevent replay attacks. Authorization contains your authorization hash. See below for how to create and finalise your authorization hash. Content-type determines how you'll be encoding your data.
Your content-type should be specified as (JSON) application/json.
The authorization hash is a concatenated string of <username>:<password>:<nonce>:<api_key> which must then be hashed using SHA-256. The resulting string is then encoded using Base64.
Although we have no strict requirement for how you create your unique nonce, its's highly recommended to use V4 UUID.
For example: 66e6955a-e814-4ee0-b5e9-20c3bbebd563
Properties API calls are made using either POST, GET or PUT requests over a HTTPS connection to the following URL:
API end-point: https://eaf.cloud/agents/properties/v1/
Responses will always be in JSON format and include various headers you can use to troubleshoot issues.
200 OK The request was successfull 400 Bad Request The request was invalid or the payload malformed. 401 Unauthorised You don't have permission to access the resource. 429 Too Many Requests Rate limiting has kicked in, preventing the request being processed.
When contacting us with an API request issue, please be sure to provide the eaf-request-id provided in the response header.
To submit a new property, POST /create must be called.
To see all available options, you can download the V1 Schema sendPropertyRequestSchema
You can download a sample payload sendPropertyRequestSample
property property.reference property.branch_id property.created property.updated property.transaction property.status property.type property.category property.pricing property.pricing.price property.pricing.rent_frequency property.pricing.contract_type property.pricing.deposit property.pricing.contract_length property.pricing.currency property.pricing.portal_pricing property.location property.location.house_name_number property.location.address_1 property.location.town property.location.city property.location.postcode property.location.latitude property.location.longitude property.details property.details.summary property.details.description property.details.bedrooms property.details.bathrooms property.details.receptions property.details.furnished property.details.features property.details.condition property.media property.media.image property.media.image[].url property.media.image[].caption property.media.floorplan property.media.epc property.rooms property.rooms[].room_name property.rooms[].room_description property.rooms[].room_length property.rooms[].room_width property.vtours property.output_rightmove property.output_zoopla property.output_onthemarket property.output_sturents property.output_other
[object] [string] [string] [string] [string] [enum] [enum] [enum] [enum] [object] [number] [enum] [enum] [number] [integer] [string] [array] [object] [string] [string] [string] [string] [string] [number] [number] [object] [string] [string] [integer] [integer] [integer] [enum] [array] [enum] [object] [array] [string] [string] [array] [array] [array] [string] [string] [number] [number] [array] [bool] [bool] [bool] [bool] [array]
The property record object. Unique property reference. The branch ID where this property is sent. Original creation date/time (YYYY-MM-DD HH:MM:SS). Last modification date/time (YYYY-MM-DD HH:MM:SS). Sales or lettings. Available, under offer etc. Detached, flat, semi-detached etc. Residential or commercial. Pricing details for the property. Sales price or rental amount. Rental frequency (per month, per week etc.). Lettings only (long_term, short_term, rolling). Deposit amount for lettings. Contract length in months for lettings. Currency code (ISO 4217, default: GBP). Portal-specific pricing overrides. Location and address information. House number or name. Primary street address line. Town or village name. City name. UK postcode (validated format). Latitude coordinate (-90 to 90). Longitude coordinate (-180 to 180). Property details and description. Short summary of the property (0-3000 chars). Detailed property description (0-32000 chars). Number of bedrooms (0-20). Number of bathrooms (0-20). Number of reception rooms (0-10). Furnished state: furnished, part furnished etc. Array of key property features. Overall condition: excellent, good etc. Media files associated with the property. Property images (1-100 required). Image URL (must be http/https). Image caption or description. Floorplan images (1-20). Energy Performance Certificate files (1-5). Room-by-room details (1-20 items). Room name/type: bedroom, kitchen etc. Room description. Room length (in metres or feet). Room width (in metres or feet). Virtual tour URLs (supports Matterport, YouTube etc.). Publish to Rightmove explicitly (true by default). Publish to Zoopla explicitly (true by default). Publish to OnTheMarket explicitly (true by default). Publish to Sturents explicitly (true by default). Controls publishing to all other sites.
Required Required Required Required Required Required Required Optional Optional Required Required Required * Required * Optional Optional Optional Optional Required Required Required Required Required Required Optional Optional Required Required Required Optional Optional Optional Optional Optional Required Required Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional
* Marked fields are required for lettings transactions only (when property.transaction = 'lettings'). For sales transactions these fields are optional.
With the output keys you can control on a granular level which portals a property should be published or unpublished from. By default all portals provisioned with a branch will be set as TRUE, so you can use these keys to prevent publishing or remove listings from being advertised when required.
Responses to the API are served as a JSON string and if successfull will include a unique record_id you can use in future calls.
Note that it may take 2 - 3 minutes for the property record to be available in the GET /list request.
To update an existing property, PUT /update must be called.
The payload you send is identical to POST /create. Make sure you have provided the existing branch_id and reference made in the original call.
You can download the Schema sendPropertyRequestSchema
You can download a sample payload sendPropertyRequestSample
Responses to the API are served as a JSON string and if successfull will include the property reference and branch ID you used in the request.
To get a summarised list of properties under a branch, GET /list must be called.
Below are the required and optional URL parameters you use to complete your request.
branch=[0-9]+ /[0-9]+
[number] [number]
Query parameter - the branch ID to fetch the list from The requested page number [0-9]+ e.g /list/5
Required Optional
Example request fetching page 9 might be /agents/properties/v1/list/9?branch=12345
Responses to the API are served as a JSON string and if successfull will include an array of objects for each property found within a paginated list, 10 per page.
Note: new properties submitted using POST /create may take 2 - 3 min to appear in this list.
To fetch the details of a property record, GET /property/[RECORD_ID] must be called.
With this end-point you must use either the record_id or the property reference as a query parameter to request the details.
/[0-9]+ reference=[a-z0-9]+
[number] [string]
The record_id e.g /property/12345678910 Query parameter - the reference number
Required Required
Example request using the reference might be /agents/properties/v1/property/?reference=LET-2026-00142
Example request using the record_id might be /agents/properties/v1/property/123456789210
Responses to the API are served as a JSON string and if successfull will include the property details.
To flag an existing property as removed and to therefore have it unpublish from all portal accounts PUT /remove must be called.
This end-point accepts query parameters which must be either the record or reference and branch with the relevant value.
An example request using the property record_id might be /agents/properties/v1/remove?record=12345678910
An example request using the property reference and branch might be /agents/properties/v1/remove?branch=12345&reference=LET-2026-00142
Note: properties that are removed are also removed from the EAF branch and will not longer be visible in the UI or contribute to the account property count limits. However the listing still exists and so to reinstate the removed property, simply make an PUT /UPDATE request with the current property data.
Responses to the API are served as a JSON string and if successfull will include the property reference and branch ID of the record that was flagged for removal.
Please email support@estateagentfeeds.com if you require help with our Property API.
Ok message
Error message