The Property Emergency Services API is a means to access location information for Australian police stations, ambulance stations, fire stations, and SES facilities. For most users, this API information isn't necessary nor relevant, but many have technical skills that permits them to integrate various types of data with their existing applications. The API itself is used extensively by the Yabber property modules.
Property Module: Yabber's Property Module is extensive. The module makes property listing, analytical, and other data available to you, your child users, and partners. A large number of APIs may be used to access data for other applications. Review an introduction to the Property Module here. A commonly referenced FAQ details how to include a Property Listing Widget on your website, and another details how to assign a property to an existing widget location.
Property API Key: The Property API Key is different to your standard 'Personal' API Key and must be accessed through the Property Module (and then saved on your website
). The Property Module is a completely standalone module that integrates directly with Yabber. Basic API Documentation introducing the Property API may be found here.If you would like to access the API programmatically, you may reference a basic PHP function here.
Property API Endpoint
The Endpoint for all requests to the Property API is structured as follows:
api.beliefmedia.com/property/{category}?/{action}.json?apikey={apikey}
The preferred method of authentication of your API Key is in the Authorisation Header (Authorization: Bearer {token}
) as support for the URL parameter will soon be deprecated. Requests to child datasets will always include a {category}
while the primary (listing) property endpoint is accessed directly. More information on the Property API is available here.
Introduction
The Emergency API is a standard read-only RESTful API providing up-to-date access to emergency facilities in Australia. All requests will return only police stations unless a source is provided in each request. To instruct the API to return data for a specific emergency type, the integer sources are provided in a comma-delimited string from the following options:
- police
- ambulance
- fire_metro
- fire_country
- ses
Example: Querying only fire station data will include the url query of &source=3,4
.
Data is updated every Monday so we suggest you set any cached data to expire after 3pm on that day. No limitations are applied for general use.
Postcode
Querying emergency/postcode.json?postcode=2134
will return data as shown below. Note that we're only returning police stations.
If we add the source as &source=1,2,3,4,5
the following will be returned.
If multiple stations of any type are in the same postal region, multiple results will obviously be returned. A request to emergency/postcode.json?postcode=2134&source=1,2,3,4,5
returns the following.
For all examples we'll simply query police stations for brevity. Paginated results will include the source
in the resulting array (they will not be index on the facility type).
Suburb
Querying emergency/suburb.json?suburb=sydney&state=nsw&source=1
will unfold as shown below. The state is generally required in name-based requests to exclude interstate facilities.
The distance_to_po_{k|m|n}
field returns the distance from that facility to the suburb post office.
Nearest and Radius
Those facilities nearest to a geographical reference point will be returned in a standard format. The reference point may be a 'key
' (as returned with each result), a postcode
, or a latitude
and longitude
.
We'll query nearest.json?longitude=141.799&latitude=-37.8584&radius=50000&source=1,2,3,4,5
(using a latitude
and longitude
) with a result as follows:
Browse
The browse
endpoint returns paginated results of all referenced source types. The query string should include page
(page number), limit
(number of results), order (asc
or desc
), and orderby
('id
', 'name
', 'suburb
', 'postcode
', 'address
', or 'state
').
Querying emergency/browse.json?page=3&limit=10&orderby=id&order=asc&source=1
unfolds as follows:
Search
You may use the more common search endpoint to filter on name
(of the facility), state
, postcode
, or suburb
. The page
, limit
, orderby
, and order
parameters may also be passed to paginate results.
Querying search.json?name=cro&page=1&limit=10&orderby=id&order=asc&source=1&source=1,2,3,4,5
unfolds as a paginated response resembling the following (the query is one on the partial match of 'cro
'):
Note: An autocomplete endpoint is also provided to search addresses.
Conclusion
Like many of the backend APIs we use as part of the Property architecture, the API in isolation - while it provides good up-to-date information - is one that may not be overly useful. However, we do provide an emergency services search facility on client websites that references this API exclusively.
Related Property API FAQs
Article relating to the Property API.
The Property Streets API is a means to access registered street and address data from Yabber. For most users, this information isn't necessary nor relevant, but many have technical skills that permits them to integrate various types of data with their existing applications. Other Property FAQs show how to assign property widgets and video to… [ Learn More ]
The Property Emergency Services API is a means to access location information for Australian police stations, ambulance stations, fire stations, and SES facilities. For most users, this API information isn't necessary nor relevant, but many have technical skills that permits them to integrate various types of data with their existing applications. The API itself is… [ Learn More ]
The Property Railway Station API is a means to access the location of Australian railway stations. For most users, this information isn't necessary nor relevant, but many have technical skills that permits them to integrate various types of data with their existing applications. The API itself is used extensively by the Yabber property modules.
Related Property FAQs
Article relating to the Yabber and Website Property modules.
This FAQ details the methods necessary to create a parent Property API Key. While the Property modules are intrinsically connected with all our modules, it operates autonomously via a standalone API-centric system that connects with multiple external applications. In order to use the Property module, you must first be assigned to the module (which is… [ Learn More ]
In a previous FAQ we looked at how to include an address validation field into a form on your website. This FAQ will introduce the same style of field that will automatically direct the user to the single page associated with each registered address in Australia. This feature is part of the broader Property… [ Learn More ]
The Property Property Streets API, and the Validation Endpoint in particular, is a means to access registered street and registered address location from Yabber via a form input field. The Validation (or Autocomplete) endpoints are useful for searching property on user keystrokes. The validation may be used to ensure pinpoint accuracy is assured by way… [ Learn More ]
SMS Subscription forms may be used in any number of ways, but the primary purpose is to support text message alerts for various types of property opportunities. When the form was first introduced, the form was part of our supporting partner modules, but more and more brokers are becoming affiliate directly with property groups, and… [ Learn More ]