The API is a digital tool for software developers that provides access to our Modern Awards Pay Database's current and historical minimum rates of pay, allowances, overtime and penalty rates data in a digital format. It means that data from the Database can be integrated into software products and apps.
On this page:
-
Getting Started with APIs
This animation provides an overview of the Modern Awards Pay Database Application Programming Interface (MAPD API). It includes information on what an API is, what the MAPD API is, the data that is included in the MAPD, and some of the benefits of the MAPD API.
Register online
You can register to access the API using our online portal: Modern Awards Pay Database API. For more details see Registering for the APIs.
What are APIs?
The advent of the internet and smart devices has revolutionised the way Australians do business, with many employers using accounting products, payroll software or apps to assist when paying their employees.
This digitalisation of business practices provides greater connectivity between individuals, organisations and government. An example of this has been the public release of data such as our Modern Awards Pay Database, which enables public access to calculated pay rates within modern awards.
Application Programming Interfaces (or APIs for short) allow connectivity between systems to securely exchange information in a predetermined, machine-readable format. This enables increased automation drawing from an existing source of data or information. So when an event occurs, for example a change to a modern award minimum rate of pay, an API can trigger the push or pull of information from our Modern Awards Pay Database to a user's system.
Most Australians use APIs on a daily basis without even knowing. For example, when you use your phone to retrieve the local weather conditions or by a booking website to retrieve airfare prices and schedules when you are thinking about a holiday.
What is the Modern Awards Pay Database API?
The Modern Awards Pay Database API provides users (such as software developers who register with our API) with the ability to call on and retrieve the latest updates to modern award rates within the Modern Awards Pay Database in a structured digital format. The Modern Awards Pay Database API includes access to the following information available from the Modern Awards Pay Database:
- minimum rates of pay for each classification
- most penalty rates, overtime, and casual rates
- some junior and apprentice rates, and
- some wage-related and expense-related allowances.
For information on what the Modern Awards Pay Database doesn’t include, see Are there rates that are not included in the Modern Awards Pay Database in the Frequently asked questions section below.
An optional subscription service for each modern award will be provided from the developer portal, sending a digital notification of any changes to rates or allowances when that rate comes into effect.
What you need to know before using the Modern Awards Pay Database API
The Modern Awards Pay Database API provides access to the Modern Awards Pay Database’s calculated rates. It is not a replacement for the requirement to understand, review and reference the applicable modern award or any other applicable instrument to ensure compliance with the law.
The Modern Awards Pay Database API’s terms of use require users to agree to and therefore be aware of circumstances in which the Modern Awards Pay Database API should be used. This includes ensuring that the user is aware that the Modern Awards Pay Database’s rates must be read in conjunction with the applicable modern award or any other applicable instrument.
The Modern Awards Pay Database API, for example will not advise whether a modern award or other industrial instrument applies or covers an employer or employee and sets their minimum entitlements, whether there have been changes in coverage or classification definitions within modern awards, or when particular classifications or entitlements apply.
If you don’t know which modern award or other industrial instrument applies or covers an employer or employee, visit the Fair Work Ombudsman's website.
Anticipated benefits of the Modern Awards Pay Database API
The anticipated benefits of the Modern Awards Pay Database API include:
- providing access in a digital friendly format to our Modern Awards Pay Database of over 70,000 modern award minimum pay rates, allowances, overtime and penalty rates
- removing the need to manually transcribe, extract, recreate or recalculate rates of pay, allowances, overtime and penalties, and/or associated calculations held within our Modern Awards Pay Database into software by enabling a direct service to our Modern Awards Pay Database rates
- improving speed of access, via the API, to updated Modern Awards Pay Database rates at the time of a change
- providing access, via the API, to current and known future rates (for example those soon to take effect following a published Commission decision), as well as rates for years dating back to 2015.
If you’re an employer or advisor to Australian businesses and have further questions related to the Modern Awards Pay Database API, please read our Frequently asked questions.
If you're interested in developing a software product that uses the Modern Awards Pay Database APIs then the information below will outline the process to get started.
Developing software using the API
If you are a software developer who wants to get started with the Modern Awards Pay Database API, then this section is for you.
Getting started with the Modern Awards Pay Database APIs is simple but there are some minimum expectations of software developers.
Development and pre-production testing
While we expect the APIs will be easy to understand for developers who are familiar with the existing modern award documentation, we have prepared an API Integration Best Practices Guide for developers to assist them to effectively leverage the Modern Awards Pay Database API.
Read the MAPD API Integration Best Practice Guide.
Registering for the APIs
You don't need to be registered to explore the Modern Awards Pay Database APIs to gain a basic understanding of how they work and the information they provide.
You will need to register prior to being able to use the ‘Try Me’ functionality or make API calls from your software.
Step 1. Go to Modern Awards Pay Database API.
Step 2. Click the yellow 'Log-in/Register' button (in the middle of the home screen)
Step 3. Click on the 'Sign up now' link at the bottom of the form (if you don’t already have an account)
Step 4. Complete the user details, which include:
- email address (which must be verified)
- new password
- given name
- surname
- contact phone number
- organisation, and
- ABN (Australian Business Number).
Step 5. Read the Important information statement and check the ‘I have read and understand the important information’.
Step 6. Review the Terms of Use. After reviewing them and if you agree to them, check the ‘I have read and agree to the terms of use’ box.
You will not be able to use the API if you do not agree to the Terms of Use.
Step 7. Click ‘create’ button.
Step 8. Subscribe to the Modern Awards Pay Database API
- Click the ‘Subscribe’ link on the main menu bar.
- Type your subscription name.
- Click the ‘Subscribe’ button and your subscription will be created.
You will automatically be redirected to the ‘User Profile’ page that will show your new subscription including your API keys, which you will manage from this screen going forward.
Once your subscription is approved, you will also receive a confirmation email which includes some useful information and links.
Step 9. Start exploring the Modern Awards Pay Database API.