ListOnce API Documentation

  • Overview
  • Get Listing
  • Search Listings
  • Search Inspection Times
  • Search Auctions
  • Get Suburbs
  • Get Office Details
  • Get Agent Details
  • Get News Articles
  • Get Testimonials
  • Get Featured Listings
  • Email-A-Friend
  • Contact the Agent through a listing
  • Contact a Agent directly
  • Contact a Office directly
  • Get Alerts List
  • Subsribe to new Alert
  • Get Alert Details
  • Update an Alert
  • Unsubscribe from an Alert
  • Interactive Floorplans
  • Get External Links
  • Categories
  • Field List

Overview

All API access is over HTTP. All responses are returned as JSON. An API key is required. API Keys are also tied to an 'origin' URL that must be included in all API calls.


Change Log

Date Change/Comments
08/05/2012 Initial Release
10/05/2012 Added Agent Contact details to get-listing
30/05/2012 Added Office details API
06/06/2012 Added Agent details API
20/06/2012 Added ability to filter search-listings by min_parking_total and max_parking_total, and order by parking_total. Added External URL's and Document Titles to get-listing
26/10/2012 New ability to retrieve News, Testimonials as well as contacting Agents, 'Email-A-Friend' system and new Listings Alerts.
16/07/2013 Updated land and building area parameters to match naming conventions for other fields. Old names will still be processed temporarily
07/07/2013 Introduced the 'max_total_listings', 'date_start' and 'date_end' options to the search-listings API
16/12/2014 Added 'expected_rental_income', 'expected_rental_period', 'rental_key_location', and 'additional_inspection_text' fields in get-listing
11/08/2015 Added range values to 'postcode' field of the search-listings API
2/12/2015 Added the ability to filter listing, office and agent searches by a modfied date range. (see modified_from / modified_to)
16/12/2015 Added unique_listings parameter to search-inspection-times

GET /api/get-listing

Returns details for a listing specified by listing_id.


Arguments

Field Required Description
api_key Yes Used for authentication.
listing_id Yes The ID of the listing to return.

Example

$ curl http://www.listonce.com.au/api/get-listing?api_key=[YOUR API KEY]&listing_id=123
---
{
  "listing_id": 123,
  "client_id": 1
  "agent_contract_status": "",
  "agent_id_1": "2"
  "agent_name_1": "Test Agent",
  "agent_email_1": "test@email.com",
  "agent_phone_1": "0412 555 123",
  "agent_mobile_1": "0412 555 123"
  "property_type": "Residential",
  "listing_type": "Sale",
  "property_status": "Available",
  "property_status_extra": "",
  "category": "Apartment",
  "headline": "Example Headline",
  "description": "Example description.",
  "address_text": "",
  "address_hide": false,
  "address_lot_number": "",
  "address_sub_number": "",
  "address_street_number": "1",
  "address_street_name": "George",
  "address_street_type": "Street",
  "address_street_view_hide": false,
  "address_suburb": "Sydney",
  "address_state": "NSW",
  "address_postcode": "2000",
  "address_municipality": "",
  "bedrooms": 2,
  "bathrooms": 1,
  "toilets": null,
  "ensuites": null,
  "rooms": null,
  "living_areas": 1,
  "parking_garages": 1,
  "parking_carports": null,
  "parking_total": null,
  "parking_other": null,
  "price": "600000.00",
  "price_view": "",
  "price_display": true,
  "price_range_display": false,
  "price_range_min": null,
  "price_range_max": null,
  "sold_details_sold_price": null,
  "sold_details_sold_price_display": false,
  "sold_details_sold_method": "",
  "sold_details_sold_date": null,
  "auction_date": null,
  "auction_time": null,
  "auction_venue": "",
  "expected_rental_income" : null,
  "expected_rental_period" : null,
  "additional_inspection_text": null,
  "rental_key_location" : null,
  "is_home_land_package": false,
  "features": [
    "Air Conditioning",
    "Alarm System",
    "Gym",
    "Intercom"
  ],
  "other_features": "",
  "publish_date": "2012-06-29 14:37:46",
  "objects": {
    "img_count": 3,
    "floorplan_count": 0,
    "document_count": 1,
    "img": [
      "http://www.listonce.com.au/listings/014/00000014_img_01.jpg",
      "http://www.listonce.com.au/listings/014/00000014_img_02.jpg",
      "http://www.listonce.com.au/listings/014/00000014_img_03.jpg"
    ]
    "img_small": [
      "http://www.listonce.com.au/listings/014/00000014_img_01s.jpg",
      "http://www.listonce.com.au/listings/014/00000014_img_02s.jpg",
      "http://www.listonce.com.au/listings/014/00000014_img_03s.jpg"
    ]
    "img_medium": [
      "http://www.listonce.com.au/listings/014/00000014_img_01m.jpg",
      "http://www.listonce.com.au/listings/014/00000014_img_02m.jpg",
      "http://www.listonce.com.au/listings/014/00000014_img_03m.jpg"
    ]
    "img_1024x768": [
      "http://www.listonce.com.au/listings/014/00000014_img_01_1024x768.jpg",
      "http://www.listonce.com.au/listings/014/00000014_img_02_1024x768.jpg",
      "http://www.listonce.com.au/listings/014/00000014_img_03_1024x768.jpg"
    ]// Custom Images sizes will use the format img_widthxheight, and can be confirgured on a client basis

    "document": [
      "http://www.listonce.com.au/document.pdf"
    ]
    "document_title": [
      "Document Number 1"
    ]
  },
  "listing_area": [
    {
      "area_type": "Building",
      "area": "80.00",
      "area_unit": "Square Meter"
    }
  ],
  "inspection": [
    {
      "id": 43,
      "inspection_date": "2011-01-21"
      "inspection_start_time": "10:00:00",
      "inspection_end_time": "10:30:00"
    }
  ]
  "urls": [
    ['Video', 'http://videourl.com'],
    ['External', 'http://externalurl.com']
  ]

}

GET /api/search-listings

Returns the specified list of listings based on the supplied arguments.


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No The ID of the client to search listings for. Can also be supplied as a comma delimeted string. Expected input: Integer/Comma delimeted string. Example: "1" or "1,2"
suburb No The suburb to search. Expected input: Single suburb, or comma delimited string. Example: "Sydney" or "Sydney,Pyrmont"
surrounding No Whether surrounding suburbs should be included. Expected input: String ("bordering", for immediate bordering suburbs) or integer (number of metres, maximum 25000) Example: "bordering" or "5000"
postcode No The postcode to search. Expected input: Single postcode, postcode range separated by a dash '-', comma delimited string, or mixture of. Examples: "2000", "2000,2009", "2000-2009", "2000,2005-2009". The following are equivalent: "2003-2005", "2003,2004,2005"
state No The state to search. Expected input: Three-letter abbreviated state name (e.g. "NSW", "VIC", etc.) Single state, or comma delimited string. Example: "NSW" or "NSW,VIC"
property_type No The property type to search. Expected input: "residential", "commercial" or "business".
listing_type No The listing type to search. Please note: Business listings can only be listing type "sale". Expected input: "sale", "lease" or "both" (applicable to commercial listings only). Single listing type, or comma delimited string. Example: "sale,both"
property_status No The property status to search. Expected input: "available", "sold", "leased". Example: "available"
agent_id No The ListOnce Agent ID of either the 'Listing Agent's' of a listing. Can also be comma separated for multiple agents. Example: 123 or 123,456
category No The category to search. Expected input: LIST OF CATEGORIES. Single category, or comma delimited string.
subcategory No The subcategory to search. Applicable to business listings only. Expected input: LIST OF SUBCATEGORIES. Single subcategory, or comma delimited string.
min_bed No The minimum number of bedrooms to search. Expected input: Integer.
max_bed No The maximum number of bedrooms to search. Expected input: Integer.
min_bath No The minimum number of bathrooms to search. Expected input: Integer.
max_bath No The maximum number of bathrooms to search. Expected input: Integer.
min_price No The minimum price to search. Applicable to "sale" or "both" listing types only. Expected input: Integer or decimal. Example: "600000" or "600000.00"
max_price No The maximum price to search. Expected input: Integer or decimal. Example: "600000" or "600000.00"
min_rent No The minimum rent to search. Expected input: Integer or decimal. Example: "500" or "500.00"
max_rent No The maximum rent to search. Expected input: Integer or decimal. Example: "500" or "500.00"
rent_period No The rent period to search. Applicable to listing types "rent" or "both". Expected input: "weekly" or "annual". Defaults to "weekly". Example: "weekly"
auction_only No Whether to return auction-only listings. Expected input: "0" for False, "1" for True. Example: "1"
min_parking_total No The minimum number of total parking spaces to search. Expected input: Integer. Example "3"
max_parking_total No The maximum number of total parking spaces to search. Expected input: Integer. Example "5"
min_land_area No The Minimum Land Area to search. Expected input: Integer
max_land_area No The Maximum Land Area to search. Expected input: Integer
min_building_area No The Minimum Building Area to search. Expected input: Integer
max_building_area No The Maximum Building Area to search. Expected input: Integer
order_by No Determine the sort order of returned results. Expected input: "suburb", "price", "bedrooms", "created", "updated", "auction_date", "parking_total", "street_name", "bathrooms", "residential_category", "commercial_category", "business_category". Example: "suburb"
NOTE: Can be sent through as Comma Separated values to order by multiple (e.g suburb,bedrooms)
order_asc No Determine whether the returned sort order is ascending. Defaults to True. Expected input: "0" for False, "1" for True. Example: "1"
NOTE: When supplying Comma Separated order_by values, order_asc is also Comma Separated (e.g 0, 1)
max_total_listings No Determine's the total number of listings to return in the search.
date_start No Allows you to find listings based on their 'publish_date'. This defines the minimum date to search from. Expected Input: YYYY-MM-DD
NOTE: If the property status "Sold" or "Leased" is used in the 'property_status' option, the date_start parameter will be based on the sold/leased date
date_end No Allows you to find listings based on their 'publish_date'. That defines the maximum date to search to. Expected Input: YYYY-MM-DD
NOTE: If the property status "Sold" or "Leased" is used in the 'property_status' option, the date_end parameter will be based on the sold/leased date
boundaries No Given a set of latitude and logitude values that create a polygon. This will restrict results to the bounding area. The format will be expected as: latitude,longitude:latitude2,longitude2:latitude3:latitde3 etc.
street_name No Only select listings that located at a given street name. Requires a 100% (case insensitive) match e.g street_name=main
modified_from No Return listings with a modified date after the supplied datetime. Expected format YYYY-MM-DD HH:MM:SS
modified_to No Return listings with a modified date before the supplied datetime. Expected format YYYY-MM-DD HH:MM:SS

Example

$ curl http://www.listonce.com.au/api/search-listings?api_key=[YOUR API KEY]&suburb=Sydney&property_type=residential
       &listing_type=sale&max_price=900000
