Indicator API

User assistance for Indicator API, machine to machine access to headline ABS statistics.

Print

About the Beta

This beta release allows you to preview ABS Indicator API before it is released in its final form and gives you the opportunity to provide the ABS with feedback as we work to enhance the service.  ABS Indicator API (Beta) should not be relied upon as a production system until the ABS formally advises you that the service is Live and ready for production use.

Data will be published in this channel shortly after embargo is lifted. For the most up to date information visit the ABS website. Availability of the ABS Indicator API (Beta) is not guaranteed. The service may be subject to change.

If you have feedback or questions, please contact the ABS APIs team at api.data@abs.gov.au. You can request to join our register of interest to be notified of any changes in the API. The ABS privacy policy outlines how the ABS handles any personal information that you provide to us.

Getting Started

The ABS Indicator REST API (Beta) allows you to request headline economic statistics from the ABS including Australia's key economic indicators.

All datasets are small, containing only the most in-demand data, so responses are returned as fast as possible. If you wish to access full economic datasets via API you can do so using the ABS Data API (Beta).

The ABS Indicator API uses the Statistical Data and Metadata Exchange (SDMX) standard. Data is available in XML, JSON and CSV.

 

Request Access

An API Key is required to access the ABS Indicator API. To request an API key, please carefully read the ABS Indicator API Terms of Use. Then download and complete the 'ABS Indicator API Key Request Form' indicating that you accept and agree to abide by the 'Terms of Use'. Send the completed request form to api.data@abs.gov.au.

The ABS privacy policy outlines how the ABS handles any personal information that you provide to us in requesting access to this service.

ABS Indicator API Key Request Form
Download docx [629.52 KB]

Response Format

Data is available in JSON, CSV and XML. 

Metadata is available in JSON and XML.

Data and metadata is returned using the Statistical Data and Metadata Exchange (SDMX) standard. Information on the standard is available on SDMX.org. Further information on how to interpret SDMX data responses is available in the Understanding SDMX Data section of the Data API User Guide.

 

Authentication

Access to this API is managed by API Key. Once you have been issued an API Key, you must add it as a header in your API requests: 

"x-api-key: xxxxxxxxxxxxxxx"

 

API Specification

The OpenAPI / swagger definition for this service is available at https://raw.githubusercontent.com/apigovau/api-descriptions/master/abs/indicator.openapi.yaml

Base URL

The endpoint for the ABS Indicator API is: https://indicator.api.abs.gov.au

Get Data
  • GET /v1/data/{dataflowIdentifier}/{format}
Get Metadata
  • GET /v1/metadata/{dataflowIdentifier}/{format}
  • GET /v1/dataflows/{format}

 

GET Data

https://indicator.api.abs.gov.au/v1/data/{dataflowIdentifier}/{format}

Returns data for the specified dataflow. In the ABS Indicator API a 'dataflow' identifies a collection of data on a single topic. Dataflows correspond to ABS statistical releases, some releases may be published across multiple dataflows. 

Dataflow Identifier, a single string which identifies the dataflow you are requesting data from (e.g. CPI_H). This field is required. 

A list of all available dataflows and their identifiers can be returned using: GET https://indicator.api.abs.gov.au/v1/dataflows/{format}.

Format must be specified as one of the following supported formats:

  • json
  • csv
  • xml

The ABS Indicator API will not accept any custom data queries or query parameters. The GET Data method will return one standard data response for each dataflow in the format specified.

 

GET Metadata

GET metadata

https://indicator.api.abs.gov.au/v1/metadata/{dataflowIdentifier}/{format}

Returns metadata for the specified dataflow including name, version and structure.

Dataflow Identifier, a single string which identifies the dataflow you are requesting metadata from (e.g. CPI_H). This field is required. 

Format must be specified as one of the following supported formats:

  • json
  • xml

The structural metadata returned includes information on Codelists and Concept Schemes which combine to define the dimensions of the dataflow.

Codelists provide a list of codes used to define data in the dataflow. Each code has an ID and a name. Codes may also have a parent ID which defines a hierarchy within the codelist.

Concept Schemes are groups of related Concepts. Concepts are associated with all artefacts in the data structure: dimensions, annotations, etc., and define what each artefact is and how it is used. Concepts include an ID, name and description.

GET dataflows

https://indicator.api.abs.gov.au/v1/dataflows/{format}

Returns a list of all dataflows available in the ABS Indicator API and their corresponding dataflow identifiers.

Format must be specified as one of the following supported formats:

  • json
  • xml