Field reference · REES · Caribe Scout

Jump to: Feed · Listing · Money · Measure · Length^0.2 · Geo · Provenance · Energy^0.2 · RentalTerms^0.2 · ShortTerm^0.2 · Commercial^0.2 · Building^0.2 · License · Publisher · Contact · LocalizedText · Development

Unknown fields are rejected, not ignored: a typo such as bedrooms at the listing level (it belongs in rooms) is reported rather than silently lost. Display labels for users exist in seven languages — see amenities & languages.

Feed (the top level)

Real Estate Exchange Standard v0.2: one publisher, its listings and developments.

Field	Type	Meaning
`rees` ●	"0.2"	Spec version this feed follows: "0.2".
`publisher` ●	Publisher	Who sends this feed.
`generated_at` ●	string (date-time)	When this feed was produced (ISO 8601, with timezone).
`license`	License	Default licence for every listing in the feed; a listing may override it.
`listings` ●	array of Listing	All current listings, or only changes when `since` is set.
`developments`	array of Development	Developments (projects) whose units appear in `listings`.
`since`	string (date-time)	Set when this is a delta feed: only records updated after this instant.
`next`	string (uri)	URL of the next page, for large feeds.

Listing

One property offered for sale or rent.

Field	Type	Values / rules	Meaning
`id` ●	string	max 128 characters	Stable within the publisher. Never reuse; never change when the listing is edited.
`url` ●	string (uri)		The listing's canonical page on the publisher's site. Receivers link back here.
`status` ●	one of	`activereservedsoldrentedwithdrawn`	Market status. Keep sold/withdrawn listings in the feed for 30 days.
`updated_at` ●	string (date-time)		Last change to any field.
`listed_at`	string (date)		First day on the market.
`operation` ●	one of	`salerent_longrent_midrent_short`	rent_mid = monthly, 1–11 months; rent_short = nightly/weekly.
`property_type` ●	one of	`apartmentpenthousevillahousetownhouselandcommercialhotelbuildingother`	What the property is.
`development_id`	string		The development this unit belongs to, when there is one in `developments`.
`unit`	string		Unit label inside a building or development: "A-402".
`title` ●	LocalizedText		Headline, in one or more languages.
`description`	LocalizedText		Full description, in one or more languages.
`price` ●	Money		Asking price or rent.
`area`	object		Areas, each with its own unit.
`area.built`	Measure		Interior living area.
`area.usable`	Measure		Net usable floor area, where the market distinguishes it.
`area.gross`	Measure		Gross built area including walls and common shares.
`area.terrace`	Measure		Terraces and balconies.
`area.plot`	Measure		Land. For property_type "land", this is the size.
`area.standard`	one of	`ipmslocalunknown`	How areas were measured: IPMS, or the local convention.
`rooms`	object		Room counts.
`rooms.bedrooms`	integer	≥ 0	0 = studio.
`rooms.bathrooms`	number	≥ 0	Half baths as .5.
`rooms.parking`	integer	≥ 0	Parking spaces included.
`rooms.total`	integer	≥ 0	All habitable rooms, where the market counts them (Europe).
`location` ●	object		Where the property is.
`location.country` ●	string	a 2-letter ISO country code such as DO	ISO 3166-1 alpha-2.
`location.region`	string		Province / parish / state.
`location.city` ●	string		City or municipality.
`location.area`	string		Neighbourhood, sector or resort: "Cap Cana", "Los Corales".
`location.address`	string		Street address. Omit when the publisher does not disclose it.
`location.address_visibility`	one of	`fullstreetarea_only`	What a receiver may show: the full address, the street only, or only the area.
`location.postal_code`	string		Postal code.
`location.geo`	Geo		Coordinates and their precision.
`delivery`	object		Construction status.
`delivery.status` ●	one of	`builtunder_constructionoff_plan`	Whether it exists yet.
`delivery.year_built`	integer	≥ 1800 · ≤ 2100	Year completed.
`delivery.expected`	string	a year, quarter or month: 2027, 2027-Q2 or 2027-06	Handover: "2027", "2027-Q2" or "2027-06".
`features`	array of string	lowercase with underscores, e.g. ocean_view	Amenity codes from the REES vocabulary (150 terms, 12 categories, labelled in 7 languages). Other codes are kept with a warning.
`media`	array of objects		Photos, plans, videos and documents.
`media[].url` ●	string (uri)		Original file, largest size available.
`media[].type` ●	one of	`photofloorplanvideotourdocument`	What the file is.
`media[].caption`	LocalizedText		Caption, in one or more languages.
`media[].order`	integer	≥ 0	Display order; lowest first.
`costs`	object		Running and purchase costs.
`costs.hoa`	Money		Condominium / maintenance fee, basis per_month or per_year.
`costs.property_tax`	Money		Annual property tax.
`costs.transfer_tax_pct`	number	≥ 0 · ≤ 30	Transfer tax payable by the buyer, % of price.
`legal`	object		Legal status.
`legal.title_status`	one of	`titledtitled_individualin_processuntitledunknown`	titled_individual = its own certificate (in the DR, after deslinde).
`legal.survey_done`	boolean		Boundary survey registered (deslinde in the DR).
`legal.tax_exemption`	object		A tax incentive attached to the property.
`legal.tax_exemption.scheme` ●	string		e.g. "CONFOTUR".
`legal.tax_exemption.until_year`	integer	≥ 2000 · ≤ 2100	Last year it applies.
`legal.tax_exemption.provenance`	Provenance		Where this value came from.
`legal.foreign_buyers`	one of	`allowedrestrictednot_allowedunknown`	Whether non-residents may buy.
`energy`	Energy		Energy certificate (v0.2).
`rental_terms`	RentalTerms		Lease terms for long and mid-term lets (v0.2).
`short_term`	ShortTerm		Holiday-letting details (v0.2).
`commercial`	Commercial		Commercial details (v0.2).
`building`	Building		Building and construction (v0.2).
`agent`	Contact		The person to contact about this listing.
`listing_office`	object		The office that holds the listing, when it is not the publisher (co-brokerage, MLS).
`listing_office.name` ●	string		Office name.
`listing_office.id`	string		Office id in the source system.
`listing_office.website`	string (uri)		Office website.
`license`	License		Licence for this listing, overriding the feed default.