---
{
  "page": 1,
  "total_pages": 5,
  "per_page": 20,
  "total_listings": 93,
  "listings": [
    {
      "listing_id": 123,
      "publish_date": "2012-06-29 14:37:46",
      "agent_contract_status": "",
      "agent": "Test Agent",
      "property_type": "Residential",
      "listing_type": "Sale",
      "property_status": "Available",
      "property_status_extra": "",
      "category": "Apartment",
      "headline": "Example Headline",
      "description": "Example description.",
      "address_text": "",
      "address_hide": false,
      "address_lot_number": "",
      "address_sub_number": "",
      "address_street_number": "1",
      "address_street_name": "George",
      "address_street_type": "Street",
      "address_street_view_hide": false,
      "address_suburb": "Sydney",
      "address_state": "NSW",
      "address_postcode": "2000",
      "address_municipality": "",
      "bedrooms": 2,
      "bathrooms": 1,
      "toilets": null,
      "ensuites": null,
      "rooms": null,
      "living_areas": 1,
      "parking_garages": 1,
      "parking_carports": null,
      "parking_total": null,
      "parking_other": null,
      "price": "600000.00",
      "price_view": "",
      "price_display": true,
      "price_range_display": false,
      "price_range_min": null,
      "price_range_max": null,
      "sold_details_sold_price": null,
      "sold_details_sold_price_display": false,
      "sold_details_sold_method": "",
      "sold_details_sold_date": null,
      "auction_date": null,
      "auction_time": null,
      "auction_venue": "",
      "expected_rental_income" : null,
      "expected_rental_period" : null,
      "additional_inspection_text": null,
      "rental_key_location" : null,
      "is_home_land_package": false,
      "features": [
        "Air Conditioning",
        "Alarm System",
        "Gym",
        "Intercom"
      ],
      "other_features": "",
      "objects": {
        "img_count": 3,
        "floorplan_count": 0,
        "document_count": 0,
        "img": {
          "1": "http://listonce.com.au/listings/014/00000014_img_01.jpg",
          "2": "http://listonce.com.au/listings/014/00000014_img_02.jpg",
          "3": "http://listonce.com.au/listings/014/00000014_img_03.jpg"
        }
      },
      "listing_area": [
        {
          "area_type": "Building"
          "area": "80.00",
          "area_unit": "Square Meter",
        }
      ],
      "inspection": [
        {
          "id": 43,
          "inspection_date": "2011-01-21"
          "inspection_start_time": "10:00:00",
          "inspection_end_time": "10:30:00",
        }
      ],
      "media_attachments": [
        {
            "usage": "statementOfInformation", 
            "url": "http://www.google.com/robots.txt", 
            "id": "123123jk123ljk123", 
            "content_type": "text/plain"
        }
      ]
    }
  ],
  ...
 }

GET /api/search-inspection-times

Returns the specified list of inspection times for listings based on the supplied arguments.


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No The ID of the client to search listings for. Expected input: Integer.
suburb No The suburb to search. Expected input: Single suburb, or comma delimited string. Example: "Sydney" or "Sydney,Pyrmont"
surrounding No Whether surrounding suburbs should be included. Expected input: String ("bordering", for immediate bordering suburbs) or integer (number of metres, maximum 25000) Example: "bordering" or "5000"
postcode No The postcode to search. Expected input: Single postcode, or comma delimited string. Example: "2000" or "2000,2009"
state No The state to search. Expected input: Three-letter abbreviated state name (e.g. "NSW", "VIC", etc.) Single state, or comma delimited string. Example: "NSW" or "NSW,VIC"
property_type No The property type to search. Expected input: "residential", "commercial" or "business".
listing_type No The listing type to search. Please note: Business listings can only be listing type "sale". Expected input: "sale", "lease" or "both" (applicable to commercial listings only). Single listing type, or comma delimited string. Example: "sale,both"
property_status No The property status to search. Expected input: "available", "sold", "leased". Example: "available"
category No The category to search. Expected input: LIST OF CATEGORIES. Single category, or comma delimited string.
subcategory No The subcategory to search. Applicable to business listings only. Expected input: LIST OF SUBCATEGORIES. Single subcategory, or comma delimited string.
min_bed No The minimum number of bedrooms to search. Expected input: Integer.
max_bed No The maximum number of bedrooms to search. Expected input: Integer.
min_bath No The minimum number of bathrooms to search. Expected input: Integer.
max_bath No The maximum number of bathrooms to search. Expected input: Integer.
min_price No The minimum price to search. Applicable to "sale" or "both" listing types only. Expected input: Integer or decimal. Example: "600000" or "600000.00"
max_price No The maximum price to search. Expected input: Integer or decimal. Example: "600000" or "600000.00"
min_rent No The minimum rent to search. Expected input: Integer or decimal. Example: "500" or "500.00"
max_rent No The maximum rent to search. Expected input: Integer or decimal. Example: "500" or "500.00"
rent_period No The rent period to search. Applicable to listing types "rent" or "both". Expected input: "weekly" or "annual". Defaults to "weekly". Example: "weekly"
auction_only No Whether to return auction-only listings. Expected input: "0" for False, "1" for True. Example: "1"
min_parking_total No The minimum number of total parking spaces to search. Expected input: Integer. Example "3"
max_parking_total No The maximum number of total parking spaces to search. Expected input: Integer. Example "5"
min_land_area No The Minimum Land Area to search. Expected input: Integer
max_land_area No The Maximum Land Area to search. Expected input: Integer
min_building_area No The Minimum Building Area to search. Expected input: Integer
max_building_area No The Maximum Building Area to search. Expected input: Integer
max_total_listings No Determine's the total number of listings to return in the search.
date_from No Allows you to find inspection times based on their 'inspection_date'. This defines the minimum date to search from. Expected Input: YYYY-MM-DD
date_to No Allows you to find inspection times based on their 'inspection_date'. That defines the maximum date to search to. Expected Input: YYYY-MM-DD
unique_listings No Default False. If True only returns first inspection time for each listing that matches the filters.

Example

$ curl http://www.listonce.com.au/api/search-inspection-times?api_key=[YOUR API KEY]&suburb=Sydney&property_type=residential&listing_type=sale
---
{
  "page": 1,
  "total_pages": 1,
  "per_page": 20,
  "total_inspection_times": 5,
  "inspection_times": [
    {
      "id": 3951,
      "listing_id": 844,
      "inspection_date": "2013-11-11"
      "inspection_start_time": "15:10:00",
      "inspection_end_time": "16:10:00",
    },
    {
      "id": 3952,
      "listing_id": 844,
      "inspection_date": "2013-11-13"
      "inspection_start_time": "09:10:00",
      "inspection_end_time": "10:10:00",
    },
    {
      "id": 3923,
      "listing_id": 6750,
      "inspection_date": "2013-11-28"
      "inspection_start_time": "13:00:00",
      "inspection_end_time": "14:00:00",
    },
    {
      "id": 3924,
      "listing_id": 6751,
      "inspection_date": "2013-11-28"
      "inspection_start_time": "13:00:00",
      "inspection_end_time": "14:00:00",
    },
    {
      "id": 2058,
      "listing_id": 1163,
      "inspection_date": "2013-12-29"
      "inspection_start_time": "14:30:00",
      "inspection_end_time": "15:00:00",
    }
  ],
  ...
 }

GET /api/search-auctions

Returns a list of auction date/times.


Arguments

