XML API
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.
- Property Listings XML - http://api.agentaccount.com/api/properties?office_id=1
- Team Member XML - http://api.agentaccount.com/api/agents?office_id=1
- Office Details XML - http://api.agentaccount.com/api/offices?office_id=1
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:
//Get data from specific API//$base_url = URL of API//$accesskey = accesskey for the API//$privatekey = privatekey for the APIfunction getdata($base_url, $accesskey, $privatekey){$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $base_url);curl_setopt($ch, CURLOPT_USERPWD, $accesskey . ':'.$privatekey);curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);$data = curl_exec($ch);curl_close($ch);echo $data;}
How to use:
-Call the function getdata by passing API url, accesskey and private key
Example:
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
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
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)
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)
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
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
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)
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.
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
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
|
Commercial
|
HolidayLease
|
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
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
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
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
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
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
number-of-floors
The number of levels/floors the property includes
- 1 floor
- 2 floors
- 3 floors
- 4 floors
- 5+ floors
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.
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
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
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
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
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)
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
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
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.
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.
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
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
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
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
Hello sir
I want to use Accessing XML using PHP this method to export data into my website.Please let me know
How to use this?
How i get API url, accesskey and private key?
what is office id?
Please clear everything.
Thanks
Yash
Yash,
Follow the instructions at the top of the thread and if you have any issues just post a comment here.
You can get the API url if your login to your developers system and then go to the offices tab. You will see an API link for each office in your system. Click on the API link and you will see the api details along with office id.
Hi
Thanks for response but i am still confused.I have created account.There is option for office as you said.But what is that offices system.Please clear me that
How i get xml of properties.so that i will list these on my website.Please let me know next whole step by step procedure.
zoo-rgb-white
Developer ID: au12356
Account: Intersoft Professionals
username:yash_singla
password:yash_singla
Thanks
Yash
Yash,
The Agent’s System is where your clients will list and manage their properties. You can login to this system by clicking on the ‘System” link for that office on the Client Offices tab.
If you click on API for that office then that will give you all the details for the XML API. You will see that if you add some properties to that office and then open the xml url through a browser the properties will appear.
I hope this helps, please let us know if there is anything else.
Hi we are having problems with ZOO API to import data into zoo.
This code is simple test code.
This code is for inserting new record.
But this code said “Deal type : Sale/Lease can’t be blank false”
As you know via code, deal_type is not blank.
How can I explain about this issue?
<?php
$accesskey= 'any access key';
$privatekey= 'any private key';
$listing_type="commercial";
$country="Australia";
$suburb="SYDNEY";
$state="NSW";
$zipcode="2000";
$street_number=112;
$street="nnn";
$property_type="Farmland";
$headline="TiltleHedadminlinsdinlk";
$description="RoyisTest";
$price=1000;
$deal_type = "for sale";
//$deal_type = "Sale";
$primary_contact_id="9665";
$params = "deal_type=$deal_type&listing_type=$listing_type&country=$country&suburb=$suburb&state=$state&zipcode=$zipcode&street_number=$street_number&street=$street&property_type=$property_type&headline=$headline&description=$description&price=$price&primary_contact_id=$primary_contact_id";
echo $params."”;
// send to API
$ch = curl_init();
//print_r($ch);
//curl_setopt ($ch, CURLOPT_URL, ‘any url’);
curl_setopt ($ch, CURLOPT_URL, ‘any url’);
//curl_setopt ($ch, CURLOPT_URL, ‘any url’);
curl_setopt ($ch, CURLOPT_POST, 1);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $params);
curl_setopt ($ch, CURLOPT_USERPWD, $accesskey . ‘:’.$privatekey);
curl_setopt ($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
echo “”;
$r = curl_exec ($ch);
print_r($r);
curl_close ($ch);
?>
Can you please advise on how to resolve.
Cheers
Barry
Just realized I left the API Access Key and Private Key in last message.
Can you please remove this from displaying.
And also please do not show URL.
Cheers
Barry
Dear Barry, I’m a little confused as this code does not follow this API. Can you explain further or check that this is the correct API?
Hi Team Zoo,
This API was found on this URL http://www.zooproperty.com/api/importation-of-data/property-data-via-http/comment-page-1/#comment-631
Property API For Commercial
* Click here to download Property API For Commercial
The word doc download that he got when clicking on that link is what he used to prepare API for commercial properties.
I have started new comment there since this is location of API download guide.
Cheers
Barry
PS. Let’s close this discussion here and move to relevant page, is this OK?
Hi Team Zoo,
I’m a developer looking at using the XML API for a real estate client’s web site. I have reached a point in my development where I need to know if there is more documentation available for the XML API. In particular, I need to selectively download a listing of properties. For example a listing of properties for residential sale. I want to know if there are more parameters that can be specified in the API URL other than just office_id?
Regards
Tony
Tony, I would try this API http://www.zooproperty.com/api/export-data-agent-websites-apps/iphone-read-api/ as it allows you to query the database and then return results. If you have any questions just post them there and we can answer them.
Hello there, simply turned into aware of your blog through Google, and found that it is truly informative. I am gonna be careful for brussels. I will be grateful for those who continue this in future. A lot of other folks shall be benefited from your writing. Cheers!
Hey am developing a website using xml api for real estate i need to get xml file using this api , but when i call getdata() function using
$accesskey= “a9ab3460ad4dbd933682c4a81b959e2ec7f6625d”;
$privatekey= “aea053de54ed2adb51d045a3bb68c19f1baa42e0″;
it returns
no access
what should be the url to be used??
i have account on http://agentpoint.agentaccount.com
Hi Anand,
You can use this url and replace the {office_id} with your office id
http://api.agentaccount.com/api/properties?office_id={office_id}
thanks
Please delete the above comment
using wordpress xmltoarray, no image or thumbnails, why?
All works well but I only seem to be getting a maximum of 50 listings being output
Hi Steve,
The listings output is paginated. Every page has 50 listings.
To access the next page, change the ‘&page’ parameter to the desired page number, for example to access page 2 :
api/properties?office_id=[office_id]&page=2
Thank you
How can I get details of one property by the property id?
I have the id of the property, is there a parameter that I can pass this variable on to get all the details of this property?
The result from http://api.agentaccount.com/services/{OFFICE_ID}/property/{PROPERTY_ID}/detail
does not seem to contain all the details of the property, for example “Energy efficiency rating” & “brochures”
I was able to get these details from the xml api, but I did not see a way to pass the property id to the request and get the information only for that particular property.
Any help is appreciated.
Thank you
Hi Sean,
Currently, we don’t provide complete property details (including energy efficiency rating & brochures) from http://api.agentaccount.com/services/{OFFICE_ID}/property/{PROPERTY_ID}/detail
But we will adjust this API to give all property details in its result.
Thank you
Thanks Team Zoo,
Are you able to provide a rough ETA of the new API?
Regards
Having read this I thought it was very informative.
I appreciate you finding the time and energy to put this article together.
I once again find myself spending way too much time both reading and posting comments.
But so what, it was still worthwhile!