VIEW API 

 

Tradie API has been developed for browsing, verifying and obtaining detailed information on various tradesperson licences. These include plumbers, electricians, AC engineers etc.

Disclaimer 

The information contained in this register is restricted to that information which NSW Fair Trading is currently required to maintain under section 120 of the Home Building Act 1989 and clause 69 of the Home Building Regulations 2014.

Please note also that, while Fair Trading issues licences to qualified and, in some cases 'experienced', builders and tradespeople, it cannot and will not guarantee the work of licensees

Consequently, NSW Fair Trading disclaims all responsibility and all liability (including without limitation, liability in negligence) for all expenses, losses, damages and costs which might incur as a result of using information in the register, or for it being inaccurate or incomplete in any way, and for any reason.

Browse – Provides a Search option to enter in partial information and return a list of results of the search. 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 results of the Browse request provides a limited set of base level data as defined below. 

(Learn More...)

Verify – Similar to the browse API, but 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 information that can be used for a quick verification of a licence.

(Learn More...)

Detail  – This API is to be called with details provided from either of the browse or verify API and will only return one record at a time. The API provides a set of detailed information about the individual licence selected that corresponds to the level of information seen on the detailed screen of the Public Register application.

(Learn More...)  

Request format 

The Browse requests contain searchable text and licence group data as URI parameters that return a collection of data within the specified criteria.

Verify requests contain licence group and licence number as URI parameters which return limited details for a single licence number that is confirmed.

Detail requests contain licence ID and licence group as URI parameters which return comprehensive details for a specific licence identifier.

Response format 

Browse requests return a collection of responses for the specified criteria 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 data types the API returns and accepts are all in JSON values displayed in string format.

The Tradie API has specific endpoint request limitation to authorised users. We reserve the right to adjust rate limits for any given endpoint in order to improve the quality of service provided to users. Every API consumer will be limited to a number of requests based on their agreement.

The table below shows date, version number and a detailed description of recent changes or modifications done on the Tradie API. Expected or scheduled changes are indicated in a green colour while yellow is used to indicate completed upgrades or changes.

Recent API Changes
Date Version Description
21-Oct-2016 1.0 Tradie API development portal launched
13-June-2018 1.0 If a request parameter does not have a value, return "bad request". If a record can not be found, return 200 with an empty JSON

For a detailed release history, please click here

The Traide API is secured with OAuth 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 Tradie API will be dependent on specific user needs. Please refer to your agreement for details.

Authorisation credential consisting of a consumer key and secret (password) are provisioned to clients for future validation. These are issued as per the users specific agreement with api.nsw.

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

 

Detailed information on security of Tradie API

 

Complete technical pdf documentation

 

VIEW API