Field Required Description
api_key Yes Used for authentication.
date_from No Provides results (inclusive) from this date. Formatted as YYYY-MM-DD.
date_to No Provides results (inclusive) to this date. Formatted as YYYY-MM-DD.
results_from No Allows to search with a results 'offset' - rather than paginated. Provides results (inclusive and zero indexed) from this position. Expected input: Integer
results_to No Allows to search with a results 'offset' - rather than paginated. Provides results (inclusive and zero indexed) to this position. Expected input: Integer
search parameters No search-auctions will also accept any of the search-listings parameters. This will filter the results as per the given criteria (e.g listing_type=sale)

Example

$ curl http://www.listonce.com.au/api/search-auctions?api_key=[YOUR API KEY]
---
{
  "total_auctions": 315,
  "total_pages": 16,
  "page": 1,
  "per_page": 20
  "auctions": [
    {
      "listing_url": "http://www.listonce.com.au/api/get-listing?listing_id=73278&api_key=[YOUR API KEY]",
      "listing_id": 73278,
      "auction_date": "2014-05-24",
      "auction_time": "12:00:00"
    },
    {
      "listing_url": "http://www.listonce.com.au/api/get-listing?listing_id=81468&api_key=[YOUR API KEY]",
      "listing_id": 81468,
      "auction_date": "2014-05-31",
      "auction_time": "11:00:00"
    },
    {
      "listing_url": "http://www.listonce.com.au/api/get-listing?listing_id=84936&api_key=[YOUR API KEY]",
      "listing_id": 84936,
      "auction_date": "2014-06-21",
      "auction_time": "11:00:00"
     }...
    ]
}

GET /api/get-suburbs

Returns a list of distinct suburbs which have at least one listing. Useful in search forms.


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No The ID of the client to filter the list by.
search parameters No get-suburbs will also accept any of the search-listings parameters. This will filter the resulting suburb listing as per the given criteria (e.g listing_type=sale)

Example

$ curl http://www.listonce.com.au/api/get-suburbs?api_key=[YOUR API KEY]
---
[
  "SYDNEY",
  "DURAL",
  "YARRAVILLE",
  "GLENROY",
  "BURWOOD",
  "HAYMARKET",
  "GLEBE",
  "PYRMONT",
  "CAMPBELLTOWN"
]

GET /api/get-office

Returns a list of the current details for a given client.


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No The ID of the client to return the details of
modified_from No Return offices with a modified date after the supplied datetime. Expected format YYYY-MM-DD HH:MM:SS
modified_to No Return offices with a modified date before the supplied datetime. Expected format YYYY-MM-DD HH:MM:SS

Example

$ curl http://www.listonce.com.au/api/get-office?api_key=[YOUR API KEY]&client_id=[OFFICE CLIENT ID]
---
[
  {
    "website": "www.testrealestate.com.au",
    "fax": "1300 123 456",
    "suburb": "Sydney",
    "client_name": "Test Real Estate",
    "phone": "1300 456 789",
    "state": "NSW",
    "contact": "Head of Sales",
    "postcode": "2000",
    "address": "123 Test Street",
    "email": "",
    "contact_lease": "",
    "phone_lease": "",
    "fax_lease": "",
    "email_lease": "",
  }
]

GET /api/get-agents

Returns a list of the current listing Agents and their details for a given group/client.


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No The ID of the client to return the details of
agent_id No The ID of the agent to return the details of
modified_from No Return agents with a modified date after the supplied datetime. Expected format YYYY-MM-DD HH:MM:SS
modified_to No Return agents with a modified date before the supplied datetime. Expected format YYYY-MM-DD HH:MM:SS
role No Return agents with a role matching the value. Multiple values can be supplied separated by a "," (comma).

Example

$ curl http://www.listonce.com.au/api/get-agents?api_key=[YOUR API KEY]&client_id=[OFFICE CLIENT ID]
---
{
 "total_agents": 4,
 "agents": [
  {
    "first_name": "Jane",
    "last_name": "Doe",
    "description": null,
    "mobile": null,
    "telephone": "0404 555 123",
    "agent_id": 14,
    "roles": ["Sales Representative", "Principal"],
    "position": null,
    "email": null,
    "website": "http://www.listonce.com.au/",
    "image_small": "http://www.listonce.com.au/clients/0002/agents/0001_photo_s.jpg",
    "image_medium": "http://www.listonce.com.au/clients/0002/agents/0001_photo_m.jpg",
    "image_large": "http://www.listonce.com.au/clients/0002/agents/0001_photo_l.jpg",
    "iaw_imgs_count": 2,
    "iaw_imgs": [
            "http://www.listonce.com.au/agents/client-name/agent-name/0001_photo.jpg",
            "http://www.listonce.com.au/agents/client-name/agent-name/0002_photo.jpg",
    ],
    ""iaw_imgs_small" : [
            "http://www.listonce.com.au/agents/client-name/agent-name/0001_photo_s.jpg",
             "http://www.listonce.com.au/agents/client-name/agent-name/0002_photo_s.jpg",
    ],
    "q_and_as": [
      {
        "question": "What makes you a good Agent?",
        "answer": "My statistics show that i have a high sales..."
      },
      {
        "question": "What places do you speacialize in?"
        "answer": "I mostly sell property acc...",
      }
    ],
    "skill_or_expertises": [
      {
        "name": "Respobsible Service of Alcohol (RSA)",
        "obtained_date": null,
        "description": "As part of my generic skills, i have obtained my RSA"
      }
    ],
    "awards": [
        {
          "award_date": 2015-01-01,
          "award_name": "Highest Sales award for 2014",
          "description": "Highest grossing Sales Agent of 2014"
        }
    ],
    "testimonials": [
      {
        "testimonial_date": "2015-01-01",
        "testimonial_text": "Jane has always been a consistent and prepared...",
        "author": "John Doe"
      }
    ],
  },
  {
    "first_name": "John",
    "last_name": "Smith",
    "description": null,
    "mobile": null,
    "telephone": "0404 123 456",
    "agent_id": 17,
    "position": null,
    "email": null,
    "videos": [
      {
        "url": "https://www.youtube.com/watch?v=ZCzdKoGslyA",
        "category": ""
      },
      {
        "url": "https://www.youtube.com/watch?v=ZCzdKoGslyA",
        "category": "profile"
      },
      {
        "url": "https://www.youtube.com/playlist?list=PLMC9KNkIncKtPzgY-5rmhvj7fax8fdxoj",
        "category": "playlist"
      }
    ],
    "team": [15, 16, 18, 17],
  },
  ]
 }

