SDMX-JSON Query Structure
The API uses the standard SDMX REST API for queries. To create an SDMX-JSON query, a dataset identifier, a list of dimension item identifiers and some additional parameters must be supplied in a URL in the following format:
stat.data.abs.gov.au/SDMX-JSON/data/<dataset identifier>/<filter expression>/<agency name>?<additional parameter>&<additional parameter>
| Parameters | Use | Example |
| dataset identifier | The identifier or code of the dataset to be queried | CPI |
| filter expression | Using their identifiers, the list of desired dimension values to be included in the result. To get all available dimension values, use the “all” keyword. Dimensions should be separated by a dot (“.”) and for each dimension its values should be separated by the plus sign (“+”). If for a particular dimension, no dimension value identifiers are specified, then all available values of this dimension will be returned. To get the list of dimensions and dimension values, use:
stat.data.abs.gov.au/restsdmx/sdmx.ashx/GetDataStructure/<dataset identifier> | 2.50.10001+999901.10+20.Q |
| agency name | The agency maintaining the artefact to be returned (“all” returns artefacts maintained by any maintenance agency). | ABS |
| Additional Parameters | Use | Example |
| startTime | The start period for which results should be supplied (inclusive). If not specified, data returned from the beginning. The value can be in the following formats:
- year
- year-semester: <year>-S1 – <year>-S2
- year-quarter: <year>-Q1 – <year>-Q4
- year-month: <year>-M1 – <year>-M12
| startTime=2015-Q3 |
| endTime | The end period for which results should be supplied (inclusive). If not specified, data is returned until the latest available date.
If specifying both a start and end time, ensure they are separated by an ampersand "&" | endTime=2016-Q2 |
| dimensionAtObservation | The identifier of the dimension to be attached at the observation level, or “AllDimensions”. If this parameter is not set, then the default value order is:
- TimeDimension
- MeasureDimension
- AllDimensions, if none of the above
AllDimensions results in a flat list of observations without any grouping. | dimensionAtObservation=MeasureDimension |
| detail | This attribute specifies the desired amount of information to be returned. Possible values:
- Full: all data and documentation, including annotations (default)
- DataOnly: attributes – and therefore groups – will be excluded
- SeriesKeysOnly: only the series elements and the dimensions that make up the series keys
- NoData: returns the groups and series, including attributes and annotations, without observations
| detail=DataOnly |
Print Page
Print All
Follow us on...