XML API (Deprecated)

The Zoo Property XML API was the first API created for Zoo Property and allows web developers to access an xml data feed for all the properties and team member information for a real estate office.

If you are a web developer who is building a real estate application using WordPress then we have a free wp plugin which imports the property listing and team member information for the XML to a WordPress database. You can download the latest version of this plugin XmlToArray.

Overview of XML API

Each office has 3 different XML’s which a web developer can access.

  • Property Listing XML - Contains all the information entered into the Zoo Property system for each type of property.
  • Team Member XML - Contains all the information entered into the Zoo Property system for each agent/team member for the office.
  • Office Details XML - Contains all the information entered into the Zoo Property system in relation to Office Details.

Accessing XML API

You can access either XML for each office through the following urls and inserting the office id on the end of the string.

When attempting to access an XML you will be prompted to enter a 40 digit encrypted Access Key followed by a 40 digit encrypted Private Key. Once these keys are inserted you will have continuous and updated access to any data entered into the Zoo Property database for that office.

When you add a client in the Developer’s System an Access and Private Key will automatically be generated which can be viewed in the details for that client. These Access and Private Keys are used to access all XML’s for ALL of the offices created under that Client.

Accessing XML using PHP:

To access the API include this function to your code:

  1. //Get data from specific API
  2. //$base_url = URL of API
  3. //$accesskey = accesskey for the API
  4. //$privatekey = privatekey for the API
  5. function getdata($base_url, $accesskey, $privatekey)
  6. {
  7. $ch = curl_init();
  8. curl_setopt($ch, CURLOPT_URL, $base_url);
  9. curl_setopt($ch, CURLOPT_USERPWD, $accesskey . ':'.$privatekey);
  10. curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
  11. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
  12. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  13. $data = curl_exec($ch);
  14. curl_close($ch);
  15. echo $data;
  16. }

How to use:

-Call the function getdata by passing API url, accesskey and private key

Example:

  1. getdata("http://api.agentaccount.com/api/properties?office_id=15/","d5d69029db49466fa213dd6e04af284906161456", "24d80380e213c8eec87c662996d02c74da0bbf81");

XML Elements

Definitions of Elements

additional_notes

Relates only to BusinessSale, Commercial & HolidayLease listing types and are notes which can be added in addition to the listing descriptions.
Top


all-the-building

Relates only to Commercial listing types and refers to whether the premises to be leased/sold includes the entire building.
Top


all-the-floor

Relates only to Commercial listing types and refers to whether the premises to be leased/sold includes the entire floor.
Top


annual-ebit

Relates only to BusinessSale listing types and refers to the Annual Earnings Before Interest & Tax for the business.
Top


annual-gross-profit

Relates only to BusinessSale listing types and refers to the Annual Gross Profit for the business.
Top


annual-outgoings

Relates only to Commercial listing types and refers to the annual outgoings/overheads/expenses (outside or ordinary rent) paid to maintain the premises.
Top


annual-outgoings-include-tax

Relates only to Commercial listing types and refers to whether the annual-outgoings include tax.
Top


annual-turnover

Relates only to BusinessSale listing types and refers to the annual turnover (total revenue) for the business.
Top


approximate-stock-value

Relates only to BusinessSale listing types and refers to the estimated value of the stock/goods on hand which the business owns.
Top


auction-date

The future date for when the Auction of the property will be held.
Top


auction_place

The location where the Auction of the property will be conducted.
Top


auction_time

The time which the Auction will commence.
Top


bathrooms

The number of the bathrooms the property includes.
Top


bedrooms

The number of bedrooms the property includes.
Top


bond

Relates only to ResidentialLease, Commercial & HolidayLease listings types and refers to the amount of bond/deposit payable in advance to lease the property.
Top


brochure

Any pdf attachment which is included with the property listing.

Note: each brochure loaded to the Zoo Property system is resized to large, medium and thumbnail image.
Top


building-name

Relates only to Commercial listing types and refers to the name of the building which the premises is located in.
Top


