{ "openapi": "3.1.0", "info": { "title": "Air quality hourly averages at every EPA monitoring station, Victoria, latest year query API", "version": "2026-10-03", "summary": "Filter, page and aggregate Air quality hourly averages at every EPA monitoring station, Victoria, latest year from Environment Protection Authority Victoria.", "description": "The query API returns only the rows you ask for, as JSON, NDJSON or CSV, from the same typed rows as the files. It needs no key. The API allows 60 requests in 10 seconds from one address. Above that it answers 429 for 10 seconds with a `Retry-After` header, a `RateLimit-Policy` header and a JSON body that gives the limit. Every API answer carries the same `RateLimit-Policy`. A client should wait the `Retry-After` seconds, or read the files, which have no limit. Every JSON answer carries the version, licence and attribution. CSV and NDJSON answers carry them in response headers. Environment Protection Authority Victoria has not endorsed this site. The whole site is described in https://publicdata.au/openapi.json.", "license": { "name": "CC BY 4.0", "url": "https://creativecommons.org/licenses/by/4.0/" } }, "servers": [ { "url": "https://publicdata.au" } ], "externalDocs": { "url": "https://publicdata.au/d/vic-air-quality-hourly/#query" }, "tags": [ { "name": "query" } ], "paths": { "/api/v1/datasets/vic-air-quality-hourly/rows": { "get": { "tags": [ "query" ], "summary": "Query Air quality hourly averages at every EPA monitoring station, Victoria, latest year", "operationId": "queryRows_vic_air_quality_hourly", "description": "Rows of Air quality hourly averages at every EPA monitoring station, Victoria, latest year in the newest loaded version, filtered and paged. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "datetime_aest", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2025-01-01T00:00:00 to 2026-01-01T22:00:00." }, { "name": "datetime_local", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2025-01-01T01:00:00 to 2026-01-01T23:00:00." }, { "name": "date_hour_start_utc_id", "in": "query", "schema": { "type": "string" }, "description": "integer. The UTC hour as YYYYMMDDHH, the publisher's identifier for the hour. From 2024123114 to 2026010112." }, { "name": "sample_point_id", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 1111, 1112, 10001, 10005, 10006, 10007, 10011, 10017, 10022, 10042, 10107, 10136, 10169, 10217, 10239, 10377.", "examples": [ "eq.10377" ] }, { "name": "location_id", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 714, 720, 727, 743, 751, 802, 826, 849, 869, 875, 907, 929, 941, 949, 1112, 1115.", "examples": [ "eq.1115" ] }, { "name": "location_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Alphington, Altona North, Box Hill, Brighton, Brooklyn, Dandenong, Footscray, Geelong South, Macleod, Melbourne CBD, Melton, Mooroolbark, Morwell East, Morwell South, Point Cook, Traralgon.", "examples": [ "eq.Traralgon" ] }, { "name": "latitude", "in": "query", "schema": { "type": "string" }, "description": "number. Values: -38.2392921, -38.229393, -38.1942825, -38.17356, -37.98576, -37.9263153, -37.9135475, -37.84455, -37.8287277, -37.8220978, -37.8073959, -37.80266, -37.7784081, -37.7749672, -37.722477, -37.7064552.", "examples": [ "eq.-37.7064552" ] }, { "name": "longitude", "in": "query", "schema": { "type": "string" }, "description": "number. Values: 144.3703, 144.5669, 144.7567, 144.8471, 144.8629, 144.8778, 144.97, 144.998, 145.0306, 145.0576, 145.1324, 145.1987, 145.3285, 146.3873, 146.424454, 146.531464.", "examples": [ "eq.146.531464" ] }, { "name": "value", "in": "query", "schema": { "type": "string" }, "description": "number. The hourly average in the unit given in unit_of_measure. From -25.323 to 815.464." }, { "name": "validation_flag", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Y.", "examples": [ "eq.Y" ] }, { "name": "parameter_name", "in": "query", "schema": { "type": "string" }, "description": "string. A short code such as PM2.5, O3, NO2 or DBT. Values: BSP, CO, DBT, NO, NO2, NOX, O3, PM10, PM2.5, SIG60, SO2, SWD, SWS, VWD, VWS.", "examples": [ "eq.VWS" ] }, { "name": "parameter_method_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BSP, CO, DBT, NO, NO2, NOX, O3, PM10, SBPM25, SO2, SWD, SWS, Sigma60, VWD, VWS.", "examples": [ "eq.VWS" ] }, { "name": "parameter_description", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Carbon Monoxide, Dry Bulb Temperature, Nitrogen Dioxide, Oxides of Nitrogen, Ozone, Particulate Matter of 10 microns or less, Particulate Matter of 2.5 microns or less, Scalar Wind Direction, Scalar Wind Speed, Scattering coefficent of light due to particles, Sigma Theta over an hour, Sulphur Dioxide, Vector Wind Direction, Vector Wind Speed.", "examples": [ "eq.Vector Wind Speed" ] }, { "name": "analysis_method_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BAM corrected to standard temperature and pressure, Direct reading - Chemilluminescence, Direct reading - Infrared, Direct reading - UV Fluorescence, Direct reading - UV Photometer, Dry Bulb Temperature, Light scattering method - Nephelometer, Tapered element oscillating microbalance, Ultrasonic anemometer, Ultrasound anemometer.", "examples": [ "eq.Ultrasound anemometer" ] }, { "name": "unit_of_measure", "in": "query", "schema": { "type": "string" }, "description": "string. Values: 1/Mm, deg, deg.C, m/s, ppb, ppm, ug/m3.", "examples": [ "eq.ug/m3" ] }, { "name": "method_quality", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Equivalence Method.", "examples": [ "eq.Equivalence Method" ] }, { "name": "datetime_utc", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2024-12-31T14:00:00 to 2026-01-01T12:00:00." }, { "name": "select", "in": "query", "schema": { "type": "string" }, "description": "Fields to return, comma-separated. Every field when absent." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/vic-air-quality-hourly/versions/{version}/rows": { "get": { "tags": [ "query" ], "summary": "Query Air quality hourly averages at every EPA monitoring station, Victoria, latest year", "operationId": "queryRows_vic_air_quality_hourly_version", "description": "Rows of Air quality hourly averages at every EPA monitoring station, Victoria, latest year in one dated version, filtered and paged. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "A dated version loaded for queries, from the versions path. Answers for a dated version never change." }, { "name": "datetime_aest", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2025-01-01T00:00:00 to 2026-01-01T22:00:00." }, { "name": "datetime_local", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2025-01-01T01:00:00 to 2026-01-01T23:00:00." }, { "name": "date_hour_start_utc_id", "in": "query", "schema": { "type": "string" }, "description": "integer. The UTC hour as YYYYMMDDHH, the publisher's identifier for the hour. From 2024123114 to 2026010112." }, { "name": "sample_point_id", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 1111, 1112, 10001, 10005, 10006, 10007, 10011, 10017, 10022, 10042, 10107, 10136, 10169, 10217, 10239, 10377.", "examples": [ "eq.10377" ] }, { "name": "location_id", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 714, 720, 727, 743, 751, 802, 826, 849, 869, 875, 907, 929, 941, 949, 1112, 1115.", "examples": [ "eq.1115" ] }, { "name": "location_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Alphington, Altona North, Box Hill, Brighton, Brooklyn, Dandenong, Footscray, Geelong South, Macleod, Melbourne CBD, Melton, Mooroolbark, Morwell East, Morwell South, Point Cook, Traralgon.", "examples": [ "eq.Traralgon" ] }, { "name": "latitude", "in": "query", "schema": { "type": "string" }, "description": "number. Values: -38.2392921, -38.229393, -38.1942825, -38.17356, -37.98576, -37.9263153, -37.9135475, -37.84455, -37.8287277, -37.8220978, -37.8073959, -37.80266, -37.7784081, -37.7749672, -37.722477, -37.7064552.", "examples": [ "eq.-37.7064552" ] }, { "name": "longitude", "in": "query", "schema": { "type": "string" }, "description": "number. Values: 144.3703, 144.5669, 144.7567, 144.8471, 144.8629, 144.8778, 144.97, 144.998, 145.0306, 145.0576, 145.1324, 145.1987, 145.3285, 146.3873, 146.424454, 146.531464.", "examples": [ "eq.146.531464" ] }, { "name": "value", "in": "query", "schema": { "type": "string" }, "description": "number. The hourly average in the unit given in unit_of_measure. From -25.323 to 815.464." }, { "name": "validation_flag", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Y.", "examples": [ "eq.Y" ] }, { "name": "parameter_name", "in": "query", "schema": { "type": "string" }, "description": "string. A short code such as PM2.5, O3, NO2 or DBT. Values: BSP, CO, DBT, NO, NO2, NOX, O3, PM10, PM2.5, SIG60, SO2, SWD, SWS, VWD, VWS.", "examples": [ "eq.VWS" ] }, { "name": "parameter_method_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BSP, CO, DBT, NO, NO2, NOX, O3, PM10, SBPM25, SO2, SWD, SWS, Sigma60, VWD, VWS.", "examples": [ "eq.VWS" ] }, { "name": "parameter_description", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Carbon Monoxide, Dry Bulb Temperature, Nitrogen Dioxide, Oxides of Nitrogen, Ozone, Particulate Matter of 10 microns or less, Particulate Matter of 2.5 microns or less, Scalar Wind Direction, Scalar Wind Speed, Scattering coefficent of light due to particles, Sigma Theta over an hour, Sulphur Dioxide, Vector Wind Direction, Vector Wind Speed.", "examples": [ "eq.Vector Wind Speed" ] }, { "name": "analysis_method_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BAM corrected to standard temperature and pressure, Direct reading - Chemilluminescence, Direct reading - Infrared, Direct reading - UV Fluorescence, Direct reading - UV Photometer, Dry Bulb Temperature, Light scattering method - Nephelometer, Tapered element oscillating microbalance, Ultrasonic anemometer, Ultrasound anemometer.", "examples": [ "eq.Ultrasound anemometer" ] }, { "name": "unit_of_measure", "in": "query", "schema": { "type": "string" }, "description": "string. Values: 1/Mm, deg, deg.C, m/s, ppb, ppm, ug/m3.", "examples": [ "eq.ug/m3" ] }, { "name": "method_quality", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Equivalence Method.", "examples": [ "eq.Equivalence Method" ] }, { "name": "datetime_utc", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2024-12-31T14:00:00 to 2026-01-01T12:00:00." }, { "name": "select", "in": "query", "schema": { "type": "string" }, "description": "Fields to return, comma-separated. Every field when absent." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/aggregate": { "get": { "tags": [ "query" ], "summary": "Counts, sums, averages, minimums and maximums by group", "operationId": "aggregate", "description": "Groups and totals of any dataset in the newest loaded version. Filters work as they do on rows. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "vic-air-quality-hourly" ] }, "description": "The dataset's slug, as in its page URL `/d//`." }, { "name": "group", "in": "query", "schema": { "type": "string" }, "description": "On `aggregate`, fields to group by, comma-separated." }, { "name": "metric", "in": "query", "schema": { "type": "string", "default": "count" }, "description": "On `aggregate`, `count`, `sum.field`, `avg.field`, `min.field` or `max.field`, comma-separated. `count` when absent." }, { "name": "datetime_aest", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2025-01-01T00:00:00 to 2026-01-01T22:00:00." }, { "name": "datetime_local", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2025-01-01T01:00:00 to 2026-01-01T23:00:00." }, { "name": "date_hour_start_utc_id", "in": "query", "schema": { "type": "string" }, "description": "integer. The UTC hour as YYYYMMDDHH, the publisher's identifier for the hour. From 2024123114 to 2026010112." }, { "name": "sample_point_id", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 1111, 1112, 10001, 10005, 10006, 10007, 10011, 10017, 10022, 10042, 10107, 10136, 10169, 10217, 10239, 10377.", "examples": [ "eq.10377" ] }, { "name": "location_id", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 714, 720, 727, 743, 751, 802, 826, 849, 869, 875, 907, 929, 941, 949, 1112, 1115.", "examples": [ "eq.1115" ] }, { "name": "location_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Alphington, Altona North, Box Hill, Brighton, Brooklyn, Dandenong, Footscray, Geelong South, Macleod, Melbourne CBD, Melton, Mooroolbark, Morwell East, Morwell South, Point Cook, Traralgon.", "examples": [ "eq.Traralgon" ] }, { "name": "latitude", "in": "query", "schema": { "type": "string" }, "description": "number. Values: -38.2392921, -38.229393, -38.1942825, -38.17356, -37.98576, -37.9263153, -37.9135475, -37.84455, -37.8287277, -37.8220978, -37.8073959, -37.80266, -37.7784081, -37.7749672, -37.722477, -37.7064552.", "examples": [ "eq.-37.7064552" ] }, { "name": "longitude", "in": "query", "schema": { "type": "string" }, "description": "number. Values: 144.3703, 144.5669, 144.7567, 144.8471, 144.8629, 144.8778, 144.97, 144.998, 145.0306, 145.0576, 145.1324, 145.1987, 145.3285, 146.3873, 146.424454, 146.531464.", "examples": [ "eq.146.531464" ] }, { "name": "value", "in": "query", "schema": { "type": "string" }, "description": "number. The hourly average in the unit given in unit_of_measure. From -25.323 to 815.464." }, { "name": "validation_flag", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Y.", "examples": [ "eq.Y" ] }, { "name": "parameter_name", "in": "query", "schema": { "type": "string" }, "description": "string. A short code such as PM2.5, O3, NO2 or DBT. Values: BSP, CO, DBT, NO, NO2, NOX, O3, PM10, PM2.5, SIG60, SO2, SWD, SWS, VWD, VWS.", "examples": [ "eq.VWS" ] }, { "name": "parameter_method_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BSP, CO, DBT, NO, NO2, NOX, O3, PM10, SBPM25, SO2, SWD, SWS, Sigma60, VWD, VWS.", "examples": [ "eq.VWS" ] }, { "name": "parameter_description", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Carbon Monoxide, Dry Bulb Temperature, Nitrogen Dioxide, Oxides of Nitrogen, Ozone, Particulate Matter of 10 microns or less, Particulate Matter of 2.5 microns or less, Scalar Wind Direction, Scalar Wind Speed, Scattering coefficent of light due to particles, Sigma Theta over an hour, Sulphur Dioxide, Vector Wind Direction, Vector Wind Speed.", "examples": [ "eq.Vector Wind Speed" ] }, { "name": "analysis_method_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BAM corrected to standard temperature and pressure, Direct reading - Chemilluminescence, Direct reading - Infrared, Direct reading - UV Fluorescence, Direct reading - UV Photometer, Dry Bulb Temperature, Light scattering method - Nephelometer, Tapered element oscillating microbalance, Ultrasonic anemometer, Ultrasound anemometer.", "examples": [ "eq.Ultrasound anemometer" ] }, { "name": "unit_of_measure", "in": "query", "schema": { "type": "string" }, "description": "string. Values: 1/Mm, deg, deg.C, m/s, ppb, ppm, ug/m3.", "examples": [ "eq.ug/m3" ] }, { "name": "method_quality", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Equivalence Method.", "examples": [ "eq.Equivalence Method" ] }, { "name": "datetime_utc", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2024-12-31T14:00:00 to 2026-01-01T12:00:00." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/versions/{version}/aggregate": { "get": { "tags": [ "query" ], "summary": "Counts, sums, averages, minimums and maximums by group", "operationId": "aggregateVersion", "description": "Groups and totals of any dataset in one dated version. Filters work as they do on rows. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "vic-air-quality-hourly" ] }, "description": "The dataset's slug, as in its page URL `/d//`." }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "A dated version loaded for queries, from the versions path. Answers for a dated version never change." }, { "name": "group", "in": "query", "schema": { "type": "string" }, "description": "On `aggregate`, fields to group by, comma-separated." }, { "name": "metric", "in": "query", "schema": { "type": "string", "default": "count" }, "description": "On `aggregate`, `count`, `sum.field`, `avg.field`, `min.field` or `max.field`, comma-separated. `count` when absent." }, { "name": "datetime_aest", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2025-01-01T00:00:00 to 2026-01-01T22:00:00." }, { "name": "datetime_local", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2025-01-01T01:00:00 to 2026-01-01T23:00:00." }, { "name": "date_hour_start_utc_id", "in": "query", "schema": { "type": "string" }, "description": "integer. The UTC hour as YYYYMMDDHH, the publisher's identifier for the hour. From 2024123114 to 2026010112." }, { "name": "sample_point_id", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 1111, 1112, 10001, 10005, 10006, 10007, 10011, 10017, 10022, 10042, 10107, 10136, 10169, 10217, 10239, 10377.", "examples": [ "eq.10377" ] }, { "name": "location_id", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 714, 720, 727, 743, 751, 802, 826, 849, 869, 875, 907, 929, 941, 949, 1112, 1115.", "examples": [ "eq.1115" ] }, { "name": "location_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Alphington, Altona North, Box Hill, Brighton, Brooklyn, Dandenong, Footscray, Geelong South, Macleod, Melbourne CBD, Melton, Mooroolbark, Morwell East, Morwell South, Point Cook, Traralgon.", "examples": [ "eq.Traralgon" ] }, { "name": "latitude", "in": "query", "schema": { "type": "string" }, "description": "number. Values: -38.2392921, -38.229393, -38.1942825, -38.17356, -37.98576, -37.9263153, -37.9135475, -37.84455, -37.8287277, -37.8220978, -37.8073959, -37.80266, -37.7784081, -37.7749672, -37.722477, -37.7064552.", "examples": [ "eq.-37.7064552" ] }, { "name": "longitude", "in": "query", "schema": { "type": "string" }, "description": "number. Values: 144.3703, 144.5669, 144.7567, 144.8471, 144.8629, 144.8778, 144.97, 144.998, 145.0306, 145.0576, 145.1324, 145.1987, 145.3285, 146.3873, 146.424454, 146.531464.", "examples": [ "eq.146.531464" ] }, { "name": "value", "in": "query", "schema": { "type": "string" }, "description": "number. The hourly average in the unit given in unit_of_measure. From -25.323 to 815.464." }, { "name": "validation_flag", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Y.", "examples": [ "eq.Y" ] }, { "name": "parameter_name", "in": "query", "schema": { "type": "string" }, "description": "string. A short code such as PM2.5, O3, NO2 or DBT. Values: BSP, CO, DBT, NO, NO2, NOX, O3, PM10, PM2.5, SIG60, SO2, SWD, SWS, VWD, VWS.", "examples": [ "eq.VWS" ] }, { "name": "parameter_method_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BSP, CO, DBT, NO, NO2, NOX, O3, PM10, SBPM25, SO2, SWD, SWS, Sigma60, VWD, VWS.", "examples": [ "eq.VWS" ] }, { "name": "parameter_description", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Carbon Monoxide, Dry Bulb Temperature, Nitrogen Dioxide, Oxides of Nitrogen, Ozone, Particulate Matter of 10 microns or less, Particulate Matter of 2.5 microns or less, Scalar Wind Direction, Scalar Wind Speed, Scattering coefficent of light due to particles, Sigma Theta over an hour, Sulphur Dioxide, Vector Wind Direction, Vector Wind Speed.", "examples": [ "eq.Vector Wind Speed" ] }, { "name": "analysis_method_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BAM corrected to standard temperature and pressure, Direct reading - Chemilluminescence, Direct reading - Infrared, Direct reading - UV Fluorescence, Direct reading - UV Photometer, Dry Bulb Temperature, Light scattering method - Nephelometer, Tapered element oscillating microbalance, Ultrasonic anemometer, Ultrasound anemometer.", "examples": [ "eq.Ultrasound anemometer" ] }, { "name": "unit_of_measure", "in": "query", "schema": { "type": "string" }, "description": "string. Values: 1/Mm, deg, deg.C, m/s, ppb, ppm, ug/m3.", "examples": [ "eq.ug/m3" ] }, { "name": "method_quality", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Equivalence Method.", "examples": [ "eq.Equivalence Method" ] }, { "name": "datetime_utc", "in": "query", "schema": { "type": "string" }, "description": "datetime. From 2024-12-31T14:00:00 to 2026-01-01T12:00:00." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/versions": { "get": { "tags": [ "query" ], "summary": "The versions loaded for queries, newest first, with the URLs to query each", "operationId": "queryVersions", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "vic-air-quality-hourly" ] }, "description": "The dataset's slug, as in its page URL `/d//`." } ], "responses": { "200": { "description": "Loaded versions with row counts and URLs." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } } } }