REAXML Specification

XML Elements

 

address

Indicates the physical address of the property or business

Validation

The address is considered valid if all of its enclosing elements are valid; and that the suburb belongs to the postcode and state, depending on country.

Additionally the display attribute may be used to hide some address details and show the Suburb and State only. The streetview if set to yes will enable streetview on the site for this property however the default for street view will be set to no if display = no. By default both these attributes if not supplied will set the status to yes.

It is an invalid address if the display attribute is yes, and an address is both not provided in the same XML, and has never been provided in the past.

Please Note: New Zealand property listings may omit postcode, but not region. If the postcode is omitted, we will automatically try and associate the correct postcode, however guessing will occur in the instance of duplicated suburb names in the same region.

See Also

subNumber, lotNumber, site, streetNumber, street, suburb, state, region, postcode, country.

allowances

Indicates common restrictions which may limit successful property tenancy applications.

Validation

The allowance element is available for Residential Rental property only and limited to set child elements, petFriendly, furnished and smokers. Child elements can be yes/no and true/false.

See Also

petFriendly, furnished, smokers.

agentID

A 6 character identity code assigned by REA of the real estate agent providing the property data.

Also used to identify a conjunctional listingAgent

Validation

Six alphabetic characters long. If provided in mixed or lower case, the agentID will be internally converted to uppercase. The agentID must also be known to REA and be for an active subscribed agent.

Valid Examples

(Assuming the agent ID is active and known to REA.)

  • <agentID>ABCDEF</agentID>
  • <agentID>abcdef</agentID>

Invalid Examples

  • <agentID>ABC</agentID>
  • <agentID>ABC123</agentID>
  • <agentID>ABC 12</agentID>

airConditioning

Specifies if the listed property has air conditioning or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no air conditioning present within the property.

Valid Examples

  • <airConditioning>0</airConditioning>
  • <airConditioning>1</airConditioning>
  • <airConditioning>no</airConditioning>

Invalid Examples

  • <airConditioning>-1</airConditioning>
  • <airConditioning>3.5</airConditioning>

See Also

features.

alarmSystem

Specifies if the listed property has an alarm system or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no alarm system present within the property.

Valid Examples

  • <alarmSystem></alarmSystem>
  • <alarmSystem>0</alarmSystem>
  • <alarmSystem>1</alarmSystem>
  • <alarmSystem>no</alarmSystem>

Invalid Examples

  • <alarmSystem>-1</alarmSystem>
  • <alarmSystem>3.5</alarmSystem>

See Also

features.

annualRainfall

Descriptive text defining the annual rain fall for a rural property.

Validation

Descriptive text of up to 65535 characters long is accepted as valid.

Valid Examples

  • <annualRainfall>250 mm per annum</annualRainfall>
  • <annualRainfall>18 inches</annualRainfall>

See Also

ruralFeatures.

area

Represents a measurement of area being offered for sale / lease. The unit attribute must be given, and must have a value as defined in the DTD.

If the of attribute is omitted, then it is assumed to be total, meaning total area.

Validation

The area value must be a number greater than zero, with or without a decimal portion.

It is a mandatory requirement for commercial listings to specify a valid floor area. Where a commercial listing has separate areas of function, using the of attribute, these can be as warehouse, office or one of the otherArea values.

otherArea must be one of 'other', 'industrial', 'hard stand', 'showroom' or 'retail'.

Where no function has been specified, the area is assumed to be total area.

The unit attribute must be given, and must have a value as defined in the DTD.

Please note: The of attribute is only used on commercial listings and must be contained under the buildingDetails element.

Only commercial listings with an isMultiple value of 'yes' can specify an area range for when dealing with buildingDetails with an area "of" attribute equal to total. of="" . This indicates the smallest to largest floor spaces available in the one listing and must be done using the range element.

Valid Examples

  • <area unit="acre">2.5</area>
  • <area unit="squareMeter">750</area>
  • <area unit="acre"></area>
  • <area unit="square">23</area> <!-- total -->
  • <area of="warehouse" unit="square">11</area>
    <area of="hard stand" unit="square">12</area>
  • <area unit="squareMeter">
    <range>
    <min>880</min>
    <max>990</max>
    </area>

Invalid Examples

  • <area>2.5 acres</area>
  • <area unit="Square Metres">690</area>

See Also

buildingDetails, landDetails. range.

auction

If the property is up for auction an auction date should be specified.

Validation

Auction details will be processed but are only available/visible where the authority is set as auction.

Valid Examples

  • <auction date="2003-12-04T18:30" />

Invalid Examples

  • <auction date="13/12/03 1pm" />

See Also

Date and Time validation rules.

authority

The method of sale used by the listing agents for this property.

valuedescription
auctionThe property is offered for sale via auction at a particular date and time.
exclusiveThe property is "For Sale"
multilistThe property is "For Sale" and listed with multiple agents
conjunctionalThe property is "For Sale" and listed with multiple agents working together - sales commission is shared amongst agents
openMore than one real estate agent may be employed to sell the property. The owner pays a commission only to the agent who finds the buyer
saleMost common sale type - The property is offered for sale by negotiation.
setsaleThe property is offered for sale up to the set sale date.

Validation

The value attribute of the authority element must have a value equal to one of the values given in the above table.

Valid Examples

  • <authority value="auction" />
  • <authority value="sale" />

Invalid Examples

  • <authority value="lottery" />
  • <authority value="private tender" />

Holiday rental properties may have links to an external URI source of availability - generally in the form of an online calendar.

Rental holidays are limited to one availabilityLink URL only.

Validation

The href attribute of availabilityLink must be a valid availability calendar and must refer to an accessible resource. This is not to be used as a link to agent sites or any sites other than legitimate Availability calendars or availability information.

eg. <availabilityLink href="http://www.realestate.com.au/holidayavailability/property123cal.html"/>

To remove existing availabilityLink URL include the availabilityLink element, leaving the href empty.

eg. <availabilityLink href=""/>

balcony

Indicates whether the property has a balcony.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

bathrooms

The number of bathrooms in the property for sale. Ensuites should be included in the bathrooms value, however are tracked separately, see the ensuite element.

Validation

All new Residential and Rental properties must have a bathroom value. It will be incorrect to supply an empty element or the value 0.

New Rural listings may have a bathroom value of 0. This should only be if there is no residence on the property.

Valid Examples

  • <bathrooms>4</bathrooms>
  • <bathrooms>16</bathrooms>

Invalid Examples

  • <bathrooms></bathrooms>
  • <bathrooms>0</bathrooms>
  • <bathrooms>no</bathrooms>
  • <bathrooms>-1</bathrooms>
  • <bathrooms>3.5</bathrooms>

See Also

features, ensuite.

bedrooms

The number of bedrooms in the property for sale.

Validation

All new Residential and Rental properties must have a bedroom value. It will be incorrect to supply empty elements or 0. If the listing is a Studio with no bedrooms then the text Studio can be supplied for the element.

New Rural listings may have a bedroom value of 0. This should only be if there is no residence on the property.

Valid Examples

  • <bedrooms>Studio</bedrooms>
  • <bedrooms>4</bedrooms>
  • <bedrooms>16</bedrooms>

Invalid Examples

  • <bedrooms></bedrooms>
  • <bedrooms>0</bedrooms>
  • <bedrooms>-1</bedrooms>
  • <bedrooms>3.5</bedrooms>
  • <bedrooms>1 single, 3 double</bedrooms>

See Also

features.

bond

The amount of bond required for a tenancy property.

Validation

The bond value is validated the same as the price element.

broadband

Specifies if the listed property has Broadband Internet Available or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Broadband Internet Available present within the property.

Valid Examples

  • <broadband>0</broadband>
  • <broadband>1</broadband>
  • <broadband>no</broadband>

Invalid Examples

  • <broadband>-1</broadband>
  • <broadband>3.5</broadband>

See Also

features.

buildingDetails

This element contains information about the physical structure of the building for sale or rent. Area is displayed as Floor Area.

Validation

There are no special requirements for the buildingDetails element to be valid, except for all sub elements to be valid.

See Also

area, energyRating,

builtInRobes

Specifies if the listed property has Built-in Wardrobes or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Built-in Wardrobes present within the property.

Valid Examples

  • <builtInRobes>0</builtInRobes>
  • <builtInRobes>1</builtInRobes>
  • <builtInRobes>no</builtInRobes>

Invalid Examples

  • <builtInRobes>-1</builtInRobes>
  • <builtInRobes>3.5</builtInRobes>

See Also

features.

business

An established business for sale.

statusDescription
currentThe property has not yet been sold (or leased), and is still on offer.
withdrawnThe property is withdrawn from the market for whatever reason.
offmarketThis property is not currently on the market.
soldThe property has been sold.
leasedThe property has been leased or rented.

Validation

The modTime attribute follows the same validation rules as the date element.

businessCategory

A classification of the type of business listing.

business listings can have up to 3 different businessCategory values.

Validation

New business listings must have a valid businessCategory value and be one of a defined list of values.

See: Available businessCategory and businessSubCategory values

A maximum of 3 businessCategory values can be selected. For each business category, the name element is required and the id attribute refers to the sequence of the businessCategory and ranges from 1 - 3.

id 1 refers to main businessCategory.

Listings uploaded without an id attribute can only modify the main businessCategory.

Valid Examples

  • <businessCategory id="1">
      <name>Beauty/Health</name>
      <businessSubCategory>
         <name>Beauty products</name>
      </businessSubCategory>
    </businessCategory>
    <businessCategory id="2">
      <name>Retail</name>
      <businessSubCategory>
        <name>Health/Beauty</name>
      </businessSubCategory>
    </businessCategory>

businessLease

The cost to the business for its lease over a specified time period.

Validation

