{ "openapi": "3.1.0", "info": { "title": "Monthly restrictions on diversions from unregulated streams, Victoria query API", "version": "2025-10-30", "summary": "Filter, page and aggregate Monthly restrictions on diversions from unregulated streams, Victoria from Department of Energy, Environment and Climate Action.", "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. Department of Energy, Environment and Climate Action 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-stream-restrictions/#query" }, "tags": [ { "name": "query" } ], "paths": { "/api/v1/datasets/vic-stream-restrictions/rows": { "get": { "tags": [ "query" ], "summary": "Query Monthly restrictions on diversions from unregulated streams, Victoria", "operationId": "queryRows_vic_stream_restrictions", "description": "Rows of Monthly restrictions on diversions from unregulated streams, Victoria 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 that `like` and `ilike` ignore case in the ASCII letters A to Z. 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": "stream", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "month_end", "in": "query", "schema": { "type": "string" }, "description": "date. The date the status was recorded, the last day of the month or close to it. From 2010-01-31 to 2025-09-22." }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BAN, Ban, Level 1, No Restriction, No restriction, Restricted, Stage 1, Stage 2, Stage 3, Stage 3 Roster, Stage 4, Stage 5, Stage 6, Stage 7, Stage 8, Stage 9.", "examples": [ "eq.Stage 9" ] }, { "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. When absent, rows come in the order of the file they are read from. For the newest versions that is the version's own data.parquet, which keeps the publisher's order unless the dataset sorted it. Any other version is read from the Parquet file the answer names in `file`, and when that file is sorted the answer names its sort in `order`, which ties follow too." }, { "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. An answer read or counted from a Parquet file names it in `file`, or its period parts in `parts`, and a sorted file's sort in `order`." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset does not exist here, or the version has no table to query." }, "422": { "description": "The query would read more of the version's file than one answer may, or the file cannot be read in part. The error gives DuckDB SQL that answers it from the published file." }, "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-stream-restrictions/versions/{version}/rows": { "get": { "tags": [ "query" ], "summary": "Query Monthly restrictions on diversions from unregulated streams, Victoria", "operationId": "queryRows_vic_stream_restrictions_version", "description": "Rows of Monthly restrictions on diversions from unregulated streams, Victoria 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 that `like` and `ilike` ignore case in the ASCII letters A to Z. 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, from the versions path. A dated version's answers stay the same unless a correction rebuilds the version, which its notes record." }, { "name": "stream", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "month_end", "in": "query", "schema": { "type": "string" }, "description": "date. The date the status was recorded, the last day of the month or close to it. From 2010-01-31 to 2025-09-22." }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BAN, Ban, Level 1, No Restriction, No restriction, Restricted, Stage 1, Stage 2, Stage 3, Stage 3 Roster, Stage 4, Stage 5, Stage 6, Stage 7, Stage 8, Stage 9.", "examples": [ "eq.Stage 9" ] }, { "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. When absent, rows come in the order of the file they are read from. For the newest versions that is the version's own data.parquet, which keeps the publisher's order unless the dataset sorted it. Any other version is read from the Parquet file the answer names in `file`, and when that file is sorted the answer names its sort in `order`, which ties follow too." }, { "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. An answer read or counted from a Parquet file names it in `file`, or its period parts in `parts`, and a sorted file's sort in `order`." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset does not exist here, or the version has no table to query." }, "422": { "description": "The query would read more of the version's file than one answer may, or the file cannot be read in part. The error gives DuckDB SQL that answers it from the published file." }, "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 that `like` and `ilike` ignore case in the ASCII letters A to Z. 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-stream-restrictions" ] }, "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": "stream", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "month_end", "in": "query", "schema": { "type": "string" }, "description": "date. The date the status was recorded, the last day of the month or close to it. From 2010-01-31 to 2025-09-22." }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BAN, Ban, Level 1, No Restriction, No restriction, Restricted, Stage 1, Stage 2, Stage 3, Stage 3 Roster, Stage 4, Stage 5, Stage 6, Stage 7, Stage 8, Stage 9.", "examples": [ "eq.Stage 9" ] }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. When absent, rows come in the order of the file they are read from. For the newest versions that is the version's own data.parquet, which keeps the publisher's order unless the dataset sorted it. Any other version is read from the Parquet file the answer names in `file`, and when that file is sorted the answer names its sort in `order`, which ties follow too." }, { "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. An answer read or counted from a Parquet file names it in `file`, or its period parts in `parts`, and a sorted file's sort in `order`." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset does not exist here, or the version has no table to query." }, "422": { "description": "The query would read more of the version's file than one answer may, or the file cannot be read in part. The error gives DuckDB SQL that answers it from the published file." }, "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 that `like` and `ilike` ignore case in the ASCII letters A to Z. 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-stream-restrictions" ] }, "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, from the versions path. A dated version's answers stay the same unless a correction rebuilds the version, which its notes record." }, { "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": "stream", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "month_end", "in": "query", "schema": { "type": "string" }, "description": "date. The date the status was recorded, the last day of the month or close to it. From 2010-01-31 to 2025-09-22." }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: BAN, Ban, Level 1, No Restriction, No restriction, Restricted, Stage 1, Stage 2, Stage 3, Stage 3 Roster, Stage 4, Stage 5, Stage 6, Stage 7, Stage 8, Stage 9.", "examples": [ "eq.Stage 9" ] }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. When absent, rows come in the order of the file they are read from. For the newest versions that is the version's own data.parquet, which keeps the publisher's order unless the dataset sorted it. Any other version is read from the Parquet file the answer names in `file`, and when that file is sorted the answer names its sort in `order`, which ties follow too." }, { "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. An answer read or counted from a Parquet file names it in `file`, or its period parts in `parts`, and a sorted file's sort in `order`." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset does not exist here, or the version has no table to query." }, "422": { "description": "The query would read more of the version's file than one answer may, or the file cannot be read in part. The error gives DuckDB SQL that answers it from the published file." }, "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 of a dataset with a table to query, newest first, with the URLs to query each", "operationId": "queryVersions", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "vic-stream-restrictions" ] }, "description": "The dataset's slug, as in its page URL `/d//`." } ], "responses": { "200": { "description": "Versions with row counts and URLs." }, "404": { "description": "The dataset does not exist here, or the version has no table to query." }, "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" } } } } } } } } } } }