The Property-industry licences API has been developed to enable browsing, verification and obtaining of NSW government property industry licencing information for real estate agents, strata agents, property managers, stock and station agents and more.
The information contained in this service is restricted to information which NSW Fair Trading is required to maintain under the Property Stock and Business Agents Act 2002 from 1st September, 2003 onwards.
NSW Fair Trading disclaims all responsibility and all liability (including without limitation, liability in negligence) for all expenses, losses, damages and costs which you might incur as a result of the information being inaccurate or incomplete in any way, and for any reason.
Browse – Provides an option to enter in partial information that returns a list of results based on the search criteria. This service is targeted for non-specific search parameters like names. The results are limited to a maximum number of 200 returns to avoid unnecessary loads on the services. The result of the Browse search provides a limited set of base level data as defined below.
Verify – Similar to the browse API, however Verify can be used with more specific parameters such as Licence Number, where only one record is expected to be returned. This also provides a limited set of licence specific information that can be used for licence validation.
Detail – The Detail API is to be used with details provided from either of the browse or verify API’s and will only return one record at a time. The API provides the set of information about the individual licence selected, that corresponds to the level of information available on the detailed screen of the Public Register application.
Browse requests contain search text and licence group data as URI parameters that return a collection of resources that match the specified criteria.
Verify requests contain licence group data and licence number as URI parameters which return limited details for a single licence number that is confirmed.
Details request contain licence ID and licence group data as URI parameters which return comprehensive details for a specific licence identifier.
Browse requests return a collection of responses for the specified criteria that matched while verify and details requests return single response for the licence provided.
HTTP 200 response is returned for success, 404 if search text misses, 500 for internal server error, 400 for bad request (e.g. licence group missing) and 401 for unauthorised access.
Data types the API returns and accepts are JSON values that are in string format.
The table below shows date, version number and a detailed description of changes or modifications made to the Property Industry Licensing API. Expected or scheduled changes are indicated in a green colour while yellow is used to indicate completed upgrades or changes.
|1-March-2017||1.0||Property Industry Licensing API launched|
The Property Industry Licensing API is secured with 0Auth 2.0 protocol. In order to use our API you must be a registered user with a valid username and password. Access levels on the API will be dependent on specific user needs.
Authorisation credential consisting of a consumer key and secret (password) are provisioned to clients for future validation.
An OAuth call is required to provide the consumer with an authorisation token that would last approximately 12 hours from the time when request was made. The user would need to send this authorisation token with every subsequent request in order to get appropriate results from the API.
For more information see OAuth 2.0