Skip to main content

Field Reference

Value formats and allowed values used across the feed.

Value formats​

ConceptFormatExamples
CountryISO 3166-1 alpha-2US, ES, GB, DE
Region / stateName (matched by name, not a code)Colorado, Arizona, Andalusia
CurrencyISO 4217EUR, USD, GBP, CHF
Language codesISO 639-3, comma-separatedeng,fra,deu
Booleansyes / noyes
Living area unitsqm | sqftunit="sqm"
Land area unitsqm | sqft | ha | acunit="ha"
Year4-digit2021

Property types (property_type)​

House · Villa · Estate · Country house · Finca · Chalet · Townhouse · Bungalow · Apartment · Penthouse · Condo · Co op · Land · Castle · Chateau · Farm ranch · Private island

Energy ratings (emission_rating, consumption_rating)​

emission_rating and consumption_rating both accept the same set of codes:

A B C D E F G · A+ B+ B- · A1 A2 A3 A4 · X NC NI

  • A–G are the standard efficiency classes — A best, G worst.
  • A+, B+, B- are half-step variants; A1–A4 are sub-bands. Send the literal + / -.
  • X, NC, NI are special markers carried over from some national energy certificates (e.g. "not classified" / "not communicated"). Send one only if it appears on the certificate.

Codes are matched case-insensitively. A value outside this list is dropped (the rating is left empty), so send a code exactly as listed.

Price​

Every listing needs one of these:

You sendWorks forHow we read it
pricesale and rentExactly the number you send. Nothing is multiplied.
price + rental_periodrentThe number you send, for the period you name: 4000 + month = EUR 4,000 per month.
rental_price_per_dayrent onlyYour daily rate, exactly as sent. Always a price per day.
price_on_request=yessale and rent"Price on request" instead of a number.

price and rental_price_per_day need a currency attribute (ISO 4217).

Rental period​

rental_period tells us what period the rent price covers. Rent only: we ignore it on sale listings.

ValueAlso acceptedPeriod
daydaily1 day
weekweekly7 days
monthmonthly30 days
yearyearly, annually365 days
  • Values aren't case-sensitive.
  • We don't recognize any other value, so we import the price without a rental period.
  • rental_price_per_day is always a price per day, whatever rental_period says. Send one or the other, not both.
  • Send the real amount for the period. We no longer multiply a daily rate by 7.

This page lists shared value formats and allowed values. The full field list for each format is on its own page (Real Estate Single/Multi Office, Cars, Watches).