Australian Bureau of Statistics Get Data API

openapi: 3.2.0
info:
  title: Australian Bureau Of Statistics Get Data API
  contact:
    email: api.data@abs.gov.au
  version: '1.0'
  description: 'Operations tagged Get Data across 2 of this provider''s published API definitions: DataAPI.openapi.yaml, indicator.openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://data.api.abs.gov.au
- url: https://indicator.api.abs.gov.au
tags:
- name: Get Data
paths:
  /rest/data/{dataflowIdentifier}/{dataKey}:
    get:
      tags:
      - Get Data
      summary: Get data from a dataflow in XML, JSON or CSV
      operationId: GetData
      parameters:
      - name: dataflowIdentifier
        in: path
        description: "The dataflow identifier in {agencyId},{dataflowId},{version} format (eg. \"ABS,CPI,1.1.0\"). \nA list of all available dataflows can be returned using the *GET /rest/{structureType}/{agencyId}* operation.\nagencyId and version are optional. If agencyId is not specified it will default to “all”. If version is not specified it will default to “latest”.\n"
        required: true
        schema:
          type: string
      - name: dataKey
        in: path
        description: "The key to query data returned.\nUse \"all\" if you would like to return all data for the dataset.\nTo filter data returned provide a data key, containing one or more coded values for each dimension, separated by a dot (dimensions must be in the order they are defined in the data structure). \nFor example “1.115486.10.50.Q”  filters for a single Consumer Price Index series\n\n* *Measure*: 1 - Index Number\n* *Index*: 115486 - Health\n* *Adjustment Type*: 10 - Original\n* *Region*: 50 - Weighted average of eight capital cities\n* *Frequency*: Q - Quarterly\n\n\nWildcarding is supported by omitting values for the dimension. Eg. data for all regions: “1.115486.10..Q”.\nThe OR operator is supported using the + character. Eg. data for 2 series “1.131188+131189.10.50.Q”. \nYou can combine wildcarding and the OR operator. Eg. “1.131188+131189.10..Q\".\n  \nThe maximum allowed length of this parameter is currently 260 characters. Requests that exceed this limit will return a 400 error. We intend to increase this limit soon.\n\nThe dataKey parameter is case sensitive.\n"
        required: true
        schema:
          type: string
      - name: startPeriod
        in: query
        description: "The start period (used to filter on time). This is inclusive. The value can be in the following formats:  \n*\tyear: yyyy\n*\tyear-semester: yyyy-S1 - yyyy-S2\n*\tyear-quarter: yyyy-Q1 - yyyy-Q4  \n*\tyear-month: yyyy-01 - yyyy-12\n"
        required: false
        schema:
          type: string
      - name: endPeriod
        in: query
        description: "The end period (used to filter on time). This is inclusive. The value can be in the following formats:\n*\tyear: yyyy\n*\tyear-semester: yyyy-S1 - yyyy-S2  \n*\tyear-quarter: yyyy-Q1 - yyyy-Q4  \n*\tyear-month: yyyy-01 - yyyy-12\n"
        required: false
        schema:
          type: string
      - name: format
        in: query
        description: "The format of data to return. Refer to the accept header if omitted. \n\n*\t**csvwithlabels**: csv format with columns for dimension codes and labels.\n*\t**csvfile**: csv format with columns for dimension codes.\n*\t**jsondata**: sdmx json format equivalent to application/vnd.sdmx.data+json\n*\t**genericdata**: sdmx xml format equivalent to application/vnd.sdmx.genericdata+xml\n*\t**structurespecificdata**: sdmx xml format equivalent to application/vnd.sdmx.structurespecificdata+xml\n"
        required: false
        schema:
          type: string
          enum:
          - csvfilewithlabels
          - csvfile
          - jsondata
          - genericdata
          - structurespecificdata
      - name: detail
        in: query
        description: "The detail of data to return.\n\n*\t**full**: The data - series and observations - and the attributes will be returned. This is the default.\n*\t**dataonly**: The attributes will be excluded from the returned message.\n*\t**serieskeysonly**: Only the series, but without the attributes and the observations, will be returned. This can be useful for performance reasons, to return the series that match a certain query, without returning the actual data.\n*\t**nodata**: The series, including the attributes, will be returned, but the observations will not be returned.\n"
        required: false
        schema:
          type: string
          enum:
          - full
          - dataonly
          - serieskeysonly
          - nodata
      - name: dimensionAtObservation
        in: query
        description: 'Define the way data should be organized in the returned message. Possible options are:


          * **TIME_PERIOD**: This will return a timeseries view of the data. This is the default value.

          * **AllDimensions**: This will return a flat view of the data, with no groupings.

          * **The ID of any other dimension**: This will return a cross-sectional view of the data.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/vnd.sdmx.data+json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            application/vnd.sdmx.structurespecificdata+xml:
              schema:
                type: string
            text/csv:
              schema:
                type: string
            application/vnd.sdmx.data+csv:
              schema:
                type: string
            application/vnd.sdmx.data+csv;labels=both:
              schema:
                type: string
            application/vnd.sdmx.data+csv;file=true;labels=both:
              schema:
                type: string
        '404':
          description: No records found
          content:
            application/vnd.sdmx.data+json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            application/vnd.sdmx.structurespecificdata+xml:
              schema:
                type: string
            text/csv:
              schema:
                type: string
            application/vnd.sdmx.data+csv:
              schema:
                type: string
            application/vnd.sdmx.data+csv;labels=both:
              schema:
                type: string
            application/vnd.sdmx.data+csv;file=true;labels=both:
              schema:
                type: string
    servers:
    - url: https://data.api.abs.gov.au
  /v1/data/{dataflowIdentifier}/{format}:
    get:
      tags:
      - Get Data
      summary: Request data for specifed dataflow
      operationId: getUserByName
      parameters:
      - name: dataflowIdentifier
        in: path
        description: Identifier for dataflow to request data from.
        required: true
        schema:
          $ref: '#/components/schemas/dataflowId'
      - name: format
        in: path
        description: Format to return data in (json, csv, xml).
        required: true
        schema:
          $ref: '#/components/schemas/dataFormat'
      security:
      - x-api-key: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/file'
            application/xml:
              schema:
                $ref: '#/components/schemas/file'
            text/csv:
              schema:
                $ref: '#/components/schemas/file'
        '400':
          description: Invalid request or format.
        '403':
          description: Forbidden.
        '404':
          description: Not found. Dataflow identifier may be incorrect or not available.
        '429':
          description: Too many requests. You have exceeded the rate limit allowed for your API key. Please reduce your request rate.
    servers:
    - url: https://indicator.api.abs.gov.au
components:
  schemas:
    file:
      title: File
      type: string
      format: binary
    dataflowId:
      type: string
      enum:
      - AWE_H
      - BA_GCCSA_H
      - BOP_H
      - BUILDING_ACTIVITY_H
      - CAPEX_H
      - CAPEX_EST_H
      - CPI_H
      - CPI_Q_H
      - CWD_H
      - GDPE_H
      - HSI_M_H
      - ITGS_H
      - ITPI_EXP_H
      - ITPI_IMP_H
      - JV_H
      - LEND_H
      - LF_H
      - MBTI_H
      - PPI_FD_H
      - QBIS_H
      - RT_H
      - WPI_H
    dataFormat:
      type: string
      enum:
      - json
      - csv
      - xml
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
x-refined-from:
- DataAPI.openapi.yaml
- indicator.openapi.yaml