Money

An amount, its currency and what it is a price OF. Never a bare number.

Field	Type	Values / rules	Meaning
`amount`	number	≥ 0	Required unless basis is on_request. For a range, the low end.
`max`	number	≥ 0	High end of a range (basis "range").
`currency` ●	string	a 3-letter ISO currency code such as USD or DOP, not a symbol	ISO 4217 code: USD, DOP, EUR, JMD… Never a symbol.
`basis` ●	one of	`totalper_m2fromrangeper_monthper_weekper_nightper_yearon_request`	total = the whole property; per_m2 = rate × area; from = lowest unit in a development; range = amount…max.
`includes`	list of	`furniturehoautilitiesvattransfer_taxcleaningparking`	What the amount includes, when it is not bare.
`provenance`	Provenance		Where this value came from.

Measure

An area with its unit.

Field	Type	Values / rules	Meaning
`value` ●	number	> 0	The area, in `unit`.
`unit` ●	one of	`m2ft2haacre`	Always stated. No default unit exists.
`provenance`	Provenance		Where this value came from.

Lengthnew in 0.2

A length with its unit (ceiling heights, frontages).

Field	Type	Values / rules	Meaning
`value` ●	number	> 0	The length, in `unit`.
`unit` ●	one of	`mft`	Always stated.

Geo

A point on the map and how close it is to the property.