The businessLease value is validated the same as for the price element.

The period attribute must have a value as enumerated in the DTD.

businessSubCategory

Each businessCategory can have an associated businessSubCategory for more refined searching

See: Available businessCategory and businessSubCategory values

carSpaces

Lists how many car parking spots there are available at this commercial property or business.

Validation

The value must be a positive whole number, without any fractional component.

Valid Examples

  • <carSpaces>0</carSpaces>
  • <carSpaces>500</carSpaces>

Invalid Examples

  • <carSpaces>-1</carSpaces>
  • <carSpaces>one</carSpaces>

carports

For the property listing, the number of car spaces under carports.

Validation

A whole number greater than or equal to zero is accepted as valid. Alternatively, yes or true are accepted as one carport, while no or false are counted as none. An empty value is considered as there being no carport present within the property.

Valid Examples

  • <carports></carports>
  • <carports>0</carports>
  • <carports>1</carports>
  • <carports>2</carports>
  • <carports>no</carports>

Invalid Examples

  • <carports>-1</carports>
  • <carports>3.5</carports>

See Also

garages openSpaces

carryingCapacity

Describes the stock carrying capacity of the rural property.

Validation

Descriptive text of up to 65535 characters long is accepted as valid.

Valid Examples

  • <carryingCapacity></carryingCapacity>
  • <carryingCapacity>50 Breeders</carryingCapacity>
  • <carryingCapacity>400 Deer or 100 head of breeding Cattle</carryingCapacity>

See Also

ruralFeatures.

category

Declares the type of property this is.

Name
House
Unit
Townhouse
Villa
Apartment
Flat
Studio
Warehouse
DuplexSemi-detached
Alpine
AcreageSemi-rural
BlockOfUnits
Terrace
Retirement
ServicedApartment
Other

Validation

For a new property listing (residental, rental), there must be a category element.

The name attribute of the category element must have a value equal to one of the values given in the above table.

Invalid Examples

  • <category name="Residential" />
  • <category name="Commercial" />
  • <category name="Rural" /> (see also ruralCategory definitions).

commercial

A commercial property for sale.

statusDescription
currentThe property has not yet been sold (or leased), and is still on offer.
withdrawnThe property is withdrawn from the market for whatever reason.
offmarketThis property is not currently on the market.
soldThe property has been sold.
leasedThe property has been leased or rented.

Validation

The modTime attribute follows the same validation rules as the date element.

commercialAuthority

The method of sale used by the listing agent for this property.

Value Description
auction Sale by auction
eoiSale by Expression of Interest.
forsaleFor Sale
offersOffers to Purchase.
saleSale by Negotiation.
tenderSale by public tender by a particular date.

commercialCategory

A classification of the type of commercial property.

commercial properties can have up to 3 different commercialCategory values. The id attribute refers to the sequence of the commercialCategory and ranges from 1 - 3.

id 1 refers to main commercialCategory.

Validation

For a new commercial property listing, there must be a commercialCategory. It is an error for a commercial listing to omit a valid commercialCategory value.

A maximum of 3 commercialCategory values can be selected. Listings uploaded without an id attribute can only modify the main commercialCategory

The name attribute of the commercialCategory element must have a value as listed in the below table.

Value
Commercial Farming
Land/Development
Hotel/Leisure
Industrial/Warehouse
Medical/Consulting
Offices
Retail
Showrooms/Bulky Goods

 

commercialListingType

Declares the type of the listing - if the property is for sale, or lease.

A commercialListingType must be included for all new Commercial Properties. It will be incorrect for new Commercial listings not to have this element.

Note that Business listings are always processed as a sale; it is incorrect to use lease or both.

Validation

The value attribute must have one of sale, lease, or both.

commercialRent

For commercial properties, this element specifies the annual rent. The rent may be specificed as either a single figure, or as a rental range per square metre only (valid only if the 'isMultiple' attribute is set to yes), or both.

Note: If isMultiple is set to 'no' or omitted then omitting a single valid figure for commercialRent will result in an invalid listing.

Validation

  • The rent value is validated the same as for the price element.
  • The plusOutgoings attribute must be either yes or no.

Valid Examples

  • <commercialRent period="annual" tax="inclusive">
    <rentPerSquareMetre>
    <range>
    <min>88</min>
    <max>99</max>
    </range>
    </rentPerSquareMetre>
    </commercialRent>
  • <commercialRent period="annual" tax="inclusive">
    80000 <!-- a fixed value, or a range ... -->
    <rentPerSquareMetre>
    <range>
    <min>88</min>
    <max>99</max>
    </range>
    </rentPerSquareMetre>
    </commercialRent>

See Also

price, rentPerSquareMetre.

councilRates

Describes any annual council rates.

Validation

Descriptive text of up to 65535 characters long is accepted as valid.

Valid Examples

  • <councilRates></councilRates>
  • <councilRates>$1,200 per annum</councilRates>

country

The country where the listing is located.

Validation

The country may be expressed as a string of alphabetic characters and punctuation as long as the country name matches the formal english name listed in ISO 3166. Alternatively, the three-character or two-character ISO 3166 country code may be used.

Note, the value of country also affects the validation of state, postcode and suburb. If the country element is omitted or missing, the country is assumed to be Australia.

Valid Examples

  • <country>AUSTRALIA</country>
  • <country>AUS</country>
  • <country>NZ</country>
  • <country>IDN</country>

Invalid Examples

  • <country>AUST.</country>
  • <country>AUST</country>
  • <country>U.S.A.</country>
  • <country>UK</country> (perhaps you mean GB?)
  • <country>OZ</country>

See Also

address.

courtyard

Indicates whether the property has a courtyard.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

crossOver

A cross over is the part of the driveway outside of the property boundary between the boundary and the road provided by the local council. This element is used to indicate if a cross over is present on a vacant block of land.

Validation

The value attribute must have one of left, right or center.

Valid Examples

  • <crossOver value="left" />
  • <crossOver value="right" />

Invalid Examples

  • <crossOver />
  • <crossOver value="none" />

currentLeaseEndDate

The date any current lease on the property terminates.

Validation

The currentLeaseEndDate element follows the same validation rules as the date element.

date

A date value, with optional time. Please see the description of Date and Time data for a full description of what date and time formats are accepted, including examples.

dateAvailable

The date the property is available for occupation.

Validation

For new rental property listings, there must be a dateAvailable value. However, holiday rental listings may omit this value.

This element follows the Date and Time validation rules.

Invalid Examples

  • <dateAvailable>Now</dateAvailable>

See Also

holidayCategory.

deck

Indicates whether the property has a deck.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

depth

Represents a particular measurement of depth for the property.

side Description
leftThe left side of the property from the perspective of someone standing on the street frontage and facing inwards.
rightThe opposite side of the property from the left side.
rear The rear side of the property from the street frontage.

Validation

The frontage value must be a number greater than zero, with or without a decimal portion.

Valid Examples
  • <depth side="left">25</depth>
  • <depth unit="meter" side="rear">40</depth>
Invalid Examples
  • <depth>20 metres</depth>
  • <depth>18</depth>
  • <depth side="">99 meters</depth>
  • <depth side="topleft">-123 meters</depth>

description

The description of the property, able to include multiple paragraphs of text. This field is for plain text only. Our parser will remove any HTML tags submitted within this field.

Validation

Any amount of viewable text up to 65535 characters long is accepted as valid.

dishwasher

Specifies if the listed property has a Dishwasher or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Dishwasher present within the property.

Valid Examples

  • <dishwasher>0</dishwasher>
  • <dishwasher>1</dishwasher>
  • <dishwasher>no</dishwasher>

Invalid Examples

  • <dishwasher>-1</dishwasher>
  • <dishwasher>3.5</dishwasher>

See Also

features.

document

The document element is used to refer to a single PDF file. The file attribute may refer to an image file included in the zip file bundle that the XML file came in or a url attribute referring to an external URL where the document can be downloaded from.

Up to 10 PDF files can be attached to the listing. The id attribute refers to the sequence of the document and ranges from 1 -10.

If you wish to delete a document, then you only need to provide the id attribute. For example, to delete the second document:

<objects>
 <document id="2" />
<objects>

Validation

If a document is provided, then either the file attribute must point to a file within the zip bundle; or the url attribute points to an accessible file. If document data is provided, it MUST be a valid PDF format. Other document formats are not acceptable.

The title attribute refers to the title of the documents as displayed on the site. An example could be 'Listing Authority'.

The id attribute must be in the range 1 through 10.

The modTime attribute, if it exists, must follow the Date and Time validation rules.

Valid Examples
  • <objects>
     <document id="1" modTime="2007-01-01-12:00:00" title="Authority" file="section32.pdf" format="pdf"/> </objects>
  • <objects>
     <document id="1" modTime="2007-01-01-12:00:00" url="http://agencyX.com.au/title.pdf" format="pdf"/> </objects>

ecoFriendly

Indicates common eco friendly housing attributes.

Validation

The ecoFriendly element is limited to set child elements, solarPanels, solarHotWater, waterTank, greyWaterSystem. Child elements can be yes/no and true/false.

See Also

solarPanels, solarHotWater, waterTank, greyWaterSystem

email

Represents a single email address.

Validation

A valid email address consists of up to 60 characters.

ductedCooling

Specifies if the listed property has Ducted Cooling or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Ducted Cooling present within the property.

Valid Examples

  • <ductedCooling>0</ductedCooling>
  • <ductedCooling>1</ductedCooling>
  • <ductedCooling>no</ductedCooling>

Invalid Examples

  • <ductedCooling>-1</ductedCooling>
  • <ductedCooling>3.5</ductedCooling>

See Also

features.

ductedHeating

Specifies if the listed property has Ducted Heating or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Ducted Heating present within the property.