business-name

Relates only to BusinessSale listing types and refers to the current business/trading name.
Top


carport-spaces

The number of carport cpaces or sheltered car spaces which are not fully enclosed that the property includes.
Top


category

Relates only to BusinessSale and ProjectSale listing types.

  • BusinessSale refers to what type of specific activity the business is involved with.
  • Project Sale refers to the type of sales package being offered.
  • - Land Packages
    - House Packages
    - House & Land Packages
    - Apartment Packages

Top


cleaning-fee

Relates to HolidayLease listing types and refers to the cleaning fee payable when a tenant vacates the property.
Top


condo-strata-fee

The fees payable by the property vendor into a collective pool of funds for the property.
Top


condo_strata_fee_period

The length of time/period for which the condo_strata_fee relates to.

  • Weekly
  • Monthly
  • Quarterly
  • Yearly

Top


country

The country the listed property is located in.
Top


created_at

The time stamp for when the property listing was created and saved to the Zoo Property database.
Top


current-leased

Relates only to Commercial sale listing types and refers to whether the property for sale is currently leased/rented.
Top


current-outgoings

Relates to BusinessSale and Commercial listing types and refers to the outgoings/expenses/overheads (other than rent) payable to lease/own the commercial premise.
Top


current-outgoings-include-tax

Relates to BusinessSale and Commercial listing types and refers to the weather the current_outgoings include tax.

  • Yes
  • No
  • N/A (Tax is Not Applicable)

Top


current-rent

Relates to BusinessSale and Commercial listing types and refers to the amount of current rent payable.
Top


current-rent-include-tax

Relates to BusinessSale and Commercial listing types and refers to the weather the current_rent includes tax.

  • Yes
  • No
  • N/A (Tax is Not Applicable)

Top


date-of-completion

Relates to a ProjectSale listing type and refers to the date of completion (when the property will be ready) of the Project.
Top


date-available

Relates to ResidentialLease and Commercial listing types and refers to when the property is available for the lease commencement to begin.
Top


deal_type

Relates only to Commercial listing types and refers to weather it is for lease, for Ssale or both. The Commercial property template allows a property to be listed for both lease and sale or simultaneously for sale and lease.

  • Both
  • For Sale
  • For Lease

Top


description

The description of the property which includes multiple paragraphs of text.
Top


design-type

Relates to a ProjectSale listing type and refers to the design type of the property. Users can insert the various Design Types available into Zoo Property and add/delete them as needed. A type added by one user will appear across the entire system for that office.
Top


development-name

Relates to a ProjectSale listing type and refers to the developer name of the property. Users can insert the various Development Names available into Zoo Property and add/delete them as needed. A Name added by one user will appear across the entire system for that office.
Top


display_address

Weather the address of the property listing is to be displayed and viewable on the website.

  • false
  • true

Top


display_price

Weather the price of the property listing is to be displayed.

  • 0 : Do not display any price details
  • 1 : Display the price
  • 2 : Display text in place of price (display_price_text)

Top


display_price_text

The text or numbers to be displayed if display_price = 2.
Top


energy-efficiency-rating

The energy efficiency rating for the property.

  • Australia: A rating from 0 to 10 stars in 0.5 star increments. A property with a 0 star rating has very poor energy efficiency rating.
  • New Zealand: A rating from 0 to 10 stars in 0.5 star increments. A property with a 0 star rating has very poor energy efficiency rating.

Top


energy-star-rating

The energy star rating is an international recognised rating for products and is also applied to a property. It is rating from 1 to 6 and increases
Top


estimate-rental-return

The estimated rental income which could be earned through the property.
Top


estimate_rental_return_period

The length of time/period for which the estimate_rental_return relates to.

  • Weekly
  • Monthly
  • Quarterly
  • Yearly

Top


features

The various features which can be selected for the property. Users are able to add features in the Zoo Property system which will be displayed for all users who use the Zoo Property system for that office.