Field	Type	Values / rules	Meaning
`lat` ●	number	≥ -90 · ≤ 90	Latitude, WGS 84 decimal degrees.
`lng` ●	number	≥ -180 · ≤ 180	Longitude, WGS 84 decimal degrees (negative west of Greenwich).
`precision` ●	one of	`exactstreetneighbourhoodapproximate`	How close the point is to the property. Use "approximate" for a deliberately blurred pin.
`provenance`	Provenance		Where this value came from.

Provenance

Where a value came from. Optional everywhere; required on price and area for the Verified level.

Field	Type	Values / rules	Meaning
`source` ●	one of	`owneragentdevelopersurveyregistryappraisalcertificateestimate`	Who or what stated the value.
`date`	string (date)		When it was stated or checked.
`confidence`	one of	`verifiedstatedestimated`	verified = checked against a document; stated = as told; estimated = derived.
`note`	string		Anything a reader needs to interpret the value.

Energynew in 0.2

Energy performance certificate. Required by law in listings across the EU and the UK; optional elsewhere.

Field	Type	Values / rules	Meaning
`scheme`	one of	`eu_epcuk_epcleededgeother`	Which certificate system the rating belongs to.
`rating`	one of	`A+++A++A+ABCDEFG`	Energy class on the certificate.
`primary_kwh_m2_year`	number	≥ 0	Primary energy demand, kWh per m² per year.
`co2_kg_m2_year`	number	≥ 0	CO₂ emissions, kg per m² per year.
`valid_until`	string (date)		Certificate expiry.
`status`	one of	`issuedin_processexempt`	exempt = the property is legally exempt (e.g. listed buildings, land).
`provenance`	Provenance		Where this value came from.

RentalTermsnew in 0.2

Terms of a long or mid-term let. Use with operation rent_long or rent_mid.

Field	Type	Values / rules	Meaning
`deposit`	Money		Security deposit as an amount (basis "total").
`deposit_months`	number	≥ 0 · ≤ 24	Deposit as months of rent, when stated that way.
`min_term_months`	integer	≥ 1	Shortest lease accepted.
`max_term_months`	integer	≥ 1	Longest lease offered, when limited.
`available_from`	string (date)		Move-in date. Omit when available now.
`furnished`	one of	`unfurnishedpartfully`	How it is let.
`utilities_included`	list of	`electricitywatergasinternettvhoacleaning`	Utilities included in the rent.
`pets`	one of	`allowedon_requestnot_allowed`	Pet policy.
`smoking_allowed`	boolean		Smoking allowed inside.

ShortTermnew in 0.2

Holiday / short-term letting. Use with operation rent_short, or on a sale to describe its rental use.

Field	Type	Values / rules	Meaning
`license_number`	string		Tourist-rental registration number where the law requires one.
`license_authority`	string		Who issued it.
`max_guests`	integer	≥ 1	Maximum occupancy.
`min_nights`	integer	≥ 1	Minimum stay.
`check_in`	string	a 24-hour time such as 15:00	Check-in from (local time, HH:MM).
`check_out`	string	a 24-hour time such as 11:00	Check-out by (local time, HH:MM).
`calendar_url`	string (uri)		iCal (.ics) availability feed.
`rates`	array of objects		Seasonal nightly or weekly rates.
`rates[].name`	string		Season name: "High season", "Christmas".
`rates[].from` ●	string (date)		First night.
`rates[].to` ●	string (date)		Last night.
`rates[].price` ●	Money		Rate, basis per_night or per_week.
`cleaning_fee`	Money		One-off cleaning fee per stay (basis "total").
`managed_by`	string		Rental manager, when not the publisher.

Commercialnew in 0.2

Commercial property details. Use with property_type commercial, hotel or building.

Field	Type	Values / rules	Meaning
`use`	one of	`officeretailrestaurantindustrialwarehousehospitalitymixed_usehealthcareland_commercial`	Main permitted use.
`zoning`	string		Local zoning designation, as written by the authority.
`ceiling_height`	Length		Clear internal height.
`frontage`	Length		Street frontage.
`loading_docks`	integer	≥ 0	Number of loading docks.
`power_kva`	number	≥ 0	Electrical supply capacity in kVA.
`rooms_keys`	integer	≥ 0	Hotel rooms / keys.
`tenanted`	boolean		Sold with a sitting tenant.
`income`	Money		Current rental income (basis per_month or per_year).

