RBA Cash Rate: 4.35% · 1AUD = 0.67 USD · Inflation: 4.1%  
Leading Digital Marketing Experts | 1300 235 433 | Aggregation Enquires Welcome | Book Appointment
Example Interest Rates: Home Loan Variable: 5.69% (5.89%*) • Home Loan Fixed: 5.48% (6.24%*) • Fixed: 5.48% (6.24%*) • Variable: 5.69% (5.89%*) • Investment IO: 5.74% (6.40%*) • Investment PI: 5.49% (6.27%*)

How to Use the Property Railway Station API

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.

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.

The primary purpose of the API is to make distance information available to property widgets (such as distances to nearest stations etc.) and to provide general information on user websites via a search engine.

  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 Railway Station API is a very simple RESTful service that provides a facility to query Australian rail stations. Queries to the Rail API are made to property/rail/{action}.json with the various 'actions' detailed in this FAQ. Each action and typical responses will be introduced in turn.

Data is updated on the first Monday of each week.

  State

The state action returns all stations within a particular state. The purpose is to provide a package that you can query individually and cache locally. A request to rail/state.json?state=nsw unfolds as follows. If no state is provided nsw will be used.

1
(
2
    [status] => 200
3
    [code] => 200
4
    [data] => Array
5
        (
6
            [3153064b63a64236804f773bfac40409] => Array
7
                (
8
                    [name] => Killara Railway Station
9
                    [state] => NSW
10
                    [latitude] => -33.7654
11
                    [longitude] => 151.162
12
                    [coordinates] => S33°45′55.44″ E151°9′43.2″
13
                    [key] => 3153064b63a64236804f773bfac40409
14
                )
15
 
16
            [dd5fcd8898694ebcccba3910fb7616e3] => Array
17
                (
18
                    [name] => Martin Place Railway Station
19
                    [state] => NSW
20
                    [latitude] => -33.8679
21
                    [longitude] => 151.212
22
                    [coordinates] => S33°52′4.44″ E151°12′43.2″
23
                    [key] => dd5fcd8898694ebcccba3910fb7616e3
24
 
25
            [ SNIP ]
26
 
27
            [d73f1eae990b1d64f97274e1559db33f] => Array
28
                (
29
                    [name] => Shellharbour Junction Railway Station
30
                    [state] => NSW
31
                    [latitude] => -34.5913
32
                    [longitude] => 150.845
33
                    [coordinates] => S34°35′28.68″ E150°50′42″
34
                    [key] => d73f1eae990b1d64f97274e1559db33f
35
                )
36
 
37
        )
38
 
39
    [message] => Array
40
        (
41
            [0] => Success
42
        )
43
 
44
)

Results are indexed on the query key (valid for the Property listing API).

  Nearest and Radius

The nearest and radius endpoints are virtually identical and will return stations within a defined radius of a specific geographical point. The latitude, longitude and radius are required. If the former two are not provided no results will be returned.

1
(
2
    [status] => 200
3
    [code] => 200
4
    [data] => Array
5
        (
6
            [222d7679fa32b308e772dd03cf671170] => Array
7
                (
8
                    [name] => Circular Quay Railway Station
9
                    [state] => NSW
10
                    [latitude] => -33.8613
11
                    [longitude] => 151.211
12
                    [coordinates] => S33°51′40.68″ E151°12′39.6″
13
                    [key] => 222d7679fa32b308e772dd03cf671170
14
                    [distance] => 0.0131265
15
                )
16
 
17
            [ea98fc302e6a353d5eb9cab9367eacad] => Array
18
                (
19
                    [name] => Circular Quay Light Rail Stop
20
                    [state] => NSW
21
                    [latitude] => -33.8614
22
                    [longitude] => 151.211
23
                    [coordinates] => S33°51′41.04″ E151°12′39.6″
24
                    [key] => ea98fc302e6a353d5eb9cab9367eacad
25
                    [distance] => 0.0230687
26
                )
27
 
28
            [6dfcb8ad63dbc7ec8f4009a6f5b1a705] => Array
29
                (
30
                    [name] => Newtown Railway Station
31
                    [state] => NSW
32
                    [latitude] => -33.8978
33
                    [longitude] => 151.18
34
                    [coordinates] => S33°53′52.08″ E151°10′48″
35
                    [key] => 6dfcb8ad63dbc7ec8f4009a6f5b1a705
36
                    [distance] => 4.98886
37
                )
38
 
39
        )
40
 
41
    [message] => Array
42
        (
43
            [0] => Success
44
            [count] => 45
45
        )
46
 
47
)

Results are indexed on the query key (valid for the Property listing API).

  Browse and Search

The browse and search endpoints are virtually identical with the exception that the search endpoint is used if filtering URL attributes are provided. The browse endpoint requires the page, limit, orderby, and order attributes (else default values are used). The search parameters are simply name and state. Since both results are similar, a basic (paginated) response for a search of 'burwood (with just two results)' is shown. Had we included '&nsw=nsw' only a single result would be returned.

1
(
2
    [code] => 200
3
    [status] => 200
4
    [page] => 1
5
    [limit] => 30
6
    [number_records] => 2
7
    [pages] => 1
8
    [data] => Array
9
        (
10
            [0] => Array
11
                (
12
                    [name] => Burwood Railway Station
13
                    [state] => NSW
14
                    [latitude] => -33.8771
15
                    [longitude] => 151.104
16
                    [coordinates] => S33°52′37.56″ E151°6′14.4″
17
                    [key] => db6c8e9b9c9c9489c64302f1eef6f705
18
                )
19
 
20
            [1] => Array
21
                (
22
                    [name] => Burwood
23
                    [state] => VIC
24
                    [latitude] => -37.8515
25
                    [longitude] => 145.081
26
                    [coordinates] => S37°51′5.4″ E145°4′51.6″
27
                    [key] => 449d554493384ca00c969ec472b698dc
28
                )
29
 
30
        )
31
 
32
)

The search feature is usually used for partial name matches.

  Conclusion

Property widgets have the option of showing a small rail icon with a distance to the nearest rail station, and it's this function that is the primary purpose of this API. That said, we do include a rail search engine on your website simply because we can.

  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 ]

  Related FAQs

Share this FAQ

Share on Facebook
Share on Twitter
Share on Linkdin
Share on Pinterest