GET /api/get-news

Returns a list of News Articles created by the office for use on their website.


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No The ID of the single client you wish to return the News Articles of
news_id No The ID of the News Article you wish to return

Example

$ curl http://www.listonce.com.au/api/get-news?api_key=[YOUR API KEY]
---
[
  {
    "news_created_date": "2012-08-29",
    "client": 2,
    "news_text": "Welcome to the new ListOnce Test Office website. Powered by ListOnce",
    "news_created_time": "10:36:21",
    "news_headline": "News ListOnce Test Office Website!"
  }
]

GET /api/get-testimonials

Returns a list of Testimonials created by the client from ListOnce.


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No The ID of the Client you wish to return the Testimonials of
agent_id No The ID of the Agent you wish to return the Testimonials of
order_by No The Order in which to return the Testimonials. Expected Input: date_ascending, date_descending, newest_created, oldest_created

Example

$ curl http://www.listonce.com.au/api/get-testimonials?api_key=[YOUR API KEY]
---
[
  {
    "client": 2,
    "testimonial_date": "2012-09-06",
    "testimonial_text": "This office is amazing! I sold my home straight away",
    "agent": null,
    "author: "Bobster Jane"
  }
]

GET /api/get-featured-listings

Returns a list of 'featured' listings (including their data) that has been selected by the office. Typically used to create 'highlighted' listings on a Real Estate Office website


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No Optional Client ID for features specific to a single office. Can also be supplied as 'comma separated' values to allow a chain of featured listings, supplied in the order of Client ID's given.

POST /api/email-a-friend

Uses the ListOnce system to email from one user to another and record statistics


Arguments

Field Required Description
api_key Yes (use GET method) Used for authentication.
listing_id Yes The ID of the Listing you wish to contact regarding
from_email Yes The email address of the person sending the message
to_email Yes The email address of the person recieving the message
subject Yes The subject of the message
message Yes The Message to accompany the email content
html No The entire HTML content of the email that you wish to send. If not supplied, a Generic ListOnce email will be used.

POST /api/contact-enquiry

Uses the ListOnce system to email the Listing Agent/Office and record statistics


Arguments

Field Required Description
api_key Yes (use GET method) Used for authentication.
listing_id Yes The ID of the Listing you wish to contact regarding
name Yes The Name of the person making the enquiry
from_email Yes The email address of the person making the enquiry
message Yes The Message to accompany the email content
contact_number No A phone number the office can use to contact the person making the enquiry
html No The entire HTML content of the email that you wish to send. If not supplied, a Generic ListOnce email will be used.

POST /api/agent-contact-enquiry

Uses the ListOnce system to email the Agent Directly


Arguments

Field Required Description
api_key Yes (use GET method) Used for authentication.
agent_id Yes The ID of the Agent you wish to contact regarding
name Yes The Name of the person making the enquiry
from_email Yes The email address of the person making the enquiry
message Yes The Message to accompany the email content
contact_number No A phone number the office can use to contact the person making the enquiry
html No The entire HTML content of the email that you wish to send. If not supplied, a Generic ListOnce email will be used.

POST /api/office-contact-enquiry

Uses the ListOnce system to email the Agent Directly


Arguments

Field Required Description
api_key Yes (use GET method) Used for authentication.
client_id Yes The ID of the Client/Office you wish to contact regarding
name Yes The Name of the person making the enquiry
from_email Yes The email address of the person making the enquiry
message Yes The Message to accompany the email content
contact_number No A phone number the office can use to contact the person making the enquiry
html No The entire HTML content of the email that you wish to send. If not supplied, a Generic ListOnce email will be used.

GET /api/alerts/list

Returns a list of current alert subscribers for a given group. May also be filtered by email_address, alert_name etc.


Arguments

Field Required Description
api_key Yes Used for authentication
email_address No The email address subscribed to an alert
alert_name No The nane of the alert
subscribe_date No The date the alert was subscribed (YYYY-MM-DD)
per_page No The number of results per page to return. Default is 50
page No The specific page to return. Default is 1


Example

$ curl http://www.listonce.com.au/api/alerts/list/?api_key=[YOUR API KEY]
---
{
  "next_page": "",
  "previous_page": "",
  "alerts": [
    {
      "alert_name": "test alert",
      "search_criteria": "listing_type=sale",
      "alert_id": 21380,
      "frequency": 1,
      "last_sent": "2015-12-22 08:57",
      "ofi_alert": false,
      "email_address": "test@test.test",
      "subscribe_date": "2015-12-22"
    }
  ],
  "total_alerts": 1,
  "pages": 1,
  "per_page": 50,
  "page": 1
}

GET /api/alerts/subscribe

Creates a new alert subscription.


Arguments

Field Required Description
api_key Yes Used for authentication.
email_address Yes The email to recieve subscriptions from.
search_criteria Yes Url-encoded search criteria which is passed to search-listings.
frequency No The frequency of the emails in days. Default is 7.
alert_name No A name to identify the alert, used in email subject.


Example

$ curl http://www.listonce.com.au/api/alerts/subscribe/?api_key=[YOUR API KEY]&email_address=test@test.test&search_criteria=listing_type%3Dsale&frequency=1&alert_name=test%20alert
---
{
  "message": "Alert subscribed successfully",
  "alert_id": 21379,
  "error": false
}

GET /api/alerts/details/{alert_id}

Returns an object containing details about the subscription.


Arguments

Field Required Description
api_key Yes Used for authentication
alert_id Yes (used in url path) The alert ID returned by subscribe


Example

