The Get Metadata API from Australian Bureau of Statistics — 4 operation(s) for get metadata.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/australian-bureau-of-statistics:australian-bureau-of-statistics-get-metadata-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Australian Bureau Of Statistics Get Metadata API
contact:
email: api.data@abs.gov.au
version: '1.0'
description: 'Operations tagged Get Metadata 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 Metadata
paths:
/rest/{structureType}/{agencyId}:
get:
tags:
- Get Metadata
summary: Get all structures of a specific type
operationId: GetStructuresByAgencyId
parameters:
- name: structureType
in: path
description: The type of structure to retrieve.
required: true
schema:
type: string
enum:
- dataflow
- datastructure
- codelist
- conceptscheme
- categoryscheme
- contentconstraint
- actualconstraint
- agencyscheme
- categorisation
- hierarchicalcodelist
- name: agencyId
in: path
description: The id of the agency maintaining the structures. Eg. "ABS".
required: true
schema:
type: string
default: ABS
- name: detail
in: query
description: 'Specify the desired amount of detail to be returned. For example, it is possible to instruct the web service to return only basic information about the resource, this is known in SDMX as a stub.
* **allstubs**: All artefacts will be returned as stubs.
* **referencestubs**: The referenced artefacts will be returned as stubs.
* **referencepartial**: The referenced item schemes should only include items used by the artefact to be returned. For example, a concept scheme would only contain the concepts used in a DSD, and its isPartial flag would be set to true. As another example, if a dataflow is constrained, then the codelists returned should only contain the subset of codes allowed by that constraint.
* **allcompletestubs**: All artefacts should be returned as complete stubs, containing identification information, the artefacts'' name, description, annotations and isFinal information.
* **referencecompletestubs**: The referenced artefacts should be returned as complete stubs, containing identification information, the artefacts'' name, description, annotations and isFinal information.
* **full**: All available information for all artefacts will be returned. This is the default.
'
required: false
schema:
type: string
enum:
- full
- allstubs
- referencestubs
- referencepartial
- allcompletestubs
- referencecompletestubs
responses:
'200':
description: Success
content:
application/xml:
schema:
type: string
application/vnd.sdmx.structure+json:
schema:
type: string
servers:
- url: https://data.api.abs.gov.au
/rest/{structureType}/{agencyId}/{structureId}:
get:
tags:
- Get Metadata
summary: Get the latest structure of a specific type, for a given agency and structure id
operationId: GetLatestStructure
parameters:
- name: structureType
in: path
description: The type of structure to retrieve.
required: true
schema:
type: string
enum:
- dataflow
- datastructure
- codelist
- conceptscheme
- categoryscheme
- contentconstraint
- actualconstraint
- agencyscheme
- categorisation
- hierarchicalcodelist
- name: agencyId
in: path
description: The id of the agency maintaining the structures. Eg. "ABS".
required: true
schema:
type: string
default: ABS
- name: structureId
in: path
description: The structure's id. "all" will return all artefacts of the selected structure type.
required: true
schema:
type: string
- name: references
in: query
description: "Instruct the web service to return (or not) the artefacts referenced by the artefact(s) you are querying. Eg. the codelists and concepts used by the data structure you are querying. You can also retrieve the artefacts that use the artefact you are querying, eg. the dataflows that use the data structure definition queried.\n\n*\t**none**: No references will be returned. This is the default.\n*\t**parents**: The artefacts that use the artefact matching the query (for example, the dataflows that use the data structure definition matching the query) will be returned.\n*\t**parentsandsiblings**: The artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts will be returned.\n*\t**children**: The artefacts referenced by the matching artefact will be returned (for example, the concept schemes and code lists used in a DSD).\n*\t**descendants**: References of references, up to any level, will also be returned.\n*\t**all**: The combination of parentsandsiblings and descendants.\n*\tIn addition, a specific structure type may also be used (e.g. codelist, dataflow, etc.).\n"
required: false
schema:
type: string
enum:
- none
- parents
- parentsandsiblings
- children
- descendants
- all
- datastructure
- dataflow
- codelist
- conceptscheme
- categoryscheme
- contentconstraint
- actualconstraint
- agencyscheme
- categorisation
- hierarchicalcodelist
- name: detail
in: query
description: 'Specify the desired amount of detail to be returned. For example, it is possible to instruct the web service to return only basic information about the resource, this is known in SDMX as a stub.
* **allstubs**: All artefacts will be returned as stubs.
* **referencestubs**: The referenced artefacts will be returned as stubs.
* **referencepartial**: The referenced item schemes should only include items used by the artefact to be returned. For example, a concept scheme would only contain the concepts used in a DSD, and its isPartial flag would be set to true. As another example, if a dataflow is constrained, then the codelists returned should only contain the subset of codes allowed by that constraint.
* **allcompletestubs**: All artefacts should be returned as complete stubs, containing identification information, the artefacts'' name, description, annotations and isFinal information.
* **referencecompletestubs**: The referenced artefacts should be returned as complete stubs, containing identification information, the artefacts'' name, description, annotations and isFinal information.
* **full**: All available information for all artefacts will be returned. This is the default.
'
required: false
schema:
type: string
enum:
- full
- allstubs
- referencestubs
- referencepartial
- allcompletestubs
- referencecompletestubs
responses:
'200':
description: Success
content:
application/xml:
schema:
type: string
application/vnd.sdmx.structure+json:
schema:
type: string
servers:
- url: https://data.api.abs.gov.au
/rest/{structureType}/{agencyId}/{structureId}/{structureVersion}:
get:
tags:
- Get Metadata
summary: Get a specific version of a structure of a specific type, for a given agency…
operationId: GetStructures
parameters:
- name: structureType
in: path
description: The type of structure to retrieve.
required: true
schema:
type: string
enum:
- dataflow
- datastructure
- codelist
- conceptscheme
- categoryscheme
- contentconstraint
- actualconstraint
- agencyscheme
- categorisation
- hierarchicalcodelist
- name: agencyId
in: path
description: The id of the agency maintaining the structures. Eg. "ABS".
required: true
schema:
type: string
default: ABS
- name: structureId
in: path
description: The structure's id. "all" will return all artefacts of the selected structure type.
required: true
schema:
type: string
- name: structureVersion
in: path
description: The version of the structure to retrieve. Three numbers separated by points, eg. "1.0.0".
required: true
schema:
type: string
- name: references
in: query
description: "Instruct the web service to return (or not) the artefacts referenced by the artefact(s) you are querying. Eg. the codelists and concepts used by the data structure you are querying. You can also retrieve the artefacts that use the artefact you are querying, eg. the dataflows that use the data structure definition queried.\n\n*\t**none**: No references will be returned. This is the default.\n*\t**parents**: The artefacts that use the artefact matching the query (for example, the dataflows that use the data structure definition matching the query) will be returned.\n*\t**parentsandsiblings**: The artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts will be returned.\n*\t**children**: The artefacts referenced by the matching artefact will be returned (for example, the concept schemes and code lists used in a DSD).\n*\t**descendants**: References of references, up to any level, will also be returned.\n*\t**all**: The combination of parentsandsiblings and descendants.\n*\tIn addition, a specific structure type may also be used (e.g. codelist, dataflow, etc.).\n"
required: false
schema:
type: string
enum:
- none
- parents
- parentsandsiblings
- children
- descendants
- all
- datastructure
- dataflow
- codelist
- conceptscheme
- categoryscheme
- contentconstraint
- actualconstraint
- agencyscheme
- categorisation
- hierarchicalcodelist
- name: detail
in: query
description: 'Specify the desired amount of detail to be returned. For example, it is possible to instruct the web service to return only basic information about the resource, this is known in SDMX as a stub.
* **allstubs**: All artefacts will be returned as stubs.
* **referencestubs**: The referenced artefacts will be returned as stubs.
* **referencepartial**: The referenced item schemes should only include items used by the artefact to be returned. For example, a concept scheme would only contain the concepts used in a DSD, and its isPartial flag would be set to true. As another example, if a dataflow is constrained, then the codelists returned should only contain the subset of codes allowed by that constraint.
* **allcompletestubs**: All artefacts should be returned as complete stubs, containing identification information, the artefacts'' name, description, annotations and isFinal information.
* **referencecompletestubs**: The referenced artefacts should be returned as complete stubs, containing identification information, the artefacts'' name, description, annotations and isFinal information.
* **full**: All available information for all artefacts will be returned. This is the default.
'
required: false
schema:
type: string
enum:
- full
- allstubs
- referencestubs
- referencepartial
- allcompletestubs
- referencecompletestubs
responses:
'200':
description: Success
content:
application/xml:
schema:
type: string
application/vnd.sdmx.structure+json:
schema:
type: string
servers:
- url: https://data.api.abs.gov.au
/v1/metadata/{dataflowIdentifier}/{format}:
get:
tags:
- Get Metadata
summary: Request metadata for specifed dataflow
parameters:
- name: dataflowIdentifier
in: path
description: Identifier for dataflow to request metadata from.
required: true
schema:
$ref: '#/components/schemas/dataflowId'
- name: format
in: path
description: Format to return metadata in (json, xml).
required: true
schema:
$ref: '#/components/schemas/metadataFormat'
security:
- x-api-key: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/file'
application/xml:
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.
operationId: getV1MetadataByDataflowIdentifierByFormat
x-operation-id-source: derived
servers:
- url: https://indicator.api.abs.gov.au
components:
schemas:
metadataFormat:
type: string
enum:
- json
- xml
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
file:
title: File
type: string
format: binary
securitySchemes:
x-api-key:
type: apiKey
in: header
name: x-api-key
x-refined-from:
- DataAPI.openapi.yaml
- indicator.openapi.yaml