Valid Examples

  • <ductedHeating>0</ductedHeating>
  • <ductedHeating>1</ductedHeating>
  • <ductedHeating>no</ductedHeating>

Invalid Examples

  • <ductedHeating>-1</ductedHeating>
  • <ductedHeating>3.5</ductedHeating>

See Also

features.

energyRating

Indicates the energy efficiency rating of the property.

Validation

For Residential homes the value must be between 0.0 and 10.0 using 0.5 increments. This field is mandatory for Residential homes for sale and New homes for sale in the Australian Capital Territory and optional for other states.
For Commercial and Business listings the value must be between 0.0 and 5.0 using 0.5 increments. This is not mandatory for these listings.

See Also

buildingDetails.

Valid Examples

  • <energyRating>4.5</energyRating>
  • <energyRating /> (for residential sale properties outside of ACT)

Invalid Examples

  • <energyRating>6 stars</energyRating>
  • <energyRating>4.2</energyRating>

ensuite

The number of ensuites in the property for sale. Ensuites should be included in the bathrooms value also, however are tracked separately, see the bathrooms.

Validation

A whole number greater than or equal to zero is accepted as valid. Alternatively, yes or true are accepted as one ensuite, while no or false are counted as none. An empty element is considered to be no ensuite present within the property.

Valid Examples

  • <ensuite></ensuite>
  • <ensuite>0</ensuite>
  • <ensuite>1</ensuite>
  • <ensuite>13</ensuite>
  • <ensuite>yes</ensuite>

Invalid Examples

  • <ensuite>-1</ensuite>
  • <ensuite>3.5</ensuite>

See Also

features, bathrooms.

estate

Describes any housing estate development that this block of land belongs to.

evaporativeCooling

Specifies if the listed property has Evaporative Cooling or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Evaporative Cooling present within the property.

Valid Examples

  • <evaporativeCooling>0</evaporativeCooling>
  • <evaporativeCooling>1</evaporativeCooling>
  • <evaporativeCooling>no</evaporativeCooling>

Invalid Examples

  • <evaporativeCooling>-1</evaporativeCooling>
  • <evaporativeCooling>3.5</evaporativeCooling>

See Also

features.

exclusivity

The right acquired by the Agent to be the sole marketer of the property for sale. If exclusivity is "open" then the property is defined as "Open/General". The value must be one of "open" or "exclusive". If no value is supplied REA will default the value to "open"

Value Description
exclusiveThe property is listed exclusively by this agent.
openThe property can be listed by multiple agents.

Properties may have links to other material such as 360 degree views or virtual tours.

Residential listings can have 2 externalLink elements. commercial and business listings can have 3 externalLink elements.

Validation

The href attribute of externalLink must be a valid Online Tour URL, and must refer to an accessible resource. This is not to be used as a link to agent sites or any sites other than legitimate Online Tours.

eg. <externalLink href="http://www.realestate.com.au/onlinetours/VictoriaSt.tour"/>

To remove existing externalLinks, include the externalLink element, leaving the href empty.

eg. <externalLink href=""/>

extraFields

extraFields are only to be used by agreement with REA and are not for general provider use.

features

The property attributes applicable to the listing. The available features contained in the features element are applicable to each of the following categories as per the below table. Where marked this denotes if the feature listed is available and should be used. Where a feature from the list is delivered but not accepted for that category our system will skip that field:

Features type
land
rental
holidayRental
residential
rural
bedrooms integer
yes
yes
yes
yes
bathrooms integer
yes
yes
yes
yes
ensuite integer
yes
yes
yes
toilet integer
yes
yes
yes
livingArea integer
yes
yes
yes
garages integer
yes
yes
yes
yes
carports integer
yes
yes
yes
yes
remoteGarage boolean
yes
yes
yes
secureParking boolean
yes
yes
yes
study boolean
yes
yes
yes
dishwasher boolean
yes
yes
yes
builtinWardrobes boolean
yes
yes
yes
gym boolean
yes
yes
yes
workshop boolean
yes
yes
yes
rumpusRoom boolean
yes
yes
yes
floorboards boolean
yes
yes
yes
broadband boolean
yes
yes
yes
payTV boolean
yes
yes
yes
ductedHeating boolean
yes
yes
yes
ductedCooling boolean
yes
yes
yes
splitsystemHeating boolean
yes
yes
yes
hydronicHeating boolean
yes
yes
yes
splitsystemAircon boolean
yes
yes
yes
gasHeating boolean
yes
yes
yes
reverseCycleAircon boolean
yes
yes
yes
evaporativeCooling boolean
yes
yes
yes
airConditioning boolean
yes
yes
yes
alarmSystem boolean
yes
yes
yes
vacuumSystem boolean
yes
yes
yes
intercom boolean
yes
yes
yes
pool boolean
yes
yes
yes
poolInGround boolean
yes
yes
yes
poolAboveGround boolean
yes
yes
yes
spa boolean
yes
yes
yes
tennisCourt boolean
yes
yes
yes
balcony boolean
yes
yes
yes
deck boolean
yes
yes
yes
courtyard boolean
yes
yes
yes
outdoorEnt boolean
yes
yes
yes
shed boolean
yes
yes
yes
fullyFenced boolean
yes
yes
yes
yes
openFirePlace boolean
yes
yes
yes
openSpaces integer
yes
yes
yes
heating choice
hotWaterService choice
yes
yes
yes
insideSpa boolean
yes
yes
yes
outsideSpa boolean
yes
yes
yes
otherFeatures text
yes


fencing

Describes the state of the fencing on a rural property.

Validation

Descriptive text of up to 65535 characters long is accepted as valid.

Valid Examples

  • <fencing>Boundary and internal fencing all in good condition</fencing>

floorboards

Specifies if the listed property has Floorboards or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Floorboards present within the property.

Valid Examples

  • <floorboards>0</floorboards>
  • <floorboards>1</floorboards>
  • <floorboards>no</floorboards>

Invalid Examples

  • <floorboards>-1</floorboards>
  • <floorboards>3.5</floorboards>

See Also

features.

floorplan

Up to two floorplans may be provided per property. The floorplan element is used to refer to a single GIF or JPEG image file. The content of the floorplan element may be MIME Base64 encoded image data. Alternatively, the file attribute may refer to an image file included in the zip file bundle that the XML document came in. A third option is the url attribute referring to an external URL where the image can be sorced.

The id attribute refers to the sequence of the images.

If no image source is named or provided and was previously uploaded for the same id number then that image stored with REA will be deleted.

Validation

For the floorplan image to be valid:

  • If an image is provided, then either the image data must be inline, the file attribute must point to a file within the zip bundle; or the url attribute points to a valid and accessible image.
  • If image data is provided, it must be a valid GIF of JPEG format. Other image formats are not accepted.
  • The image file must not be greater than 100k bytes in physical size.
  • The id attribute must be either 1 or 2.
  • The modTime attribute, if it exists, must follow the Date and Time validation rules.
  • The modTime must be set correctly to the last time the actual image/file was adjusted.

See Also

img, objects.

frontage

Represents the measurement of frontage for the property. The unit attribute must be given.

Validation

The frontage value must be a number greater than zero, with or without a decimal portion.

Valid Examples
  • <frontage>18</frontage>
  • <frontage unit="meter">12.4</frontage>
Invalid Examples
  • <frontage>20 metres</frontage>

franchise

Is this business part of a Franchise?

Providing a franchise value of yes will ensure the listing is found in the franchise section of the site.

Accepted values: yes, no
Default: no

Valid Example
  • <franchise value="yes" />

fullyFenced

Indicates whether the property has a fence around the full perimeter.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

furnished

Specifies if the listed property is furnished or not.

Validation

1, yes, and true mean the property is furnished. 0, no, false and empty value mean the property is unfurnished.
All other values are invalid.

Valid Examples

  • <furnished></furnished>
  • <furnished>0</furnished>
  • <furnished>1</furnished>
  • <furnished>yes</furnished>

Invalid Examples

  • <furnished>-1</furnished>
  • <furnished>3.5</furnished>

furtherOptions

Text describing any further options for a business or commercial property.

Validation

Up to 65535 characters of text is accepted as valid.

garages

For the property listing, the number of car spaces within the garage(s).

Validation

A whole number greater than or equal to zero is accepted as valid. Alternatively, yes or true are accepted as one car space, while no or false are counted as none. An empty element is considered to be no garage present within the property.

Valid Examples

  • <garages></garages>
  • <garages>0</garages>
  • <garages>1</garages>
  • <garages>2</garages>
  • <garages>no</garages>

Invalid Examples

  • <garages>-1</garages>
  • <garages>3.5</garages>

See Also

carports.

greyWaterSystem

Specifies if grey water system is included for the listed property or not.

Validation

1, yes, and true mean grey water system is included. 0, no, false and empty value mean grey water system is not included. All other values are invalid.

Valid Examples

  • <greyWaterSystem>0</greyWaterSystem>
  • <greyWaterSystem>1</greyWaterSystem>
  • <greyWaterSystem>no</greyWaterSystem>

Invalid Examples

  • <greyWaterSystem>-1</greyWaterSystem>
  • <greyWaterSystem>3.5</greyWaterSystem>

See Also

ecoFriendly.

gasHeating

Specifies if the listed property has Gas Heating or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Gas Heating present within the property.

Valid Examples

  • <gasHeating>0</gasHeating>
  • <gasHeating>1</gasHeating>
  • <gasHeating>no</gasHeating>

Invalid Examples

  • <gasHeating>-1</gasHeating>
  • <gasHeating>3.5</gasHeating>

See Also

features.

gym

Specifies if the listed property has a Gym or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Gym present within the property.

Valid Examples

  • <gym>0</gym>
  • <gym>1</gym>
  • <gym>no</gym>