$ curl http://www.listonce.com.au/api/alerts/details/21379/?api_key=[YOUR API KEY]
---
{
  "history": "",
  "stats": {
    "totals": {
      "emails": 0,
      "opens": 0,
      "clicks": 0
    }
  },
  "alert": {
    "alert_name": "test alert",
    "search_criteria": "listing_type=sale",
    "alert_id": 21379,
    "frequency": 1,
    "last_sent": "2015-12-22 08:57",
    "ofi_alert": false,
    "email_address": "test@test.test",
    "subscribe_date": "2015-12-22"
  }
}

GET /api/alerts/update

Update existing fields of an alert.


Arguments

Field Required Description
api_key Yes Used for authentication
alert_id Yes The ID for the alert you wish to update
email_address No The email to recieve subscriptions from.
search_criteria No Url-encoded search criteria which is passed to search-listings.
frequency No The frequency of the emails in days. Default is 7.
alert_name No A name to identify the alert, used in email subject.


Example

$ curl http://www.listonce.com.au/api/alerts/update/?api_key=[YOUR API KEY]&email_address=test@test.test&search_criteria=listing_type%3Dsale&frequency=1&alert_name=test%20alert
---
{
  "alert_id": 21379,
  "success": true
}

GET /api/alerts/details/{alert_id}

Returns an object containing details about the subscription.


Arguments

Field Required Description
api_key Yes Used for authentication
alert_id Yes The ID for the alert you wish to unsubscribe


Example

$ curl http://www.listonce.com.au/api/alerts/unsubscribe/?api_key=[YOUR API KEY]&alert_id=21381
---
{
  "message": "Alert unsubscribed successfully",
  "error": false
}

GET /api/get-interactive-floorplans

Returns the data used to build an 'interactive' floorplan, with listing images tied to locations on the floorplan. Returns the URL of the floorplan image, and a list of attached images with X/Y locations (as a percentage).


Arguments

Field Required Description
api_key Yes Used for authentication.
floorplan_id No The ID of the interactive floorplan to return.
client_id No The ID of the Client (Office) to search interactive floorplans.
listing_id No The ID of the Listing to search interactive floorplans.

Example

$ curl http://www.listonce.com.au/api/get-interactive-floorplans?api_key=[YOUR API KEY]
---
{
  "total_floorplans": 1
  "floorplans": [
    {
      "listing_id": 88160,
      "floorplan_width": null,
      "markers": [
        {
          "y_percentage": "22.64151",
          "y_coordinate": null,
          "x_percentage": "10.83333",
          "x_coordinate": null,
          "image": "http://images.listonce.com.au/160/00088160_img_02.jpg"
        }
      ],
      "floorplan_height": null,
      "floorplan_url": "http://images.listonce.com.au/160/00088160_floorplan_01.gif",
      "interactive_floorplan_id": 2
    },
  ],
}

GET /api/external-links

Returns URL's and additional information used to build link libraries. Results are returned in a user-determined order.


Arguments

Field Required Description
api_key Yes Used for authentication.
client_id No For multi-office groups, this field is required. This limits the External Links to those for a single office

Example

$ curl http://www.listonce.com.au/api/get-external-links??api_key=[YOUR API KEY]
---
{
  "total_links": 3,
  "external_links": [
    {
      "url": "http://google.com.au",
      "image": "https://... /Google.png",
      "description": "Google Australia!\r\n\r\nsearch engine",
      "title": "Google AU"
    },
    {
      "url": "http://news.com.au",
      "image": "",
      "description": "",
      "title": "News"
    },
    {
      "url": "http://www.facebook.com",
      "image": "",
      "description": "",
      "title": "Facebook"
    }
  ]
}

Below is a list of all the possible property type/categories used by the API.


Residential

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

Rural

    Cropping
    Dairy
    Farmlet
    Horticulture
    Lifestyle
    Livestock
    Viticulture
    MixedFarming

Holiday

    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

Commercial

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

Below is a list of all the possible business categories/subcategories used by the API.

Business

Accommodation/Tourism
        Aged Care
        Backpacker/Hostel
        Boarding Kennels
        Caravan Park
        Function Centre
        Guest House/B&B
        Hotel
        Management Rights
        Motel
        Resort
        Retirement Village
        Theme Park
        Tours

    Automotive
        Accessories/Parts
        Aeronautical
        Auto Electrical
        Bike and Motorcycle
        Car Dealership
        Car Rental
        Car Wash
        Detailing
        Driving Schools
        Marine
        Mechanical Repair
        Panel Beating
        Service Station
        Truck
        Wreckers

    Beauty/Health
        Beauty Products
        Beauty Salon
        Dental
        Hair
        Hospital
        Medical
        Nails
        Nursing Home
        Massage
        Health Spa
        Medical Practice
        Natural Therapies
        Recreation/Sport

    Education/Training
        Child Care
        Employment/Recruitment
        Educational
        Training

    Food/Hospitality
        Alcohol/Liquor
        Bakery
        Butcher
        Cafe/Coffee Shop
        Catering
        Convenience Store
        Deli
        Distributors
        Fruit/Veg
        Juice Bar
        Manufacturers
        Restaurant
        Retailer
        Supermarket
        Takeaway Food
        Wholesalers

    Franchise

    Home/Garden
        Home Based
        Homewares/Hardware
        Irrigation Services
        Gardening
        Nursery

    Import/Export/Whole
        Freight
        Customs
        Import
        Export
        Wholesale

    Industrial/Manufacturing
        Building and Construction
        Civil
        Clothing/Footwear
        Electrical
        Food/Beverage
        Furniture/Timber
        Glass/Ceramic
        Machinery/Metal
        Manufacturing/Engineering
        Mining/Earth Moving
        Oil/Gas
        Paper/Printing
        Plastic
        Water
        Welding

    Leisure/Entertainment
        Adult
        Aircraft
        Amusements
        Aquatic/Marine
        Arts/Crafts
        Bars/Nightclubs
        Function Centre
        Gambling
        Garden/Nurseries
        Hotel
        Music/Video
        Recreation/Sport
        Sports Complex/Gym
        Vending

    Professional
        Accounting
        Advertising/Mkting
        Bookkeeping
        Brokerage
        Civil
        Communications
        Computer/IT
        Finance
        Insurance
        Internet
        Legal
        Media
        Medical
        Property/Real Estate
        Recruitment
        Scientific
        Security
        Travel

    Retail
        Clothing/Accessories
        Entertainment/Tech
        Florist/Nursery
        Food/Beverage
        Health/Beauty
        Homeware/Hardware
        Newsagency/Tatts
        Office Supplies
        Animal related
        Pharmacies
        Post Offices
        Vending

    Rural
        Aerial
        Agricultural
        Aquaculture
        Crop Harvesting
        Dairy Farming
        Farming
        Fertiliser
        Fishing/Forestry
        Fruit Picking
        Hunting/Trap
        Insemination
        Irrigation Services
        Land Clearing
        Livestock
        Machinery
        Mustering
        Shearing
        Wool Classing

    Services
        Aircraft
        Alarms
        Animal related
        Boats/Marine
        Car/Bus/Truck
        Cleaning
        Communication
        Copy/Laminate
        Courier
        Driving Schools
        Entertainment
        Garden/Household
        Hire/Rent
        Limousine/Taxi
        Machinery
        Management Rights
        Medical
        Mobile Services
        Pest related
        Pool/Water
        Print/Photo
        Repair

    Transport/Distribution
        Air
        Bus
        Car
        Parking
        Rail
        Road
        Sea
        Taxi
        Truck

