Skip to main content

Changelog

Unified feed format — Single Office 3.9 · Multi Office 4.4 (2026)​

This release documents one canonical feed format shared across Single Office, Multi Office, and Cars. The biggest practical win: a feed written for Single Office can grow into a Multi Office feed without renaming any listing fields — only the wrapper around them changes. If you already send a feed today, read the notes below before your next update.

What's new in the docs​

  • One page per format. Each format (Real Estate Single/Multi Office, Cars, Watches) is now a single page with its intro, a full example, and the field tables. The previous split of "Intro" and "Fields" into separate tabs — which sometimes disagreed with each other — is gone.
  • Getting Started holds the shared rules. Fetch schedule, the crawler User-Agent, image rules, and the supported video and virtual-tour provider lists now live in one place instead of being copy-pasted onto every format page.
  • New reference pages: a Field Reference (value formats, property types, energy-rating codes) and a grouped Amenities list. Cars is now fully documented in the same style as Real Estate.

Structure​

  • Single Office (version="3.9"). Listings stay in <adverts>/<advert>. Contact details move out of each advert into a shared <agents> block, and each advert points at its agent with <agent_reference>. (Previously the contact was repeated inline in every advert.)
  • Multi Office (version="4.4"). Three sections — <offices>, <agents>, <listings> — with each listing referencing its office and agent. Same as before, tidied up and aligned to the shared field names.
  • version now reflects the layout, not the category. Use 3.9 for the single-office layout and 4.4 for the multi-office layout. A Cars (or Watches) feed declares the version of whichever layout it uses — there is no separate per-category version number anymore.
  • Sale vs rent is <type>sale|rent</type> in every layout.
  • Video and virtual tour live under <media>: media/video/video_url and media/virtual_tour_link. See the supported provider lists in Getting Started.
  • <hide_address> is a per-listing yes/no field, so you can hide the address on individual listings rather than for the whole feed.

Shared field names (Single and Multi)​

The same concept now uses the same element name in both layouts, so a listing block is portable between them:

ConceptCanonical element
Listing IDreference (attribute)
Property typeproperty_type
Titletitle
Sale / rent<type>sale|rent</type>
Priceprice (sale) / rental_price_per_day (rent), + currency — or price_on_request
Year builtyear
Bedrooms / bathrooms / floorsbedrooms · bathrooms · floors (plain — no _count suffix)
Location<location> wrapper (country, city, region, address, zip, latitude, longitude)
Imagesmedia/image/image_url
Videomedia/video/video_url
Virtual tourmedia/virtual_tour_link
Hide addresshide_address

Office and agent contact fields keep their existing names (phone1/phone2, agent_license_id, profile_picture_url, language_codes, social links, …).

Corrections to the previous docs​

  • Energy ratings accept the full code set — A–G, A+, B+, B-, A1–A4, X, NC, NI — not just "A–E". Values outside the list are dropped. See Field Reference.
  • brand and model are not Real Estate fields — they were listed there by mistake; they belong to Cars and Watches.
  • Removed the unused <feed_information> and <dealer> blocks from the single-office format — they were never read.
  • Contact name, email, phone, and address are optional. The old docs over-marked them as required.
  • One version number per format. Examples and field tables previously disagreed (e.g. an example said 3.5 while the table said 3.8); they now match.
  • Fetch schedule is three times a day — ≈ 00:11, 08:11, 16:11 UTC. Some pages previously said four.
  • Image rules: JPEG, PNG, or WEBP; up to 100 images per listing; each ≤ 20 MB. A listing needs at least 2 reachable photos to publish.

Required for every listing​

reference, property_type, location/country + location/city, a price (price with a currency, or price_on_request=yes), and at least 2 images. A resolvable agent_reference (and office_reference for Multi Office) is also required. Everything else is optional.

Watches​

Watches are onboarded by arrangement with the integrations team — there is no self-service specification published yet.