Invalid Examples

  • <gym>-1</gym>
  • <gym>3.5</gym>

See Also

features.

headline

A single line description of the property.

All property types must include a include a valid headline.

Validation

The headline may have up to 150 characters of alphabetic, numeric or punctuation characters. HTML tags will be removed if detected.

Valid Examples

  • <headline>Location! Location! Location!</headline>
  • <headline>Renovator's Delight!</headline>

heating

Specifies what type of heating the listed property has.

Validation

The type attribute must be one of gas, electric, GDH, solid, or other.

Valid Examples

  • <heating type="GDH" />

Invalid Examples

  • <heating type="nuclear" />

See Also

features.

holidayCategory

This element defines the principal rental holiday focus of the holiday property.

Name
House
Alpine
Apartment
Backpacker-Hostel
BedAndBreakfast
Campground
Caravan-HolidayPark
DuplexSemi-detached
ExecutiveRental
FarmStay
Flat
Hotel
House
HouseBoat
Lodge
Motel
Resort
Retreat
SelfContainedCottage
ServicedApartment
Studio
Terrace
Townhouse
Unit
Villa
Other (Any type of holiday rental property that does not fit into the above categories)

Validation

For a new property listing, there must be a holidayCategory element.

The name attribute of the holidayCategory element must have a value equal to one of the values given in the above table.

Invalid Examples

  • <holidayCategory name="Acreage/Semi Rural" />
  • <holidayCategory name="Warehouse" />

holidayRental

A property available as a holiday rental.

status Description
currentThe property has not yet been sold (or leased), and is still on offer.
withdrawnThe property is withdrawn from the market for whatever reason.
offmarketThis property is not currently on the market.
leasedThe property has been leased or rented.

Validation

The modTime attribute follows the Date and Time validation rules.

hotWaterService

Specifies what type of hot water the listed property has.

Validation

The type attribute must be one of gas, electric or solar.

Valid Examples

  • <hotWaterService type="gas" />

Invalid Examples

  • <hotWaterService type="geothermal" />

See Also

features.

idealFor

Coming Soon...

Indicates one or more situations/buyer types that the advertisied property would be suitable for. You may select one or many of the child elements.

Validation

The idealFor element is available for Residential and Rural listings and is limited to set child elements, firstHomeBuyer, investors, downsizing, couples, students, lrgFamilies, reitrees.

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no idealFor child element of selected type.

Valid Examples

  • <idealFor><couples>yes</couples><students>yes</students></idealFor>
  • <idealFor><couples>1</couples><students>no</students></idealFor>

Invalid Examples

  • <idealFor><couples>-1</couples></idealFor>
  • <idealFor><couples>3.5</couples></idealFor>

 

img

The img element is used to refer to a single JPEG image file. The content of the img element may be MIME Base64 encoded image data. Alternatively, the file attribute may refer to an image file included in the zip file bundle that the XML document came in, or a third option is the url attribute referring to an external URL where the image can be sourced from.

Please note: CMYK JPG images are not supported by our system and may be corrupted on the website. Please ensure your images are progressive RGB JPG to avoid corruption. Please note that Photoshop or other image editing software can be used to convert CMYK JPG images into RGB JPG images.

The id attribute refers to the sequence of the image. The m id is the main image displayed with the property, while a through to l are extra images, as are n through to z.

Please note: m is reserved for main only and each id can only be used once for each listing.

If you wish to delete an image, then you only need to provide the id attribute. For example, to delete the 'a' image:

<img id="a" />

If a valid main image is not provided the file will be rejected and the property will not be displayed on the site. Any attempt to remove a main image off an existing property will produce an error.

Please note: A floorplan does not consitute a property image.

Please note: The image modTime allows REA processing to identify and change only those images requiring changing. Failure to send an updated modTime only for those images updated will not allow for optimal file processing and can mean processing delays for your files. If REA identifies delays in processing of your files due to incorrect modTimes provided we will notify you requesting that you update your system. Images should not be set to the same modTime as the listing if they have not been modified since the original upload.

Please note: If images are provided as a URI and sourced by REA a delay in transfer from the server they are hosted on can result in delays processing files within your upload queue. If REA detects above avergae delays sourcing these images you will be notified if these delays cause a breach of the 4 hour processing standard.

Validation

For the image to be valid:

  • If an image is provided, then either the image data must be inline, the file attribute must point to a file within the zip bundle; or the url attribute points to a valid and accessible image.
  • If image data is provided, it must be a valid JPEG format. Other image formats are not acceptable.
  • The id attribute must be in the range a through z.
  • The modTime attribute must follow the Date and Time validation rules.

Valid Examples

  • <img id="m" modTime="2007-01-21-12:30:00" url="http://realestate.com.au/picsatrea.jpg" format="jpg" />
  • <img id="f" modTime="2007-01-21-12:30:00" file="picsatrea.jpg" format="jpg" />

See Also

floorplan, objects.

hydronicHeating

Specifies if the listed property has Hydronic Heating or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Hydronic Heating present within the property.

Valid Examples

  • <hydronicHeating>0</hydronicHeating>
  • <hydronicHeating>1</hydronicHeating>
  • <hydronicHeating>no</hydronicHeating>

Invalid Examples

  • <hydronicHeating>-1</hydronicHeating>
  • <hydronicHeating>3.5</hydronicHeating>

See Also

features.

improvements

Describes any improvements made to a rural property.

Validation

Descriptive text of up to 65535 characters long is accepted as valid.

Valid Examples

  • <improvements></improvements>
  • <improvements>Shearing shed, barn and machinery shed.</improvements>

See also

ruralFeatures.

insideSpa

Specifies whether the property has a spa inside the house.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

inspection

Used to specify a single open-for-inspection (OFI) timeslot.

Note: Must be contained within the parent element tags

Validation

Only the following format is accepted as valid: DD-MON-YYYY hh:mm to hh:mm

Valid Examples

  • <inspectionTimes>:
    <inspection>21-Dec-2006 11:00am to 1:00pm</inspection>
    <inspection>02-Jan-2006 12:00pm to 12:30pm</inspection>
    </inspectionTimes>

Invalid Examples

  • <inspection>By Appointment</inspection>
  • <inspection>12-1 Fridays and Saturdays</inspection>

See also

inspectionTimes.

inspectionTimes

The parent element in which inspection child elements should be contained.

Valid Examples

  • <inspectionTimes></inspectionTimes>

See also

inspection.

intercom

Specifies if the listed property has an intercom or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no intercom present within the property.

Valid Examples

  • <intercom></intercom>
  • <intercom>0</intercom>
  • <intercom>1</intercom>
  • <intercom>yes</intercom>

Invalid Examples

  • <intercom>-1</intercom>
  • <intercom>3.5</intercom>

See Also

features.

irrigation

Describes any developed irrigation on a rural property.

Validation

Descriptive text of up to 65535 characters long is accepted as valid.

Valid Examples

  • <irrigation></irrigation>
  • <irrigation>Electric pump from dam and bore.</irrigation>

See Also

ruralFeatures.

isHomeLandPackage

Indicates if the property has been newly built OR is a House and Land Package for sale.

This will also place the property as a 'New Home For Sale' on the website.

NOTE: Only Agents / Developers with 'New Homes' Subscriptions will see their listings in the 'New Homes For Sale' section of the website.

Validation

The value must be one of yes or no.

See Also

buildingDetails.

isMultiple

Available for commercial listings only. This field indicates if this advertisement is for a single or multiple properties. The element must contain a value attribute with either yes or no.

If the element is omitted for new listings then it is assumed that the commercial property listing is for a single property.

Valid Examples

  • <isMultiple value="yes" />
  • <isMultiple value="no" />

land

Represents a vacant undeveloped block of land available for sale.

status Description
currentThe property has not yet been sold (or leased), and is still on offer.
withdrawnThe property is withdrawn from the market for whatever reason.
soldThe property has been sold.
offmarket The property is no longer to be advertised

Validation

The modTime attribute follows the Date and Time validation rules.

landCategory

The intended use of the land.

Validation

The name attribute must be one of Commercial or Residential.

landDetails

Used to describe the physical attributes of the land being offered

See Also: area, frontage, depth and crossOver

listingAgent

Specified contact details for the listing agent/s.

residential listings can have 1 listingAgent.

commercial and business listings can have 2 listingAgent values associated with each listing from the same agentID, or alternatively, 3 conjunctional listingAgent values from other offices.

Validation

The id attribute refers to the sequence of the listingAgent and ranges from 1 - 4.

It is assumed that a listingAgent without an agentID or id attribute is the primary agent.

Conjunctional listingAgent values must use the id attribute 2, 3 or 4 and must provide a valid agentID

If you wish to delete a listingAgent, then you only need to provide the id attribute.

Valid Example
  • <listingAgent id="1">
      <name>Mr. Primary Lister</name>
      <telephone type="BH">05 1234 5678</telephone>
      <email>pl@somedomain.com.au</email>
    </listingAgent>
    <listingAgent id="2">
      <agentID>XNWSUR</agentID>
      <name>Mr. Conjunction Lister</name>
      <telephone type="BH">05 1234 5678</telephone>
      <email>cl@somedomain.com.au</email>
    </listingAgent>

See Also: name, agentID, email and telephone.

livingAreas

For the property listing, the number of living areas available on the property.

Validation

A whole number greater than or equal to zero is accepted as valid. Alternatively, yes or true are accepted as one living area, while no or false are counted as none. An empty element is considered to be no living area present within the property.

Valid Examples

  • <livingAreas></livingAreas>
  • <livingAreas>0</livingAreas>
  • <livingAreas>1</livingAreas>
  • <livingAreas>3</livingAreas>
  • <livingAreas>yes</livingAreas>

Invalid Examples

  • <livingAreas>-1</livingAreas>
  • <livingAreas>-3.5</livingAreas>

lotNumber

The prefix to the streetNumber of the listing.

Used by land and commercialLand listing types, this is in reference to a specified/allocated vacant undeveloped block of land.

Valid Example
  • <streetNumber>12</streetNumber>

max

Used to specify some kind of maximum value, generally as the upper bound of a range element.

See Also

min, range.

min

Used to specify some kind of minimum value, generally as the lower bound of a range element.

See Also

max, range.

miniweb

A URI linking to an external site that provides additional information about the property. Must only be used to link to site relevant to listing.

commercial and business listings can upload a maximum of 3 miniweb elements. The id attribute refers to the sequence of the miniweb and ranges from 1 - 3.

Validation

The miniweb must be a valid URI, and must refer to an accessible site.

Valid Example
  • <miniweb>
     <uri id="1">http://www.externalclientwebsite.com.au/101LonsdaleStreet.html</uri>
     <uri id="2">http:://www.externalclientwebsite.com.au/101LonsdaleStreetInterior.html</uri>
     <uri id="3">
    </miniweb>

municipality

Represents the local administrative entity for a clearly defined territory typically governed by a mayor and a city council or municipal council.

name

Represents, depending on the parent element, the name of a businessCategory, businessSubCategory, , estate, listingAgent, or vendorDetails.

Validation

Can only contain text.

Valid Examples
  • <name>Kermit the Frog</name>
  • <name>Swampview Lakes</name>

objects

Objects are files attachments to the property. Typically, they are binary files.

See Also

floorplan, img, documents.

openFirePlace

Specifies if the listed property has an open fire place or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no fire place present within the property.

Valid Examples

  • <openFirePlace></openFirePlace>
  • <openFirePlace>0</openFirePlace>
  • <openFirePlace>1</openFirePlace>
  • <openFirePlace>yes</openFirePlace>

Invalid Examples

  • <openFirePlace>-1</openFirePlace>
  • <openFirePlace>3.5</openFirePlace>

See Also

features.

openSpaces

For the property listing, the number of car spaces available on the property that are neither a garage or carport e.g. A paved uncovered tandem parking space would be considered 2 open spaces.

Validation

A whole number greater than or equal to zero is accepted as valid. Alternatively, yes or true are accepted as one car space, while no or false are counted as none. An empty element is considered to be no openSpaces present within the property.

Valid Examples

  • <openSpaces></openSpaces>
  • <openSpaces>0</openSpaces>
  • <openSpaces>1</openSpaces>
  • <openSpaces>3</openSpaces>
  • <openSpaces>yes</openSpaces>

Invalid Examples

  • <openSpaces>-1</openSpaces>
  • <openSpaces>-3.5</openSpaces>

See Also

carports or garages.

outdoorEnt

Indicates whether the property has an outdoor entertaining area available.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

otherFeatures

For all other features which do not fit within other feature elements in this XML schema, they can be listed here as comma-separated plain text.

Validation

Up to 100 characters of text is accepted as valid.

Valid Examples

  • <otherFeatures>balcony, courtyard, stables</otherFeatures>

See Also

features.

outgoings

Expenses incurred in generating income (rates, insurance, repairs etc)

Validation

The outgoings value is validated the same as for the price element.

outsideSpa

Specifies whether the property has a spa that is outside the house.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

page

Specifies a page number that a street map reference can be found upon. This field will soon be deprecated

See Also

streetDirectory, reference.

parkingComments

Alphanumeric string to describe or make comments about the parking

validation

Up to 255 characters permitted.

Valid Example
  • <parkingComments>Parking is monitored on each level</parkingComments>

password

REA assigned password provided by the XML provider to REA to identify themselves.

Validation

The password may be up to 20 characters long, with any mix of alphabetic, alphanumeric and is specified by REA. An unrecognised or mismatched username and password will result in rejection of your file.

payTV

Specifies if the listed property has Pay TV Access or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Pay TV Access present within the property.

Valid Examples

  • <payTV>0</payTV>
  • <payTV>1</payTV>
  • <payTV>no</payTV>

Invalid Examples

  • <payTV>-1</payTV>
  • <payTV>3.5</payTV>

See Also

features.

pool

Specifies if the listed property has a swimming pool or not.

To enable import of two pool types Pool will be deprecated in the near future and will be replaced with poolInGround and poolAboveGround. We recommend using these new elements.

The type attribute can be used to specify an inground or above ground swimming pool.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no pool present within the property.

This element is not valid if there is no pool, but a type of pool is specified. This element is valid if there is a pool, and type is one of inground or aboveground.

If there is a pool, but a type of pool is not defined, then the default type inground will be assumed.

Valid Examples

  • <pool></pool>
  • <pool>0</pool>
  • <pool>1</pool>
  • <pool>yes</pool>
  • <pool type="aboveground">yes</pool>

Invalid Examples

  • <pool>-1</pool>
  • <pool>3.5</pool>
  • <pool type="aboveground">no</pool>
  • <pool type="aboveground"></pool>

poolInGround

Specifies if the listed property has an inground swimming pool or not.

Validation

1, yes, and true mean in ground pool is included. 0, no, false and empty value mean in ground pool is not included. All other values are invalid.

Valid Examples

  • <poolInGround></poolInGround>
  • <poolInGround>0</poolInGround>
  • <poolInGround>1</poolInGround>
  • <poolInGround>yes</poolInGround>

Invalid Examples

  • <poolInGround>-1</poolInGround>
  • <poolInGround>3.5</poolInGround>

poolAboveGround

Specifies if the listed property has an above ground swimming pool or not.

Validation

1, yes, and true mean above ground pool is included. 0, no, false and empty value mean above ground pool is not included. All other values are invalid.

Valid Examples

  • <poolAboveGround></poolAboveGround>
  • <poolAboveGround>0</poolAboveGround>
  • <poolAboveGround>1</poolAboveGround>
  • <poolAboveGround>yes</poolAboveGround>

Invalid Examples

  • <poolAboveGround>-1</poolAboveGround>
  • <poolAboveGround>3.5</poolAboveGround>

petFriendly

Specifies if pets are allowed in the listed property or not.

Validation

1, yes, and true mean pets are allowed. 0, no, false and empty value mean pets are not allowed.
All other values are invalid.

Valid Examples

  • <petFriendly></petFriendly>
  • <petFriendly>0</petFriendly>
  • <petFriendly>1</petFriendly>
  • <petFriendly>yes</petFriendly>

Invalid Examples

  • <petFriendly>-1</petFriendly>
  • <petFriendly>3.5</petFriendly>

postcode

The postal code for the property.

Validation

The validation of Postcode is dependent upon the value of the country element and suburb.

For new Australian property listings, there must be a postcode value.

  • For properties in Australia, the postcode value must be a four digit number, which must also be present in the Australia Post Postcode database, http://www1.auspost.com.au/postcodes/.
  • For New Zealand properties, the postcode must be a four digit number. It is recommended the postcode be omited and suburb + region uniquely identify the location of the property.

Valid Examples

For Australia:

  • <postcode>3000</postcode>
  • <postcode>3217</postcode>
  • <postcode>0820</postcode>

Invalid Examples

For Australia:

  • <postcode>820</postcode>
  • <postcode>80210</postcode>
  • Any postcode between 2595 and 2599 (as at April 2003).

price

The price needs to be in the local currency for the property. For properties in Australia, the currency is assumed to be AUD$. For New Zealand listings it is NZD$.

commercial and business listings can specify whether or not GST is included in the price. This is done using the tax attribute.

business for sale listings may have a plusSAV attribute. If this attribute has the value yes, then the price includes the cost of any Stock At Valuation into the total purchase price given.

The display attribute controls if the price is to be displayed anywhere a buyer might see.

Only commercial listings with an isMultiple value of yes may use the range element.

Please Note: The display attribute controls if ANY pricing information is to be displayed on the site anywhere a visitor may see. This includes the display of the price and priceView fields. The priceView will display instead of price or commercialRent if a priceView value is present.

Validation

'For Sale' (including auction) property listings (business, land, residential, rural and commercial), there must be a price element.

The price value must be a number, with optional decimal places.

The display attribute must be one of yes or no, otherwise it may be omitted entirely. If it is yes, it is a validation error if there is no price.

It is a validation error for business sale listings to omit a tax value.

It is a validation error for a non-Business listing to have the plusSAV attribute equaling yes.

Valid Examples
  • <price>240000</price>
  • <price>1200000</price>
  • <price>199999.95</price>
  • For commercial listings only: <price>
    <range>
    <min>450000</min>
    <max>550000</max>
    </range>
    </price>
Invalid Examples
  • <price></price>
  • <price>0</price>
  • <price>$300000</price>
  • <price>1,500,000</price>
  • <price>250000-310000</price>
  • <price display="yes"></price>

See Also

range, priceView.

priceView

A human-readable string displayed to describe the price of the property.

The priceView will display instead of price or commercialRent if a priceView value is present.

Validation

Any mixture of up to 50 viewable alphabetic, numeric, or punctuation characters is accepted.

Valid Examples
  • <priceView>$200,000</priceView>
  • <priceView>Low $300,000's</priceView>
  • <priceView>Buyers above $700,000's</priceView>
  • <priceView>Price on request</priceView>
Invalid Examples
  • <priceView>123456789012345678901234567890123456789012345678901</priceView>

See Also: price.

propertyExtent

This field refers to the section of the building that is for lease. Is the whole building for lease or only a part - if none received - default to not applicable.

Accepted values: whole or part

Valid Example
  • <propertyExtent>whole</propertyExtent>
Invalid Example
  • <propertyExtent>half</propertyExtent>

purchaseOrder