Field List

Below is a list of all the possible fields returned by the API, including output formats and examples.

Name Description Output Example
listing_id The ListOnce unique ID for this listing. Integer 12345
property_type The property type for a listing. String - "Residential", "Commercial" or "Business" "Residential"
category The category for a residential listing. Residential listings only. String SEE CATEGORY LIST
commercial_category_1 The first category for a commercial listing. Commercial listings only. String SEE COMMERCIAL CATEGORY LIST
commercial_category_2 The second category for a commercial listing. Commercial listings only. String SEE COMMERCIAL CATEGORY LIST
commercial_category_3 The third category for a commercial listing. Commercial listings only. String SEE COMMERCIAL CATEGORY LIST.
business_category_1 The first category for a business listing. Business listings only. String SEE BUSINESS CATEGORY LIST
business_sub_category_1 The first subcategory for a business listing. Business listings only. String SEE BUSINESS SUBCATEGORY LIST
business_category_2 The second category for a business listing. Business listings only. String SEE BUSINESS CATEGORY LIST
business_sub_category_2 The second subcategory for a business listing. Business listings only. String SEE BUSINESS SUBCATEGORY LIST
business_category_3 The third category for a business listing. Business listings only. String SEE BUSINESS CATEGORY LIST
business_sub_category_3 The third subcategory for a business listing. Business listings only. String SEE BUSINESS SUBCATEGORY LIST
listing_type The listing type for a listing. String - "Sale", "Lease" or "Both". Business listings can only be listing type "Sale". Listing type "Both" only applicable to commercial listings.
sale_type The sale type for a listing. For listings with listing type "Sale" and "Both" only. String - "Sale", "Sale By Negotiation", "Set Sale", "Auction", "Tender"
property_status The property status for a listing. String - "Available", "Sold", "Leased".
property_status_extra An additional property status for a listing. String - "Deposit Taken", "Under Offer", "Under Contract"
agent The first and last name of the primary agent representing a property. String "John Doe"
agent_email The email address of the primary agent representing a property. String "reception@testestateoffice.com.au"
agent_description The description of the primary agent representing a property. String "John Doe has been a part of Real Estate for over 20 years, and specialises in property sales"
agent_position The position of the primary agent representing a property. String "Head of Sales"
agent_telephone The office telephone number of the primary agent representing a property. String "(03) 123 4567"
agent_mobile The mobile telephone number of the primary agent representing a property. String "0403 123 456"
agent_2 The first and last name of the secondary agent representing a property. String "John Doe"
agent_2_email The email address of the primary agent representing a property. String "reception@testestateoffice.com.au"
agent_2_description The description of the primary agent representing a property. String "John Doe has been a part of Real Estate for over 20 years, and specialises in property sales"
agent_2_position The position of the primary agent representing a property. String "Head of Sales"
agent_2_telephone The office telephone number of the primary agent representing a property. String "(03) 123 4567"
agent_2_mobile The mobile telephone number of the primary agent representing a property. String "0403 123 456"
agent_contract_status The status of the agent's representation of a property. !!!!!! String - "Open", "Conjunctional", "Exclusive"
address_hide Whether the address should be hidden for a listing. Boolean false
address_lot_number The prefix to a street number, referring to undeveloped blocks of land. Land listings only. String
address_municipality The local area (city council or municipal council) of a listing. String
address_postcode_hide - Whether the postcode should be hidden for a listing. Business listings only. Boolean.
address_postcode The postcode of a listing. String
address_site The site of the listing. Commercial and business listings only. String
address_state The state of a listing. String - Three-letter abbreviation of the state. "NSW"
address_street_name The street name of a listing (does not include the street type). String "George"
address_street_type The street type of a listing (does not include the street name). String "Street"
address_street_number The street number of a listing. String "12"
address_street_view_hide Whether the street view should be hidden for a listing. Boolean false
address_sub_number The prefix to a street number, referring to a unit or apartment number (for residential), or suite or shop number (for commercial and business). String
address_suburb_hide Whether the suburb should be hidden for a listing. Commercial and business listings only. Boolean false
address_suburb The suburb of a listing. String "Sydney"
address_text The address text to display instead of the real address. String
bond The amount of bond required for a listing. For residential listings with listing type "Lease" only. String
current_lease_end_date The date any current lease ends for the property. For commercial listings only. String - with date time format YYYY-MM-DD HH:MM:SS.
date_available The date the property is available for occupation. For residential listings with listing type "Lease" only. String - with date time format YYYY-MM-DD HH:MM:SS.
description The description of the listing. String
further_options Further options of a listing. For commercial and business listings only. String
headline The headline of the listing. String
is_home_land_package Whether the property is a house and land package. For residential listings with listing type "Sale" only. Boolean false
is_multiple Whether a listing covers multiple properties. For commercial listings only. Boolean false
outgoings Expenses incurred in generating income. For commercial listings only. !!!!!! String
property_extent The section of the building that is for lease. For commercial listings only. String - "Whole", "Part"
return_value The annual rate of return of a listing as a percentage. For commercial and business listings only. String
tenancy The tenancy status of a listing. For commercial listings only. String - "Vacant" or "Tenanted"
zone Describes the land-use zoning of a listing. For commercial listings only. String
bathrooms Number of bathrooms in a listing. Residential listings only. Integer
bedrooms Number of bedrooms in a listing. Residential listings only. Integer
ensuites Number of ensuites in a listing. Residential ilstings only. Integer
living_areas Number of living areas in a listing. Residential listings only. Integer
rooms Number of rooms in a listing. Residential listings only. Integer
toilets Number of toilets in a listing. Residential listings only. Integer
parking_carports Number of carport parking spaces in a listing. Residential listings only. Integer
parking_garages Number of garage parking spaces in a listing. Residential listings only. Integer
parking_other Number of non-carport and non-garage parking spaces in a listing (e.g. off-street parking). Residential listings only. Integer
parking_total Total number of all parking spaces in a listing. Residential listings only. Integer
parking_comments Comments about the parking in a listing. Commercial listings only. String "Secure parking provided"
features A list of features in a listing. Residential listings only. Array ["Air Conditioning", "Deck", "Shed"]
other_features Features in a listing, which do not appear within the regular list of features. Residential listings only. String "Greenhouse, large tomato patch"
business_lease The cost of the lease over a specified period for a listing. Business listings only. String
business_lease_period The business lease period. Business listings only. String
is_franchise Whether the listing is a franchise. Business listings only. Boolean
takings Describes the takings of the business. Business listings only. String
terms Describes the sale terms of a listing. Business listings only. String
auction_date The date of auction for a listing. For listings with sale type "Auction" only. String - with date format YYYY-MM-DD.
auction_time The time of auction for a listing. For listings with sale type "Auction" only. String - with time format HH:MM:SS.
auction_venue The location of the auction. For listings with sale type "Auction" only. String
price_range_display Whether the price range should be displayed. Boolean
price_range_min Used for a searchable price guide, this is the minimum amount the listing can be searched for. For listing type "Sale" listings, this is indicative of the price. For listing type "Lease" listings, this is indicative of the rent. !!!!!! String
price_range_max Used for a searchable price guide, this is the maximum amount the listing can be searched for. For listing type "Sale" listings, this is indicative of the price. For listing type "Lease" listings, this is indicative of the rent. !!!!!! String
price The price of a listing. Listing type "Sale" and "Both" only. String.
price_display Whether the price should be displayed. Boolean.
price_plus_sav Whether price includes the cost of any Stock At Valuation. Business listings only. Boolean
price_tax - Describes the sale tax. Applicable for commercial and business listings. String - "Unknown", "Exempt", "Inclusive", "Exclusive"
price_view The price text to display instead of the real price. String
sold_details_sold_date The date a listing was sold. Listing type "Sale" or "Both" and property status "Sold" listings only. String - in date format YYYY-MM-DD.
sold_details_sold_method The method of sale for a sold listing. Listing type "Sale" or "Both" and property status "Sold" listings only. String - "Private Sale", "Auction Sale", "Sold Before Auction", "Sold After Auction", "Sale By Tender", "Expression Of Interest"
sold_details_sold_price The price a listing was sold for. Listing type "Sale" or "Both" and property status "Sold" listings only. String
sold_details_sold_price_display Whether the sold price should be displayed. Boolean true
rent The weekly rental price of a listing. Residential listings with listing type "Lease" only. String
rent_display Whether to display the rental price of a listing. Boolean
rent_details_rent_date The date a listing was leased out. Listing type "Lease" or "Both" and property status "Leased" listings only. String - in date format YYYY-MM-DD.
rent_details_rent_duration The duration of the lease in weeks. Listing type "Lease" or "Both" and property status "Leased" listings only. Integer
rent_details_rent_period The rental period a listing has been leased for. Listing type "Lease" or "Both" and property status "Leased" listings only. String
rent_details_rent_price The rental price a listing has been leased for. Listing type "Lease" or "Both" and property status "Leased" listings only. String
rent_details_rent_price_display Whether the rent price should be displayed. Boolean
commercial_rent The annual rental price of a listing. Commercial listings with listing type "Lease" or "Both" only. String
commercial_rent_range_min The low end of the commercial rent range for a listing. Commercial listings with listing type "Lease" or "Both" only. String
commercial_rent_range_max The high end of the commercial rent range for a listing. Commercial listings with listing type "Lease" or "Both" only. String
commercial_rent_plus_outgoings Whether the commercial rent price includes outgoings. Commercial listings with listing type "Lease" or "Both" only. Boolean
commercial_rent_tax Describes the sales tax for commercial rent. Commercial listings with listing type "Lease" or "Both" only. String - "Unknown", "Exempt", "Inclusive", "Exclusive"
listing_area A list of all areas provided for a listing. Array of dictionaries. "listing_area": [
    {
        "area_type": "Building",
        "area": "80.00",
        "area_unit": "Square Meter"
    },
    {
        "area_type": "Land",
        "area": "100.00",
        "area_unit": "Square Meter"
    }
]
area The area of a listing. String
area_unit The unit of the provided area. String - "Square", "Square Meter", "Acre", "Hectare"
area_type Describe the type of area provided. String - "Land" or "Building.
area_range_max The high end of the area range for a listing. Commercial listings only. String
area_range_min The low end of the area range for a listing. Commercial listings only. String
area_of Describes the specific location the area is provided for. Commercial listings only. String - "Warehouse", "Office", "Industrial", "Hard Stand", "Showroom", "Retail", "Other"
cross_over Indicates if a cross over is present on a block of land. String - "Left", "Right" or "Center" "Left"
depth The measurement of depth for the property. String
depth_side The side of the provided depth. String - "Left", "Right", "Rear" "Left"
frontage The measurement of frontage for the property. String
expected_rental_income On Sale listings, the expected rental income of this property. String
expected_rental_period On Sale listings, the expected_rental_income its rental income frequency. String
rental_key_location On Lease listings, the location of the properties keys. String
additional_inspection_text Additional text for all inspections. String
 

Let's get started.

Fill in your details and we will get in contact with you to arrange your demonstration.