XML feed format for homes

These are some simple guidelines for the creation of a XML file to include ads from your site in OneKit. If you need more information about the XML format you can check the Wikipedia.

The XML file has one ‘OneKit’ tag, and one or more ‘ad’ elements. Each ‘ad’ element has the following fields:

  • url: URL of the ad on your website (required)
  • title: title of the ad (required)
  • type: type of the ad: “For rent” or “For sale” (required)
  • agency: name of the agency (optional)
  • content: content of the ad (required)
  • price: sale or rent price of the home
  • house_type: appartment, loft, house, etc. (optional)
  • floor_area: area of the property, either in square feet or square meters (optional).
  • bedrooms: number of bedrooms (optional)
  • bathrooms: number of bathrooms (optional)
  • parking: number of parking places (optional)
  • address: address (optional)
  • city: city name
  • region: name of the region/county/state (optional)
  • postcode: postcode (optional)
  • latitude: latitude (optional)
  • longitude: longitude (optional)
  • pictures: URLs of the pictures for this ad, see information below
  • date: date of the ad in the following format: DD/MM/YYYY

pictures: the ‘ad’ element may containt a set of ‘picture’ fields a part of the ‘pictures’ tag.
The tags of each ‘picture’ element are:

  • picture_title: title of the picture (optional)
  • picture_url: URL of the picture on your site

The XML feed would look like this:

<?xml version=”1.0″ encoding=”utf-8″?>
<onekit>

    <ad>
        <url><![CDATA[...]]></url>
        <title><![CDATA[...]]></title>
        <type><![CDATA[...]]></type>
        <agency><![CDATA[...]]></agency>
        <content><![CDATA[...]]></content>
        <price><![CDATA[...]]></price>
        <house_type><![CDATA[...]]></house_type>
        <floor_area><![CDATA[...]]></floor_area>
        <bedrooms><![CDATA[...]]></bedrooms>
        <bathrooms><![CDATA[...]]></bathrooms>
        <parking><![CDATA[...]]></parking>
        <address><![CDATA[...]]></address>
        <city><![CDATA[...]]></city>
        <region><![CDATA[...]]></region>
        <postcode><![CDATA[...]]></postcode>
        <latitude><![CDATA[...]]></latitude>
        <longitude><![CDATA[...]]></longitude>
        <pictures>
            <picture>
                <picture_url><![CDATA[...]]></picture_url>
                <picture_title><![CDATA[...]]></picture_title>
            </picture>
            <picture>
                <picture_url><![CDATA[...]]></picture_url>
                <picture_title><![CDATA[...]]></picture_title>
            </picture>
            …
        </pictures>
        <date><![CDATA[...]]></date>
    </ad>

    <ad>
        ….
    </ad>

    <ad>
        ….
    </ad>

    …

</onekit>

You can copy and paste the previous code and use it as a template for your XML file

Example XML feed

<?xml version=”1.0″ encoding=”utf-8″?>
<onekit>

    <ad>
           <url><![CDATA[http://www.yourdomain.com/ad/7004578]]></url>
           <title><![CDATA[Chelsea Gate, London, SW1W]]></title>
           <type><![CDATA[For rent]]></type>
           <agency><![CDATA[Agencia Inmobiliaria]]></agency>
           <content><![CDATA[A very spacious three bedroom flat
        on a modern development]]></content>
           <price><![CDATA[800]]></price>
           <house_type><![CDATA[Flat]]></house_type>
           <floor_area><![CDATA[300]]></floor_area>
           <bedrooms><![CDATA[3]]></bedrooms>
           <bathrooms><![CDATA[1]]></bathrooms>
           <parking><![CDATA[0]]></parking>
           <address><![CDATA[]]></address>
           <city><![CDATA[London]]></city>
           <region><![CDATA[London]]></region>
           <postcode><![CDATA[BR1]]></postcode>
           <latitude><![CDATA[51.496401]]></latitude>
           <longitude><![CDATA[-0.179]]></longitude>
           <pictures>
               <picture>
                   <picture_url><![CDATA[http://www.yourdomain.co.uk/image.jpg]]></picture_url>
                   <picture_title><![CDATA[living room]]></picture_title>
              </picture>
           </pictures>
           <date><![CDATA[31/10/2005]]></date>
    </ad>

    <ad>
           <url><![CDATA[http://www.yourdomain.com/ad/332A53BC2]]></url>
           <title><![CDATA[Brand new flat in Shadwell, London]]></title>
           <type><![CDATA[For sale]]></type>
           <content><![CDATA[A brand new flat, located on the third floor
        of a sought after apartment building]]></content>
           <price><![CDATA[209950]]></price>
           <address><![CDATA[]]></address>
           <city><![CDATA[London]]></city>
           <region><![CDATA[London]]></region>
           <postcode><![CDATA[BR1]]></postcode>
           <pictures>
               <picture>
                    <picture_url><![CDATA[http://www.yourdomain.co.uk/image.jpg]]></picture_url>
                    <picture_title><![CDATA[living room]]></picture_title>
               </picture>
           </pictures>
           <date><![CDATA[31/10/2005]]></date>
    </ad>

</onekit>