Describes the billing purchase identifier used by an agent for property enhancements. This number will display on REA produced invoice statements

For property listings falling under the category of commercial, commercialLand or business..

XML Examples
  • <purchaseOrder>1234567890</purchaseOrder>
  • <purchaseOrder>abc123</purchaseOrder>

Validation

Any text up to 20 characters long is accepted as valid

range

Generally, this element is used to enclose a min and max value to specify a range of values.

Specifically, this element is only to be used for commercial property listings.

See Also

isMultiple, max, min, price, rentPerSquareMetre.

reference

Specifies a map reference upon a street directory map page that the property can be located upon. This element will be deprecated.

See Also

streetDirectory, page.

region

The region of the address is synonymous with the state, but is intended for use by New Zealand listings. New Zealand listings may omit the state element and replace it with region.

Validation

For New Zealand the following states/regions are accepted:

Accepted New Zealand Regions
AbbreviationDistrict
acklndAuckland
bypltyBay Of Plenty
cntbryCanterbury
crmndlCoromandel
gsbrneGisborne
hwkbayHawkes Bay
mnwtuManuwatu
mrlbghMarlborough
nlsnNelson
nthlndNorthland
nthotgNorth Otago
otgOtago
sthlndSouthland
stwislStewart Island
trnkiTaranaki
wktoWaikato
wlgtonWellington
wngnuiWanganui
wrapaWairarapa
wstcstWest Coast

remoteGarage

Defines whether the property has a remotely controlled garage door.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

rent

This describes the rental price for the property, including the period over which the rent amount applies, as well as whether to display the price or not.

Please note, Weekly Rental Price is mandatory for Residential Rental and Holiday Rental property types.

If you do not wish to show the Weekly Rental Price to the public, you can either hide the price by using the display attribute, or use the PriceView element to show additional information. However, if you choose to hide the price using the display attribute you can not have two conflicting instances of display.

Validation

  • The rent figure is validated the same as for the price element.
  • The period attribute must be one of week, month, weekly or monthly.
  • There can be multiple rent elements if you wish to specify a price for both monthly and weekly. However, at least one of the rent elements must be for a weekly period.
  • The display attribute must be one of yes or no, otherwise it may be omitted entirely. If it is yes, it is a validation error if there is no rent.
  • Only genuine values of 50 or greater are accepted.

Valid Examples

  • <rent period="week">120</rent>
  • <rent period="weekly">200</rent>
  • <rent display="no" period="weekly">200</rent>
  • <rent display="yes" period="weekly">250</rent>

Invalid Examples

  • <rent>120</rent>
  • <rent period="weekly">0</rent>
  • <rent period="weekly">null</rent>
  • <rent period="weekly" display="1">145</rent>
  • <rent period="weekly" display="No">180</rent>
  • <rent display="yes" period="weekly"></rent>

rentPerSquareMetre

Used within the commercialRent element to indicates the rent per square metre per annum for a commercial property listing. It is only relevant to listings with a commercialListingType value of lease or both.

Validation

It is a validation error to include a range that does not have both a min and max value.

Valid Examples

See commercialRent for valid examples.

See Also

commercialRent, range.

rental

A property available for rent.

status Description
currentThe property has not yet been sold (or leased), and is still on offer.
withdrawnThe property is withdrawn from the market for whatever reason.
offmarketThis property is not currently on the market.
leasedThe property has been leased or rented.

Validation

The modTime attribute follows the Date and Time validation rules.

residential

A residential property for sale.

status Description
currentThe property has not yet been sold (or leased), and is still on offer.
withdrawnThe property is withdrawn from the market for whatever reason.
offmarketThis property is not currently on the market.
soldThe property has been sold.

Validation

The modTime attribute follows Date and Time validation rules.

return

The annual rate of return in percentage provided by this listing.

The Return on Investment will only be displayed on the site if the tenancy value is tenanted

Validation

The rate of return must be a number, followed optionally by a decimal point and a decimal component.

Valid Examples
  • <return>5</return>
  • <return>11.2</return>
Invalid Examples
  • <return>5%</return>
  • <return>2.3%</return>
  • <return>$100,000</return>

reverseCycleAirCon

Specifies if the listed property has Reverse Cycle Air Conditioning or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Reverse Cycle Air Conditioning present within the property.

Valid Examples

  • <reverseCycleAirCon>0</reverseCycleAirCon>
  • <reverseCycleAirCon>1</reverseCycleAirCon>
  • <reverseCycleAirCon>no</reverseCycleAirCon>

Invalid Examples

  • <reverseCycleAirCon>-1</reverseCycleAirCon>
  • <reverseCycleAirCon>3.5</reverseCycleAirCon>

See Also

features.

rumpusRoom

Specifies if the listed property has Rumpus Room or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Rumpus Room present within the property.

Valid Examples

  • <rumpusRoom>0</rumpusRoom>
  • <rumpusRoom>1</rumpusRoom>
  • <rumpusRoom>no</rumpusRoom>

Invalid Examples

  • <rumpusRoom>-1</rumpusRoom>
  • <rumpusRoom>3.5</rumpusRoom>

See Also

features.

rural

A rural property.

status Description
currentThe property has not yet been sold (or leased), and is still on offer.
withdrawnThe property is withdrawn from the market for whatever reason.
soldThe property has been sold.
offmarket The property is not currently being advertised

Validation

The modTime attribute follows the Date and Time validation rules.

ruralCategory

This element defines the principal agricultural focus of the rural property.

Name
Cropping
Dairy
Farmlet
Horticulture
Lifestyle
Livestock
Viticulture
MixedFarming
OtherAny type of rural property that does not fit into the above categories.

Validation

The name attribute must have one of the values listed in the above table.

ruralFeatures

This element defines particular rural aspects of the rural property.

Validation

For child elements available under ruralFeatures see fencing, annualRainfall, soilTypes, improvements, councilRates, irrigation, carryingCapacity, services

 

secureParking

Indicates whether secure parking is available at the property.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

services

Describes any services supplied to a rural property.

Validation

Descriptive text of up to 65535 characters long is accepted as valid.

Valid Examples

  • <services></services>
  • <services>Power, Telephone. School Bus to Front Gate.</services>
  • <services>Power, phone, sealed road.</services>
  • <services>Power, telephone, airstrip, school bus, mail.</services>

shed

Indicates whether the property has a shed included.

Validation

Optional field. Possible values to indicate whether it exists are 1, yes or true. Setting it to 0, no or false will indicate that it does not exist. Leaving it undefined will maintain the current value.

site

0 - 50 alphanumeric characters to display the name or site of the commercial or business listing

Valid Example
  • <address>
     <site>Victoria Gardens Shopping Complex</site>
    </address>

smokers

Specifies if smokers are welcome in the listed property or not.

Validation

1, yes, and true mean smokers are welcome. 0, no, false and empty value mean smokers are not welcome.
All other values are invalid.

Valid Examples

  • <smokers></smokers>
  • <smokers>0</smokers>
  • <smokers>1</smokers>
  • <smokers>yes</smokers>

Invalid Examples

  • <smokers>-1</smokers>
  • <smokers>3.5</smokers>

soilTypes

Describes the soil of a rural property.

Validation

Descriptive text of up to 65535 characters long is accepted as valid.

Valid Examples

  • <soilTypes>red basalt</soilTypes>
  • <soilTypes>grey loams and dark clays</soilTypes>
  • <soilTypes>sand</soilTypes>

solarHotWater

Specifies if solar hot water is included for the listed property or not.

Validation

1, yes, and true mean solar hot water is included. 0, no, false and empty value mean solar hot water is not included. All other values are invalid.

Valid Examples

  • <solarHotWater>0</solarHotWater>
  • <solarHotWater>1</solarHotWater>
  • <solarHotWater>no</solarHotWater>

Invalid Examples

  • <solarHotWater>-1</solarHotWater>
  • <solarHotWater>3.5</solarHotWater>

See Also

ecoFriendly.

solarPanels

Specifies if solar panels are included for the listed property or not.

Validation

1, yes, and true mean solar panels are included. 0, no, false and empty value mean solar panels are not included. All other values are invalid.

Valid Examples

  • <solarPanels>0</solarPanels>
  • <solarPanels>1</solarPanels>
  • <solarPanels>no</solarPanels>

Invalid Examples

  • <solarPanels>-1</solarPanels>
  • <solarPanels>3.5</solarPanels>

See Also

ecoFriendly.

soldDate

soldDate indicates the date the property was sold. This should be the date the contract was signed and not the settlement date.

This element is invalid if the date has not yet passed.

This can only be included as an element of the soldDetails. Please see the description of Date and Time data for a full description of what date and time formats are accepted, including examples.

Valid Examples

  • <soldDate>2005-03-03</soldDate>
  • <soldDate>20050303T1500</soldDate>
  • <date>2005-03-03</date>

Invalid Examples

  • <soldDate>Yesterday</soldDate>

soldDetails

soldDetails must only be included if the property is sold and should include the soldDate and soldPrice

soldPrice

The price for which the property was sold. Indicates the actual sale price of the property as well as whether to display the price or not. This can only be included as an element of the soldDetails

NOTE: Negative sign will be ommited. For example, -250000 will be converted to 250000.

Validation

  • The soldPrice figure is validated the same as for the price element.
  • The display attribute must be one of yes, no or range, otherwise it may be omitted entirely. If it is omitted, we will assume the price is to be displayed.

Valid Examples

  • <soldPrice>250000</soldPrice>
  • <soldPrice display="no">250000</soldPrice>
  • <soldPrice display="yes">250000</soldPrice>
  • <soldPrice display="range">250000</soldPrice>
  • <price>250000</price>

Invalid Examples

  • <soldPrice display="yes"></soldPrice>

spa