ResidentialSale & ProjectSale

  • Absolute Waterfront
  • Air Conditioning
  • Alarm System
  • Balcony/Patio/Terrace
  • Basement
  • Bath
  • BBQ
  • Beach/Coastal Property
  • Built-ins
  • Close to Parklands
  • Close to Schools
  • Close to Shops
  • Close to Transport
  • Concierge/Manager
  • Ensuite
  • Entertainment Area
  • Firepalce(s)
  • Formal Lounge
  • Furnished
  • Garden
  • Garden Shed
  • Gas Enabled
  • Golf Property
  • Gym
  • Heating
  • Intercom
  • Internal Laundry
  • Level Lawn
  • Lift
  • Modern Bathroom
  • Modern Kitchen
  • Mortgagee Property (Not HolidayLease)
  • Nature Property
  • Near Waterfront
  • Non Smoking
  • Pay TV Enabled
  • Pet Friendly
  • Polished Timber Floors
  • Prestige Property
  • Quiet Location
  • Rainwater Tank
  • Renovated
  • Renovated Bathroom
  • Renovated Kitchen
  • Rent Includes Utilities (Only HolidayLease)
  • Resort Property
  • Retirement Property
  • Safe
  • Sauna
  • Security Lights
  • Security Windows
  • Separate Dining Room
  • Shower Falicities
  • Ski Property
  • Spa Bath/Jacuzzi
  • Storage Area
  • Swimming/Lap Pool
  • Swipe Card
  • Tennis Court
  • Unlevel Lawn
  • Vacum System
  • Views
Commercial

  • Absolute Waterfront
  • Air Conditioning
  • Alarm System
  • Balcony/Patio/Terrace
  • Bathroom
  • BBQ
  • Close to CBD
  • Close to Disabled Parking
  • Close to Parklands
  • Close to Schools
  • Close to Shops
  • Close to Transport
  • Concierge/Manager
  • Entertainment Area
  • Garden
  • Gas Enabled
  • Gym
  • Heating
  • Intercom
  • Kitchen
  • Lift
  • Meeting Room
  • Near Waterfront
  • Pay TV Enabled
  • Polished Concrete Floors
  • Polished Timber Floors
  • Public Parking
  • Quiet Location
  • Reception/Show Room
  • Refurbished
  • Renovated
  • Safe
  • Sauna
  • Security Lights
  • Security Windows
  • Shower Falicities
  • Spa Bath/Jacuzzi
  • Storage
  • Storage Area
  • Swimming/Lap Pool
  • Swipe Card
  • Tennis Court
  • Views
HolidayLease

  • Absolute Waterfront
  • Air Conditioning
  • Alarm System
  • Balcony/Patio/Terrace
  • Basement
  • Bath
  • BBQ
  • Beach/Coastal Property
  • Built-ins
  • Close to Parklands
  • Close to Schools
  • Close to Shops
  • Close to Transport
  • Clothes Press
  • Concierge/Manager
  • Ensuite
  • Entertainment Area
  • Firepalce(s)
  • Formal Lounge
  • Furnished
  • Garden
  • Garden Shed
  • Gas Enabled
  • Golf Property
  • Gym
  • Heating
  • Intercom
  • Internal Laundry
  • Kitchen/Cleaning Utensils
  • Level Lawn
  • Lift
  • Linen
  • Modern Bathroom
  • Modern Kitchen
  • Nature Property
  • Near Waterfront
  • Non Smoking
  • Pay TV
  • Pet Friendly
  • Polished Timber Floors
  • Prestige Property
  • Quiet Location
  • Rainwater Tank
  • Renovated
  • Renovated Bathroom
  • Renovated Kitchen
  • Rent Includes Utilities
  • Resort Property
  • Retirement Property
  • Safe
  • Sauna
  • Security Lights
  • Security Windows
  • Separate Dining Room
  • Shower Falicities
  • Ski Property
  • Spa Bath/Jacuzzi
  • Stereo/Radio
  • Storage
  • Storage Area
  • Swimming/Lap Pool
  • Swipe Card
  • Tennis Court
  • TV
  • Unlevel Lawn
  • Views

Top


floor-area

The total floor area for the property.
Top


floor_area_metric

The metric used to measure the floor area of the property.

  • Acres
  • Hectares
  • Square Metres
  • Square Feet
  • Square Yards

Top


floorplans

The floor plans which the property listing includes.
Top


floorplan position

The display order/position of the floor plans for the property listing. There is a limit of 4 floor plans allowed for each property and the order starts at 0 and goes to 3.

Note: each floor plan loaded to the Zoo Property system is resized to large, medium and thumbnail image.
Top


forthcoming-auction

Whether the property is listed on the market for Auction.
Top


franchise

Relates only to BusinessSale listing types and refers to whether the business is a franchise.
Top


franchise-levies

Relates only to BusinessSale listing types and refers to the dollar value of the annual franchise levies if the business is a franchise.
Top


franchise-royalties

Relates only to BusinessSale listing types and refers to the dollar value of the annual franchise royalty fees if the business is a franchise.
Top


garage-spaces

The number of enclosed parking spaces the property includes.
Top


headline

A single line description of the property which makes up the headline of the property listing.
Top


high-season-price

Relates to HolidayLease listing types and refers to the price of the property during the high season. Price options include peak, high, mid and normal period price (price).
Top


high_season_period

Relates to HolidayLease listing type and refers to the period the high_season_price corresponds to.

  • 1 night
  • 2 nights
  • 3 nights
  • 4 nights
  • 5 nights
  • 6 nights
  • 7 nights
  • 8 nights
  • 9 nights
  • 10 nights
  • 11 nights
  • 12 nights
  • 13 nights
  • 2 weeks
  • 3 weeks
  • 4 weeks
  • 8 weeks
  • 3 months
  • 6 months
  • 12 months

Top


house-depth

Relates to a ProjectSale listing type and refers to the length/depth of the house/property.
Top


house_depth_metric

Relates to a ProjectSale listing type and the metrics used to measure the house_depth

  • Feet
  • Metres
  • Yards

Top


house-width

Relates to a ProjectSale listing type and refers to the width of the house/property.
Top


house_width_metric

Relates to a Project Sale listing type and the metrics used to measure the house_width

  • Feet
  • Metres
  • Yards

Top


id

The property id generated by Zoo Property for the property listing.
Top


land-area

The total land/block area of the property.
Top


land_area_metric

The metric used to measure the land size of the property.

  • Acres
  • Hectares
  • Square Metres
  • Square Feet
  • Square Yards

Top


latitude

The mapping coordinate for the property.
Top


lease-commencement

Relates to BusinessSale and Commercial listing types and refers to the commencement date of an existing lease agreement.
Top


lease-end

Relates to BusinessSale and Commercial listing types and refers to the end date of an existing lease agreement.
Top


lease-option

Relates to BusinessSale and Commercial listing types and refers to whether the current lease agreement includes an option to extend.
Top


lease-plus-another

Relates to BusinessSale and Commercial listing types and refers to whether the current lease agreement includes an option to extend for a period after the lease_option has expired.
Top


longitude

The mapping coordinate for the property.
Top


max-persons

Relates to HolidayLease listing types and refers to the maximum number of people the property can sleep.
Top


mid-season-price

Relates to HolidayLease listing type and refers to the price for the mid season. Price options include peak, high, mid and normal period price (price).
Top


mid_season_period

Relates to HolidayLease listing type and refers to the period the mid_season_price corresponds to.

  • 1 night
  • 2 nights
  • 3 nights
  • 4 nights
  • 5 nights
  • 6 nights
  • 7 nights
  • 8 nights
  • 9 nights
  • 10 nights
  • 11 nights
  • 12 nights
  • 13 nights
  • 2 weeks
  • 3 weeks
  • 4 weeks
  • 8 weeks
  • 3 months
  • 6 months
  • 12 months

