An API is available for developers to search our database.

Data can be returned in JSON or XML.

All options on the search form are available.

Our standard and corporate payment options can also be used for API accounts.

Contact us for more information

Technical details

Endpoint

API requests should be HTTP GET request (with parameters in the querystring) to

http://reversephones.com.au/api/<endpoint>

where <endpoint> is one of search (well, actually, it's just search at this point, but soon there will be more endpoints).

Response formats

The default response format is XML, but you can get a JSON response by altering the request URL to this

http://reversephones.com.au/api/<endpoint>/index/format/json

You can get a one-entry-per-line simplified format for use in Asterisk servers by altering the request URL to this

http://reversephones.com.au/api/<endpoint>/index/format/asterisk

Search

Parameters

Parameter Values Default value Description
username (required) Your reversephones.com.au username    
password (required) Your reversephones.com.au password    
phone_number Any string of digits empty Fields used the same as on the advanced search page
surname Any string (case is ignored) empty Fields used the same as on the advanced search page
initials Any string (case is ignored) empty Fields used the same as on the advanced search page
street_number Any string (e.g., 4, 3B, etc.; do not include flat/unit number; case is ignored) empty Fields used the same as on the advanced search page
street_name Any string of letters (case is ignored) empty Fields used the same as on the advanced search page
street_type The short version of the street type, e.g., ST for STREET or RD for ROAD. Check out the advanced search page for a full list. empty Fields used the same as on the advanced search page
locality Any string of letters (case is ignored) empty Fields used the same as on the advanced search page
postcode A string of 4 digits empty Fields used the same as on the advanced search page
state One of ACT, NSW, NT, QLD, SA, TAS, VIC, WA empty Fields used the same as on the advanced search page
information_level One of all or full-only all If all is specified, then all records are returned, otherwise only records with all details are returned.
listing_type One of all, residential or business all If all is specified, then all records are returned, otherwise only residential or business records are returned.
search_mode One of exact or fuzzy exact If exact is specified, then only records that match the supplied parameters exactly are returned. Otherwise, records that begin with the supplied parameters are returned.
historical_records One of all or latest-only all If latest-only is specified, then only one record per phone number will be returned (this will be the most recent record). Otherwise, all records will be returned.
year A string of 4 digits empty If specified, the search will return only records that were current in the year given.
street_number_start An integer empty If specified, the search will return records that have street numbers greater than or equal to the specified value. Street numbers will be truncated to integer-only values, e.g., '4B' will be truncated to '4'.
street_number_end An integer empty If specified, the search will return records that have street numbers less than or equal to the specified value. Street numbers will be truncated to integer-only values, e.g., '4B' will be truncated to '4'.
year_start An integer empty If specified, the search will return records that were valid in or after the specified year.
year_end An integer empty If specified, the search will return records that were valid in or before the specified year.
pay One of 0 or 1 0 If 0 is specified and the user doesn't have an unlimited subscription, only the number of results matched will be returned. The user can then re-run the search with pay=1 to retrieve the actual results.

Example query

Request

http://reversephones.com.au/api/search?username=USERNAME&password=PASSWORD&phone_number=0882420751

Response

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<api version="1.0">
        <status>success</status>
        <search id="81" resultCount="7">
                <user id="5" credits="0" isPaid="true">
                        <subscriptions>
                                <subscription id="8" credits="-1"></subscription>
                        </subscriptions>
                </user>
                <params>
                        <start>0</start>
                        <count>50</count>
                        <phone_number>0882420751</phone_number>
                        <surname></surname>
                        <initials></initials>
                        <street_number></street_number>
                        <street_name></street_name>
                        <street_type></street_type>
                        <locality></locality>
                        <postcode></postcode>
                        <state></state>
                        <listing_type>all</listing_type>
                        <search_mode>exact</search_mode>
                </params>
        </search>
        <results count="7">
                <result id="4653569" surname="Mausolf" initials="DB" phoneNumber="0882420751">
                        <address floor="" unitFlat="" streetNumber="37" streetName="DEVON" streetType="ST" locality="LARGS BAY" state="SA" postcode="5016"></address>
                        <valid dateTime="Tue, 31 Dec 2002 23:30:00 +1030" accuracy="year"></valid>
                </result>
                <result id="22152987" surname="MAUSOLF" initials="DB" phoneNumber="0882420751">
                        <address floor="" unitFlat="" streetNumber="37" streetName="DEVON" streetType="ST" locality="LARGS BAY" state="SA" postcode="5016"></address>
                        <valid dateTime="Mon, 31 Oct 2005 23:30:00 +1030" accuracy="month"></valid>
                </result>
                <result id="30828179" surname="Mausolf" initials="DB" phoneNumber="0882420751">
                        <address floor="" unitFlat="" streetNumber="37" streetName="DEVON" streetType="ST" locality="LARGS BAY" state="SA" postcode="5016"></address>
                        <valid dateTime="Sun, 31 Dec 2006 23:30:00 +1030" accuracy="year"></valid>
                </result>
                <result id="41065992" surname="Mausolf" initials="DB" phoneNumber="0882420751">
                        <address floor="" unitFlat="" streetNumber="37" streetName="DEVON" streetType="ST" locality="LARGS BAY" state="SA" postcode="5016"></address>
                        <valid dateTime="Thu, 31 Dec 2009 23:30:00 +1030" accuracy="year"></valid>
                </result>
                <result id="44058415" surname="Mausolf" initials="DB" phoneNumber="0882420751">
                        <address floor="" unitFlat="" streetNumber="37" streetName="DEVON" streetType="ST" locality="LARGS BAY" state="SA" postcode="5016"></address>
                        <valid dateTime="Wed, 31 Dec 2008 23:30:00 +1030" accuracy="year"></valid>
                </result>
                <result id="57559605" surname="Mausolf" initials="D B" phoneNumber="0882420751">
                        <address floor="" unitFlat="" streetNumber="37" streetName="DEVON" streetType="ST" locality="LARGS BAY" state="SA" postcode="5016"></address>
                        <valid dateTime="Tue, 31 May 2011 23:30:00 +0930" accuracy="month"></valid>
                </result>
                <result id="64824444" surname="Mausolf" initials="D B" phoneNumber="0882420751">
                        <address floor="" unitFlat="" streetNumber="37" streetName="DEVON" streetType="ST" locality="LARGS BAY" state="SA" postcode="5016"></address>
                        <valid dateTime="Sun, 01 Jan 2012 10:30:00 +1030" accuracy="month"></valid>
                </result>
        </results>
</api>