Spa will be deprecated in the near future and will be replaced with insideSpa and outsideSpa.

Specifies if the listed property has a spa or not. The type attribute can be used to specify an inground or above ground spa.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no spa present within the property.

This element is not valid if there is no spa, but a type of spa is specified. This element is valid if there is a spa, and type is one of inground or aboveground.

If there is a spa, but a type of spa is not defined, then the default type inground will be assumed.

Valid Examples

  • <spa></spa>
  • <spa>0</spa>
  • <spa>1</spa>
  • <spa>yes</spa>
  • <spa type="aboveground">yes</spa>

Invalid Examples

  • <spa>-1</spa>
  • <spa>3.5</spa>
  • <spa type="aboveground">no</spa>
  • <spa type="aboveground"></spa>

splitSystemAirCon

Specifies if the listed property has Split-System Air Conditioning or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Split-System Air Conditioning present within the property.

Valid Examples

  • <splitSystemAirCon>0</splitSystemAirCon>
  • <splitSystemAirCon>1</splitSystemAirCon>
  • <splitSystemAirCon>no</splitSystemAirCon>

Invalid Examples

  • <splitSystemAirCon>-1</splitSystemAirCon>
  • <splitSystemAirCon>3.5</splitSystemAirCon>

See Also

features.

splitSystemHeating

Specifies if the listed property has Split-System Heating or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Split-System Heating present within the property.

Valid Examples

  • <splitSystemHeating>0</splitSystemHeating>
  • <splitSystemHeating>1</splitSystemHeating>
  • <splitSystemHeating>no</splitSystemHeating>

Invalid Examples

  • <splitSystemHeating>-1</splitSystemHeating>
  • <splitSystemHeating>3.5</splitSystemHeating>

See Also

features.

stage

Used for housing estates, describing what stage the release is part of.

state

The state or territory where the listed property is located.

Validation

For a new property listing (residential, rental, land), the state must have a value.

For properties in Australia, the state value must be one of (case is ignored): act, nsw, nt, qld, sa, tas, vic or wa.

See also

region, address.

street

Validation

All NEW Residential Rental and Residential property listings, must have a street value.

streetDirectory

The streetDirectory element allows a street directory map reference to be defined for the property. Typically, this map reference may be used to generate a map image for the property; or assist navigation to the property by potential buyers. This element will be deprecated.

Currently, two types of street map reference are recognized (as specfied in the type attribute of streetDirectory).

  • melways for Melbourne Melways Street Directory references
  • UBD for UBD Street directory references.

See Also

page, reference.

streetNumber

The number of the property on the street, not including the street name itself.

It is strongly urged that any unit/flat/apartment numbers are placed before the street number. The unit number should be separated from the street number by a forward slash '/'.

Validation

All Residential Rental and Residential Sale listings, must have a streetNumber.

Up to 20 characters of text are allowed.

Valid Examples

  • <streetNumber>12</streetNumber>
  • <streetNumber>LOT 4A</streetNumber>
  • <streetNumber>2/102</streetNumber>
  • <streetNumber>Unit 5, 102</streetNumber>
  • <streetNumber>7 &amp; 9</streetNumber>

Invalid Examples

  • <streetNumber>1234567890123456789012</streetNumber>
  • <streetNumber>7 & 9</streetNumber> (in general, any ' &' characters that you want to use must be encoded as ' &amp;' in an XML document)
  • 0 (zero is not considered a valid street number and will be rejected)

See Also

address, street.

study

Specifies if the listed property has Study or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Study present within the property.

Valid Examples

  • <study>0</study>
  • <study>1</study>
  • <study>no</study>

Invalid Examples

  • <study>-1</study>
  • <study>3.5</study>

See Also

features.

subNumber

The prefix to the streetNumber or lotNumber of the listing.

commercial and business listings, this is often in reference to the suite, shop, floor or factory number.

For residential listings, this is often in reference to the unit, flat or apartment number.

Can be derived from the streetNumber field or sent as a value on its own

Validation

Listings can be uploaded with a subNumber as a separate field, or it can be included as part of the streetNumber element but cannot include both.

suburb

The name of the suburb or town where the property is physically located.

Business and Commercial listings may hide their suburb (and implicitly all of their address) from the buyer by setting the display attribute to no.

Validation

For a new property listing there must be a suburb value.

For listings where the country is Australia, the suburb must be listed in the Australia Post Postcode database. This database is available at http://www1.auspost.com.au/postcodes/.

The suburb element is invalid if display is no and the listed property is not either business or commercial.

Valid Examples

  • <suburb>Melbourne</suburb>
  • <suburb>MOUNT GAMBIER</suburb>
  • <suburb>NORTHBRIDGE</suburb>
  • <suburb display="no">Brisbane</suburb>

Invalid Examples

  • <suburb>MT GAMBIER</suburb>
  • <suburb>TIMBUCKTOO</suburb>
  • <suburb display="no" />
  • <suburb display="">Brisbane</suburb>

See Also

address, municipality, postcode.

takings

A description of the takings for the business.

tax

Sale Tax

business listings must specify a GST or whether a GST is applicable.

Accepted values: unknown, exempt, inclusive or exclusive
Default: unknown

Valid Examples
  • <price tax="exempt">295000</price>
  • <commercialRent period="annual" tax="inclusive">30000</commercialRent>

telephone

Represents a single telephone number. Area code must be included, international country prefix is optional.

Validation

A valid phone number consists of up to 40 numeric or whitespace characters. The phone number may optionally be prefixed with a plus character and country IDD code.

The type attribute must be one of BH, AH or mobile.

tenancy

Indicates whether or not the listing is a Vacant possession or Tenanted Investment. This is used for 'Tender' searching on the consumer side.

Accepted values: unknown, vacant or tenanted
Default: unknown

tennisCourt

Specifies if the listed property has a tennis court or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no tennis court present within the property.

Valid Examples
  • <tennisCourt></tennisCourt>
  • <tennisCourt>0</tennisCourt>
  • <tennisCourt>1</tennisCourt>
  • <tennisCourt>yes</tennisCourt>
Invalid Examples
  • <tennisCourt>-1</tennisCourt>
  • <tennisCourt>3.5</tennisCourt>

terms

Describes the sale terms of the property.

Validation

300 characters permitted.

Valid Example
  • <terms>60 day settlement</terms>

toilets

For the property listing, the number of toilets available on the property.

Validation

A whole number greater than or equal to zero is accepted as valid. Alternatively, yes or true are accepted as one toilet, while no or false are counted as none. An empty element is considered to be no toilet present within the property.

Valid Examples

  • <toilets></toilets>
  • <toilets>0</toilets>
  • <toilets>1</toilets>
  • <toilets>3</toilets>
  • <toilets>yes</toilets>

Invalid Examples

  • <toilets>-1</toilets>
  • <toilets>-3.5</toilets>

underOffer

Describes if the property is currently under any offers.

Validation

The value attribute of underOffer must be one of yes or no.

Valid Examples

  • <underOffer value="yes" />
  • <underOffer value="YES" />
  • <underOffer value="no" />

Invalid Examples

  • <underOffer value="0" />
  • <underOffer value="1" />

uniqueID

Information supplied by the XML provider to uniquely identify a property for update. The value must be unique for the real estate agent (different agents may use the same uniqueID, representing different properties).

Validation

Arbitary text with any mix of alphabetic, numeric, or punctuation; up to 50 characters long.

Valid Examples

  • <uniqueID>1234567890</uniqueID>
  • <uniqueID>buckingham palace</uniqueID>

Invalid Examples

  • <uniqueID>123456789012345678901234567890123456789012345678901</uniqueID>

username

The identity of the XML provider.

Validation

The username may be from one to ten characters long, of alphabetic characters only (no digits or whitespace are permitted). The named account must also exist and be active at RealEstate.com.au.

Valid Examples

(Assuming the accounts at RealEstate.com.au also exist and are active.)

  • <username>kermit</username>
  • <username>gonzo</username>

Invalid Examples

  • <username>miss piggy</username>
  • <username>lilypondrealestate</username>

vacuumSystem

Specifies if the listed property has a built-in ducted vacuum system or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present.

Valid Examples

  • <vacuumSystem>0</vacuumSystem>
  • <vacuumSystem>1</vacuumSystem>
  • <vacuumSystem>no</vacuumSystem>

Invalid Examples

  • <vacuumSystem>-1</vacuumSystem>
  • <vacuumSystem>3.5</vacuumSystem>

vendorDetails

Contains contact details for the vendor selling this property. See name, telephone, email

Properties may have links to a video display of the listing.

Validation

The href attribute of videoLink must be a valid Video URL, and must refer to an accessible resource. This is not to be used as a link to agent sites or any sites other than legitimate Video Files.

eg. <videoLink href="http://www.realestate.com.au/videos/VictoriaSt.avi"/>

To remove an existing videoLink, include the videoLink element, leaving the href empty.

eg. <videoLink href=""/>

views

Coming Soon...

Indicates the views, scenic or otherwise available from the property.

Validation

The views element is available for Residential, Rental, Rural and Land listings and is limited to set child elements, city, water, valley, mountain, ocean.

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no view of selected type present.

Valid Examples

  • <views><city>yes</city><valley>yes</valley></views>
  • <views><city>1</city><valley>no</valley></views>

Invalid Examples

  • <views><city>-1</city></views>
  • <views><city>3.5</city></views>

waterTank

Specifies if water tank included for the listed property or not.

Validation

1, yes, and true mean water tank is included. 0, no, false and empty value mean water tank is not included. All other values are invalid.

Valid Examples

  • <waterTank>0</waterTank>
  • <waterTank>1</waterTank>
  • <waterTank>no</waterTank>

Invalid Examples

  • <waterTank>-1</waterTank>
  • <waterTank>3.5</waterTank>