Top


number-of-floors

The number of levels/floors the property includes

  • 1 floor
  • 2 floors
  • 3 floors
  • 4 floors
  • 5+ floors

Top


off-street-spaces

The total number of uncovered/open parking spaces for the property.
Top


opentime

The date and time for when a property is open to the public for inspection.

  • date - the date for when the open isnpection will be held.
  • starttime - the time the open inspection will commence.
  • endtime - the time the open inspection will end.

Top


outlets

Relates only to BusinessSale listing types which are a franchise and refers to the number of franchisee outlets in the franchise network.
Top


outgoings-paid-by-tenant

Relates to BusinessSale and Commercial listing types and refers to whether the outgoings for the property are payable by the tenant.
Top


parking-comments

Relates to BusinessSale and Commercial listing types and refers to additional comments regrading the car parking arrangements.
Top


parking-spaces

Relates to BusinessSale and Commercial listing types and refers to the total number of parking spaces.
Top


patron-capacity

Relates to BusinessSale and Commercial listing types and refers to the total number of patron capacity/limit for the premises.
Top


peak-season-price

Relates to HolidayLease listing type and refers to the price for the peak season. Price options include peak, high, mid and normal period price (price).
Top


peak_season_period

Relates to HolidayLease listing type and refers to the period the peak_season_price corresponds to.

  • 1 night
  • 2 nights
  • 3 nights
  • 4 nights
  • 5 nights
  • 6 nights
  • 7 nights
  • 8 nights
  • 9 nights
  • 10 nights
  • 11 nights
  • 12 nights
  • 13 nights
  • 2 weeks
  • 3 weeks
  • 4 weeks
  • 8 weeks
  • 3 months
  • 6 months
  • 12 months

Top


photos

The photos/images for the property listing added to the Zoo Property system.
Top


photo_position

The display order/position of the photos for the property listing. A maximum of 26 images can be added to the database and they are ordered from 0 to 25.

Note: each image loaded to the Zoo Property system is resized to large, medium and thumbnail image.
Top


porch_area_metric

Relates to a ProjectSale listing type and the metrics used to measure the porch_area.

  • Feet
  • Metres
  • Yards

Top


porch-terrace-area

Relates to a ProjectSale listing type and refers to the floor area of porches/terraces connecting to the property.
Top


premise

Relates only to BusinessSale listing type and refers to the status of the business premise.

  • No Premise
  • Leased
  • Business Owned

Top


price

The price which the property is listed at. This is a compulsory field as it is required so a developer can create a serach via price tool.
Top


price_period

The period the price relates to and refers only to Residential, Commercial & Holiday Lease properties
Residential & Commercial

  • Weekly
  • Monthly
  • Quarterly
  • Yearly

Holiday

  • 1 night
  • 2 nights
  • 3 nights
  • 4 nights
  • 5 nights
  • 6 nights
  • 7 nights
  • 8 nights
  • 9 nights
  • 10 nights
  • 11 nights
  • 12 nights
  • 13 nights
  • 2 weeks
  • 3 weeks
  • 4 weeks
  • 8 weeks
  • 3 months
  • 6 months
  • 12 months

Top


price2

Relates to Commercial Listings which can simultaneously be advertised For Sale and For Lease. Price2 refers to the for sale price of these listings. When a developer builds a property search widget for a website they must remeber to search for price2 (along with price) in the XML.
Top


price2_include_tax

Refers to weather the price2 includes tax.

  • Yes
  • No
  • N/A (Tax is Not Applicable)

Top


primary-contact

The primary real estate agent responsible for the property listing

  • first-name – Primary real estate agent first name
  • id - Primary real estate agent Zoo Property ID
  • last-name – Primary real estate agent last name

Top


property_type

