{ "openapi": "3.1.0", "info": { "title": "Urban public housing wait times, wait list and allocations, Northern Territory, 2018 to 2020 query API", "version": "2021-03-31", "summary": "Filter, page and aggregate Urban public housing wait times, wait list and allocations, Northern Territory, 2018 to 2020 from Department of Housing, Local Government and Community Development.", "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 Housing, Local Government and Community Development 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/nt-urban-public-housing-wait-list/#query" }, "tags": [ { "name": "query" } ], "paths": { "/api/v1/datasets/nt-urban-public-housing-wait-list/rows": { "get": { "tags": [ "query" ], "summary": "Query Urban public housing wait times, wait list and allocations, Northern Territory, 2018 to 2020", "operationId": "queryRows_nt_urban_public_housing_wait_list", "description": "Rows of Urban public housing wait times, wait list and allocations, Northern Territory, 2018 to 2020 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": "as_at", "in": "query", "schema": { "type": "string" }, "description": "date. The date of the release. Values: 2018-12-31, 2019-06-30, 2019-12-31, 2020-06-30, 2020-12-31.", "examples": [ "eq.2020-12-31" ] }, { "name": "table", "in": "query", "schema": { "type": "string" }, "description": "string. Wait Times, Wait List or Allocations. Values: Allocations, Wait List, Wait Times.", "examples": [ "eq.Wait Times" ] }, { "name": "region", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Alice Springs, Darwin/Casuarina, Katherine, Nhulunbuy, Palmerston, Tennant Creek, Total.", "examples": [ "eq.Total" ] }, { "name": "bedrooms", "in": "query", "schema": { "type": "string" }, "description": "string. As the publisher heads the column. Wait times give 3 bedroom, and the wait list and allocations 3+ bedroom and a Total. Values: 1 bedroom, 2 bedroom, 3 bedroom, 3+ bedroom, Total.", "examples": [ "eq.Total" ] }, { "name": "value", "in": "query", "schema": { "type": "string" }, "description": "string. A band of years for a wait time, such as 4 to 6 years, and a count for the wait list and allocations." }, { "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/nt-urban-public-housing-wait-list/versions/{version}/rows": { "get": { "tags": [ "query" ], "summary": "Query Urban public housing wait times, wait list and allocations, Northern Territory, 2018 to 2020", "operationId": "queryRows_nt_urban_public_housing_wait_list_version", "description": "Rows of Urban public housing wait times, wait list and allocations, Northern Territory, 2018 to 2020 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": "as_at", "in": "query", "schema": { "type": "string" }, "description": "date. The date of the release. Values: 2018-12-31, 2019-06-30, 2019-12-31, 2020-06-30, 2020-12-31.", "examples": [ "eq.2020-12-31" ] }, { "name": "table", "in": "query", "schema": { "type": "string" }, "description": "string. Wait Times, Wait List or Allocations. Values: Allocations, Wait List, Wait Times.", "examples": [ "eq.Wait Times" ] }, { "name": "region", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Alice Springs, Darwin/Casuarina, Katherine, Nhulunbuy, Palmerston, Tennant Creek, Total.", "examples": [ "eq.Total" ] }, { "name": "bedrooms", "in": "query", "schema": { "type": "string" }, "description": "string. As the publisher heads the column. Wait times give 3 bedroom, and the wait list and allocations 3+ bedroom and a Total. Values: 1 bedroom, 2 bedroom, 3 bedroom, 3+ bedroom, Total.", "examples": [ "eq.Total" ] }, { "name": "value", "in": "query", "schema": { "type": "string" }, "description": "string. A band of years for a wait time, such as 4 to 6 years, and a count for the wait list and allocations." }, { "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": [ "nt-urban-public-housing-wait-list" ] }, "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": "as_at", "in": "query", "schema": { "type": "string" }, "description": "date. The date of the release. Values: 2018-12-31, 2019-06-30, 2019-12-31, 2020-06-30, 2020-12-31.", "examples": [ "eq.2020-12-31" ] }, { "name": "table", "in": "query", "schema": { "type": "string" }, "description": "string. Wait Times, Wait List or Allocations. Values: Allocations, Wait List, Wait Times.", "examples": [ "eq.Wait Times" ] }, { "name": "region", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Alice Springs, Darwin/Casuarina, Katherine, Nhulunbuy, Palmerston, Tennant Creek, Total.", "examples": [ "eq.Total" ] }, { "name": "bedrooms", "in": "query", "schema": { "type": "string" }, "description": "string. As the publisher heads the column. Wait times give 3 bedroom, and the wait list and allocations 3+ bedroom and a Total. Values: 1 bedroom, 2 bedroom, 3 bedroom, 3+ bedroom, Total.", "examples": [ "eq.Total" ] }, { "name": "value", "in": "query", "schema": { "type": "string" }, "description": "string. A band of years for a wait time, such as 4 to 6 years, and a count for the wait list and allocations." }, { "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": [ "nt-urban-public-housing-wait-list" ] }, "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": "as_at", "in": "query", "schema": { "type": "string" }, "description": "date. The date of the release. Values: 2018-12-31, 2019-06-30, 2019-12-31, 2020-06-30, 2020-12-31.", "examples": [ "eq.2020-12-31" ] }, { "name": "table", "in": "query", "schema": { "type": "string" }, "description": "string. Wait Times, Wait List or Allocations. Values: Allocations, Wait List, Wait Times.", "examples": [ "eq.Wait Times" ] }, { "name": "region", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Alice Springs, Darwin/Casuarina, Katherine, Nhulunbuy, Palmerston, Tennant Creek, Total.", "examples": [ "eq.Total" ] }, { "name": "bedrooms", "in": "query", "schema": { "type": "string" }, "description": "string. As the publisher heads the column. Wait times give 3 bedroom, and the wait list and allocations 3+ bedroom and a Total. Values: 1 bedroom, 2 bedroom, 3 bedroom, 3+ bedroom, Total.", "examples": [ "eq.Total" ] }, { "name": "value", "in": "query", "schema": { "type": "string" }, "description": "string. A band of years for a wait time, such as 4 to 6 years, and a count for the wait list and allocations." }, { "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": [ "nt-urban-public-housing-wait-list" ] }, "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" } } } } } } } } } } }