See Also

ecoFriendly.

workshop

Specifies if the listed property has Workshop or not.

Validation

A whole number greater than or equal to zero is accepted as valid. Any value greater than 1 is considered to be 1. Alternatively, yes or true are accepted, while no or false are counted as not present. An empty value is considered as there being no Workshop present within the property.

Valid Examples

  • <workshop>0</workshop>
  • <workshop>1</workshop>
  • <workshop>no</workshop>

Invalid Examples

  • <workshop>-1</workshop>
  • <workshop>3.5</workshop>

See Also

features.

zone

Describes the land-use zoning for this property.

Validation

Up to 150 characters of alphabetic, numeric or punctuation is accepted as valid.

Valid Examples

  • <zone>light industrial</zone>
  • <zone>FUTURE INDUSTRY</zone>
  • <zone>low density residential</zone>

Subscriber-Only Fields

  • marketing
  • upgrade
  • presentation
  • style
  • duration

These fields are only available for subscribers - contact REA for more information.


Common Data Types

Various elements used by REAXML use common data types described below.

Dates and Times

Several ISO8601 date-time formats are accepted. An indicative list of accepted formats follows.

  • YYYY-MM-DD
  • YYYY-MM-DD-hh:mm
  • YYYY-MM-DD-hh:mm:ss
  • YYYY-MM-DDThh:mm
  • YYYY-MM-DDThh:mm:ss
  • YYYYMMDD
  • YYYYMMDD-hhmm
  • YYYYMMDD-hhmmss
  • YYYYMMDDThhmm
  • YYYYMMDDThhmmss

January is month 1, December month 12. The year value must be four digits, not two. No time zone is assumed nor implied.

Validation

A date/time is accepted as valid if the format of the date string is well formed, the day of month is within the correct range of values depending on the year and month, and all other values are within the ranges as described below.

  • YYYY must be a four-digit year. Two digit abbreviations are not accepted.
  • MM is the month number in the range 01 through 12 (zero-padded to two digits).
  • DD is the day of the month in the range 01 through 28, 29, 30 or 31, as appropriate for the month (zero-padded to two digits).
  • hh is the hour of the day, in the range 00 through 23 (zero-padded to two digits).
  • mm is the minute of the hour, in the range 00 through 59 (zero-padded to two digits).
  • ss is the second of the minute, in the range 00 through 59 (zero-padded to two digits). Leap-seconds will be ignored.

Valid Examples

  • 2003-04-01-12:30:00
  • 2003-12-16
  • 20040229T1500

Invalid Examples

  • 1 January 2003
  • Now
  • last monday
  • 03-04-05
  • 2003-16-04
  • 2003-02-29 (2003 is not a leap year)
  • 2003-01-02 1pm
  • 06-07-2003 12:13
  • 19-Jul-2003 11:30 am
  • 04/08/03-15:00:00 (does it mean 3 August 2004, or 4 August 2003?)

XML Parser Errors

During the REAXML import process, the XML parser and data validator may produce a number of errors. The errors are listed and described below. For errors with property data, each error message is prefaced with the uniqueID value for that property.

Invalid postcode for suburb: "suburb"

The Suburb provided in the XML file does not match the correct postcode. REAXML cross references postcodes by using the Australia Post Suburbs and Postcodes Database found at http://www1.auspost.com.au/postcodes/.

New properties require price values

A price value must be supplied for all NEW listings uploaded to realestate.com.au. This is to ensure search results return valid and applicable listings.

New rental properties require a dateAvailable

A dateAvailable value must be supplied for all NEW rental listings to illustrate when a property is available.

New properties require bedrooms value

The number of bedrooms that a property has must be supplied for all NEW listings. This is a searchable field on realestate.com.au and as such needs to contain correct information to ensure search results are accurate.

New properties require bathrooms value

The number of bathrooms that a property has must be supplied for all NEW listings. This is a searchable field on realestate.com.au and as such needs to contain correct information to ensure search results are accurate.

Image id is not JPEG (image/jpeg) format

The image that was uploaded is not in JPEG format. TIFF or other formats are not accepted for property photographs. If you are getting this error, and the filename has the extension .jpg or .jpeg please ensure the file is actually a JPEG file, and not some other image format saved with the wrong extension.

Invalid element: "value"

The named element from the XML file has an value that does not pass its validation requirements. A reason may be offered, alternatively look up the element dictionary for what is expected and accepted.

Invalid element attribute: "value"

The named attribute of an element from the XML file has an value that does not pass its validation requirements. Look up the element dictionary for what is expected and accepted.

No agentID provided

A agentID element exists in the XML file, but it has no value. A property cannot be imported without knowing which real estate agent it is from.

Not permitted to modify properties for agentID agentID

The user that is providing the XML data does not have permission to create or modify properties for the named agent.

Cannot accept a element1without a valid element2

The validity of one element depends on the validity of another. For example, it is not possible to decide if a particular state or territory is valid without first knowing what country the property is in. The value provided for the state in this example might be valid, but it is not possible to know until the country is resolved.

New type properties require element value

New property listing of the specified type require a value for the named element, but no value was found.

Change History

1 Oct 2010

  • Added new element of energy rating for commercial and business listings.

2 Feb 2010

25 Nov 2009

23 Jun 2009

  • Removed deprecated 'newlyBuilt' element. Please use isHomeLandPackage to indicate if the property is a 'New Home For Sale' or a 'House and Land Package for sale'.

1 May 2009

1 April 2009

  • Added category type specifically for holiday rentals. This replaces the use of the rental 'holiday' attribute which will be discontinued in future but remains for backwards compatibility. 'holidayRental' function with their own holiday Categories.

16 March 2009

  • Added the exclusivity element for commercial and business listings. This is a mandatory element which determines if the listing sent is open or exclusive. The detail is not seen on the consumer website.

5 March 2009

  • Added the purchaseOrder element for commercial, commericalLand and business listings. This is a currently optional element, purely for the agent's convenience in tracking depth product purchases on REA invoices to specific purchase orders.

28 April 2008

  • Removed obsolete netProfit and currentRent elements.

15 November 2007

18 March 2007

28 February 2007

18 January 2007

A number of changes were made due to the redesign of the 'RealCommercial' websites to accomodate the intergration of the 'Property Look' websites after the 2006 acquisition and to accomodate market needs. These are listed in the table below.

New Fields Available

  • A number of new fields were implemented
FieldChange Summary
subNumber The prefix to the streetNumber or lotNumber of the property.
document Up to 10 PDF files can be attached to commercial and business listings.
franchise Ability to enter a business listing in the franchise section of the site.
miniweb commercial and business listings can upload a maximum of 3 miniweb elements.
parkingComments Alphanumeric string to describe or make comments about the parking.
propertyExtent Refers to the section of the building that is for lease.
site 0 - 50 alphanumeric characters to display the name or site of the commercial or business listing.
tax Sale Tax
tenancy Indicates whether or not the listing is a Vacant possession or Tenanted Investment
terms Describes the sale terms of the property.

Updated Fields

  • A number of changes were made to existing REA XML Fields
FieldChange Summary
addressNew sub-elements available, subNumber and site
areacommercial listings can have separate areas of function
agentIDNow also used to identify a conjunctional listingAgent on commercial and business listings
businessCategoryNew Categories, available.   Other has been deprecated.
business listings can have up to 3 different businessCategory values.
businessSubCategoryNew Sub-Categories, available. A number of sub-categories deprecated.
businesslistings can now have up to 3 different businessSubCategory values.
commercialAuthorityNew Authority 'offers' available
commercialCategory New Categories, available.   Other has been deprecated, all listings uploaded as 'Other' will be mapped to the 'Retail' commercialCategory.
commercial listings can have up to 3 different commercialCategory values.
externalLinkcommercial and business listings can now have 3 externalLink elements.
listingAgentcommercial and business listings can have up to 4 listingAgent values.
pricecommercial and business listings can specify whether or not GST is included in the price. This is done using the tax attribute.
returnThe Return on Investment will be displayed on the site if the tenancy value is tenanted.

24 October 2005

  • rent element is allowed to appear multiple times to allow for a monthly and a weekly variant. However at least one instance of the rent element must be for the weekly period.

22 September 2005

15 September 2005

10 June 2005

4 April 2005

  • description became a compulsory field for all property types.
  • headline became a compulsory field for all property types.
  • All new properties must be sent with one main 'm' image. If a valid main image isn’t provided the file will be rejected and the property will not be displayed on realestate.com.au or realcommercial.com.au. Any attempt to remove a main image off an existing property will produce an error and any properties currently without any main image will produce and error the next time any attempt to update them is submitted.

23 August 2004

  • category became a compulsory field, effective 23-08-2004
  • Duplex and Demi-detached have been renamed and merged to DuplexSemi-detached
  • Acreage and Semi-rural have been renamed and merged to AcreageSemi-rural
  • streetNumber became a compulsory field for Residential and Rental Properties. The element must be populated with a valid streetNumber and not empty.
  • street became a compulsory field for Residential and Rental properties. The element must be populated or not empty.
  • bedrooms will became a compulsory field. If the listing is a Studio then Studio can be entered for the element data otherwise a whole number must be supplied.
  • bathrooms became a compulsory field. The element must include a whole number. It will be invalid if the element is empty.
  • commercialListingType became a compulsory field. All listings must have this element included.

22 June 2004

  • priceView element maximum content length increased from 40 to 50 characters.

4 June 2004

  • headline element maximum content length increased from 120 to 150 characters.

3 June 2004

  • The type attribute of the externalLink element is deprecated and will be ignored.
  • The dateAvailable element manditory for new rental property listings.
  • Rental (and holiday rentals) now may have a priceView.
  • rent may have a display attribute.