The specific type of property:
ResidentialSale, ResidentialLease, ProjectSale & HolidayLease

  • Acreage/Semi-Rural
  • Alpine
  • Apartment
  • Barn
  • Block of Units
  • Boathouse
  • Bungalow
  • Cabin
  • Castle
  • Cave House
  • Chalet
  • Chateau
  • Condo
  • Converted church
  • Converted factory
  • Converted Warehouse
  • Development/knockdown
  • Dormer
  • Duplex
  • Ex local Authority
  • Farmhouse
  • Flat
  • Fort
  • Garage/Parking
  • House
  • Houseboat
  • Land
  • Loft
  • Maisonette
  • Manor
  • Mews
  • Mobile/Manufactured
  • Multi Family Home
  • Penthouse
  • Period House
  • Private Island
  • Section
  • Semi Detached
  • Single Family Home
  • Studio
  • Terrace
  • Townhouse
  • Unit
  • Vicarage/Parsonage/Rectory
  • Villa
  • Warehouse

Commercial

  • Development
  • Farmland
  • Healthcare
  • Hotel
  • Industrial
  • Institutional
  • Investment
  • Land
  • Leisure
  • Offices
  • Parking Space
  • Residential
  • Retail
  • Showrooms/Bulky Goods
  • Warehouse

Top


rent-review

Relates to CommercialSale listing types and refers to whether there is a rent review for the current tenants.
Top


return-percent

Relates to CommercialSale listing types and refers to the annual rental yield for the property.
Top


rental-season

Relates only to HolidayLease listing types and refers to the period each season runs for and the minimum nights stay during that season. There are four periods and they include normal season, mid season, high season and peak season. The mid , high and peak season dates must ALWAYS be within the parameters of the normal season. This means that any dates within the parameters of the Normal Season which do not belong to a mid, high or peak season will be classified as normal seasons.

  • start_date: The date the season commences.
  • end-date: The date the season ends.
  • minimum-stay: the minimum number of nights which can be booked/stayed during that period.

Top


secondary-contact

The secondary real estate agent responsible for the property listing

  • first-name: Secondary real estate agent first name.
  • id: Secondary real estate agent Zoo Property ID.
  • last-name: Secondary real estate agent last name.

Top


state

The state or territory where the listed property is located.
Top


status

The status of the listed property.

  • available
  • under offer
  • leased
  • sold
  • draft
  • withdrawn

Top


staff-casual

Relates only to BusinessSale listing type and refers to the number of casual staff employed.
Top


staff-full-time

Relates only to BusinessSale listing type and refers to the number of full-time staff employed.
Top


staff-part-time

Relates only to BusinessSale listing type and refers to the number of part-time staff employed.
Top


street_number

The number of the property on the street, not including the street name itself. It does not include the unit/flat number.
Top


suburb

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


tax-rate

Land tax or other taxes payable to the government for the property.
Top


tax_rate_period

The length of time/period for which the tax_rate relates to.

  • Weekly
  • Monthly
  • Quarterly
  • Yearly

Top


type

The listing type of the property. In the Zoo Property system there are 6 property listing templates which a user can choose from when they enter a property. These 6 templates correspond to the different listing types:

  • ResidentialSale
  • ResidentialLease
  • Commercial (Sale/Lease)
  • BusinessSale
  • ProjectSale
  • HolidayLease

Top


unique_id

An alternate id added by the agent for the listing.
Top


unit_number

The flat/unit/suite number for the building the property is located in.
Top


updated_at

The time stamp for when the property listing was last updated and saved to the Zoo Property database.
Top


vendor_email

The email address of the vendor of the property (the person who owns the property)
Top


vendor_first_name

The first name of the vendor of the property (the person who owns the property)
Top


vendor_last_name

The last name of the vendor of the property (the person who owns the property)
Top


vendor_phone

The telephone of the vendor of the property (the person who owns the property)
Top


virtual-tour

Link to a 3rd party which opens a virtual tour for the property.
Top


year-built

The year the property was constructed.
Top


zipcode

The postcode/zipcode/area code which recognises the geographic location of the property listing.
Top


zoning

Relates to Commercial property types and refers to the government Zoning of the commercial property.
Top


Comments are closed.