Buildingnew in 0.2

The building the unit is in, or the house itself.

Field	Type	Values / rules	Meaning
`floor`	integer	≥ -10 · ≤ 200	Floor of the unit: 0 = ground, negative = below ground.
`floors_total`	integer	≥ 1 · ≤ 200	Floors in the building.
`units_total`	integer	≥ 1	Units in the building.
`orientation`	one of	`nneesesswwnw`	Main façade or terrace direction.
`condition`	one of	`newexcellentgoodneeds_renovationto_restore`	Condition as described by the publisher.
`year_renovated`	integer	≥ 1800 · ≤ 2100	Last major renovation.
`construction`	one of	`concreteconcrete_blocksteelwoodmasonrymixed`	Main structure.
`roof`	one of	`concretemetaltilewoodthatchother`	Roof type: matters for hurricane exposure and insurance.
`design_wind_speed_kmh`	number	≥ 0 · ≤ 500	Wind speed the structure is engineered for, km/h.
`ground_elevation_m`	number	≥ -50 · ≤ 6000	Ground elevation above sea level, metres.

License

What a receiver may do with the data. Set once on the feed; override per listing.

Field	Type	Values / rules	Meaning
`use` ●	one of	`republish-with-creditdisplay-onlyidx-personal-useno-republish`	idx-personal-use = MLS/IDX data a portal may NOT republish; no-republish = analysis only.
`credit_required`	boolean		The publisher (or listing office) must be named wherever the listing is shown.
`backlink_required`	boolean		The listing must link to its `url`.
`url`	string (uri)		The publisher's terms, if any.

Publisher

The organisation that sends the feed.

Field	Type	Values / rules	Meaning
`id` ●	string	lowercase letters, digits and hyphens, e.g. "example-realty"	Stable slug for the publisher, chosen once: "cabarete-real-estate".
`name` ●	string		Trading name.
`kind`	one of	`agencydeveloperownermlsportal`	What kind of organisation this is.
`website` ●	string (uri)		Home page.
`country`	string	a 2-letter ISO country code such as DO	Country of registration (ISO 3166-1 alpha-2).
`contact`	Contact		Main contact for the feed.
`license_number`	string		Local broker licence or registry number, where one exists.

Contact

A person or office to contact.

Field	Type	Values / rules	Meaning
`name`	string		Full name or office name.
`email`	string (email)		Email address.
`phone`	string	an international number starting with +, e.g. +1 809 555 0100	Phone with country code: +1 809 555 0100.
`whatsapp`	string	an international number starting with +	WhatsApp number with country code.
`languages`	array of string	a 2-letter language code such as en	Languages this contact speaks (ISO 639-1).

LocalizedText

Text by language, keyed by ISO 639-1 code: {"en": "...", "es": "..."}. At least one language.

Keys are language codes (en, es, fr, pt-BR). {"en": "Ocean-view condo", "es": "Condo con vista al mar"}

Development

A project with several units, each listed separately with development_id.

Field	Type	Values / rules	Meaning
`id` ●	string	max 128 characters	Stable within the publisher.
`name` ●	string		Project name.
`url` ●	string (uri)		Project page.
`developer`	string		Developer company.
`location` ●	same as`Listing.location`		Where the project is.
`delivery` ●	same as`Listing.delivery`		Construction status and handover.
`units_total`	integer	≥ 1	Units in the project.
`units_available`	integer	≥ 0	Units still for sale.
`price_from`	Money		Lowest price, basis "from".
`description`	LocalizedText		Project description.
`media`	same as`Listing.media`		Project media.
`features`	same as`Listing.features`		Project amenities.
`building`	Building		Construction details shared by all units.
`energy`	Energy		Project-level certificate (e.g. EDGE, LEED).