Definitions Catalogue

Getting Started

Collaborate

Using the API

Search

Browse

Details

Domains

Posting

Getting Started

The Definitions Catalogue REST API allows you to search and browse for data definitions used by the Australian Government.

Key Information

Base URL

All URLs referenced in the documentation have the following base:

https://api.gov.au/definitions/api/

The Definitions Catalogue API is served over both HTTP and HTTPS.

Response Format

Responses are in JSON

OpenAPI specification

The OpenAPI / Swagger documentation for the API is here

Here's an automatically generated class diagram of the service.

Generated class diagram from swagger

Click for bigger version

We try to keep it up to date, but the documentation you're reading is you're best bet and understanding the API.

Authentication

This API is 100% public.

There is no Authentication for read only requests.