{ "openapi": "3.1.0", "info": { "title": "Daily fuel prices by service station, Northern Territory, 2017 to 2024 query API", "version": "2024-12-06", "summary": "Filter, page and aggregate Daily fuel prices by service station, Northern Territory, 2017 to 2024 from Department of Treasury and Finance.", "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 Treasury and Finance has not endorsed this site. The whole site is described in https://publicdata.au/openapi.json.", "license": { "name": "CC BY 3.0 AU", "url": "https://creativecommons.org/licenses/by/3.0/au/" } }, "servers": [ { "url": "https://publicdata.au" } ], "externalDocs": { "url": "https://publicdata.au/d/nt-fuel-prices-history/#query" }, "tags": [ { "name": "query" } ], "paths": { "/api/v1/datasets/nt-fuel-prices-history/rows": { "get": { "tags": [ "query" ], "summary": "Query Daily fuel prices by service station, Northern Territory, 2017 to 2024", "operationId": "queryRows_nt_fuel_prices_history", "description": "Rows of Daily fuel prices by service station, Northern Territory, 2017 to 2024 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": "date", "in": "query", "schema": { "type": "string" }, "description": "date. The day the prices were reported. Some workbooks hold the date as text with a midnight time, read as the same day. From 2017-11-01 to 2024-12-01." }, { "name": "brand_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: AMPOL, Astron, Ausfuel, BP, Caltex, Caltex Woolworths, Coles Express, EG Ampol, FuelXpress, Independent, Indervon, Liberty, Mobil, Mogas, On The Run, Puma Energy, Shell, Shell Coles Express, Shell Reddy Express, United.", "examples": [ "eq.United" ] }, { "name": "region_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Barkly, Central Australia, Darwin, East Arnhem, Katherine, Litchfield, Palmerston, Tiwi Island, Top End Rural.", "examples": [ "eq.Top End Rural" ] }, { "name": "suburb", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "postcode", "in": "query", "schema": { "type": "string" }, "description": "string. As published. Most workbooks hold the postcode as a number, which drops the leading zero (800 for 0800). Some rows from July to November 2023 keep it, so a filter on one postcode needs both forms.", "examples": [ "eq.886" ] }, { "name": "lat", "in": "query", "schema": { "type": "string" }, "description": "number. From -25.839525 to 0.0." }, { "name": "long", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.0 to 137.973541." }, { "name": "diesel", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.9 to 999.0." }, { "name": "premium_98", "in": "query", "schema": { "type": "string" }, "description": "number. From 4.34 to 1039.0." }, { "name": "premium_95", "in": "query", "schema": { "type": "string" }, "description": "number. From 22.481333 to 1012.0." }, { "name": "unleaded_91", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.894767 to 586.2." }, { "name": "premium_diesel", "in": "query", "schema": { "type": "string" }, "description": "number. From 1.957534 to 272.9." }, { "name": "lpg", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.95 to 279.9." }, { "name": "low_aromatic_fuel", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.9 to 999.0." }, { "name": "e85", "in": "query", "schema": { "type": "string" }, "description": "number. From 96.840845 to 249.909302.", "examples": [ "eq.249.909302" ] }, { "name": "e10", "in": "query", "schema": { "type": "string" }, "description": "number. From 1.828378 to 165.9." }, { "name": "b20", "in": "query", "schema": { "type": "string" }, "description": "number." }, { "name": "sa2_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Statistical Area Level 2 (2021) the point falls in. Joined by location from abs-sa2-2021, not published by the publisher.", "examples": [ "eq.702051068" ] }, { "name": "sa2_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Statistical Area Level 2 (2021) the point falls in. Joined by location from abs-sa2-2021, not published by the publisher.", "examples": [ "eq.Yuendumu - Anmatjere" ] }, { "name": "lga_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Local Government Area (2025) the point falls in. Joined by location from abs-lga-2025, not published by the publisher. Values: 70200, 70420, 70540, 70620, 70700, 71000, 71500, 71700, 72200, 72300, 72330, 72800, 73600, 74050, 74550, 74560, 74660, 74680, 79399.", "examples": [ "eq.79399" ] }, { "name": "lga_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Local Government Area (2025) the point falls in. Joined by location from abs-lga-2025, not published by the publisher. Values: Alice Springs, Barkly, Belyuen, Central Desert, Coomalie, Darwin, East Arnhem, Groote Archipelago, Katherine, Litchfield, MacDonnell, Palmerston, Roper Gulf, Tiwi Islands, Unincorporated NT, Victoria Daly, Wagait, West Arnhem, West Daly.", "examples": [ "eq.West Daly" ] }, { "name": "sal_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Suburb and Locality (2021) the point falls in. Joined by location from abs-suburbs-localities-2021, not published by the publisher.", "examples": [ "eq.70302" ] }, { "name": "sal_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Suburb and Locality (2021) the point falls in. Joined by location from abs-suburbs-localities-2021, not published by the publisher.", "examples": [ "eq.Yulara" ] }, { "name": "poa_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Postal Area (2021) the point falls in. Joined by location from abs-postal-areas-2021, not published by the publisher.", "examples": [ "eq.4825" ] }, { "name": "poa_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Postal Area (2021) the point falls in. Joined by location from abs-postal-areas-2021, not published by the publisher.", "examples": [ "eq.4825" ] }, { "name": "sed_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the State Electoral Division (2025) the point falls in. Joined by location from abs-state-electoral-divisions-2025, not published by the publisher.", "examples": [ "eq.70025" ] }, { "name": "sed_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the State Electoral Division (2025) the point falls in. Joined by location from abs-state-electoral-divisions-2025, not published by the publisher.", "examples": [ "eq.Wanguri" ] }, { "name": "ced_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Commonwealth Electoral Division (2025) the point falls in. Joined by location from abs-federal-electoral-divisions-2025, not published by the publisher. Values: 701, 702.", "examples": [ "eq.702" ] }, { "name": "ced_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Commonwealth Electoral Division (2025) the point falls in. Joined by location from abs-federal-electoral-divisions-2025, not published by the publisher. Values: Lingiari, Solomon.", "examples": [ "eq.Solomon" ] }, { "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/nt-fuel-prices-history/versions/{version}/rows": { "get": { "tags": [ "query" ], "summary": "Query Daily fuel prices by service station, Northern Territory, 2017 to 2024", "operationId": "queryRows_nt_fuel_prices_history_version", "description": "Rows of Daily fuel prices by service station, Northern Territory, 2017 to 2024 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": "date", "in": "query", "schema": { "type": "string" }, "description": "date. The day the prices were reported. Some workbooks hold the date as text with a midnight time, read as the same day. From 2017-11-01 to 2024-12-01." }, { "name": "brand_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: AMPOL, Astron, Ausfuel, BP, Caltex, Caltex Woolworths, Coles Express, EG Ampol, FuelXpress, Independent, Indervon, Liberty, Mobil, Mogas, On The Run, Puma Energy, Shell, Shell Coles Express, Shell Reddy Express, United.", "examples": [ "eq.United" ] }, { "name": "region_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Barkly, Central Australia, Darwin, East Arnhem, Katherine, Litchfield, Palmerston, Tiwi Island, Top End Rural.", "examples": [ "eq.Top End Rural" ] }, { "name": "suburb", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "postcode", "in": "query", "schema": { "type": "string" }, "description": "string. As published. Most workbooks hold the postcode as a number, which drops the leading zero (800 for 0800). Some rows from July to November 2023 keep it, so a filter on one postcode needs both forms.", "examples": [ "eq.886" ] }, { "name": "lat", "in": "query", "schema": { "type": "string" }, "description": "number. From -25.839525 to 0.0." }, { "name": "long", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.0 to 137.973541." }, { "name": "diesel", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.9 to 999.0." }, { "name": "premium_98", "in": "query", "schema": { "type": "string" }, "description": "number. From 4.34 to 1039.0." }, { "name": "premium_95", "in": "query", "schema": { "type": "string" }, "description": "number. From 22.481333 to 1012.0." }, { "name": "unleaded_91", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.894767 to 586.2." }, { "name": "premium_diesel", "in": "query", "schema": { "type": "string" }, "description": "number. From 1.957534 to 272.9." }, { "name": "lpg", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.95 to 279.9." }, { "name": "low_aromatic_fuel", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.9 to 999.0." }, { "name": "e85", "in": "query", "schema": { "type": "string" }, "description": "number. From 96.840845 to 249.909302.", "examples": [ "eq.249.909302" ] }, { "name": "e10", "in": "query", "schema": { "type": "string" }, "description": "number. From 1.828378 to 165.9." }, { "name": "b20", "in": "query", "schema": { "type": "string" }, "description": "number." }, { "name": "sa2_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Statistical Area Level 2 (2021) the point falls in. Joined by location from abs-sa2-2021, not published by the publisher.", "examples": [ "eq.702051068" ] }, { "name": "sa2_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Statistical Area Level 2 (2021) the point falls in. Joined by location from abs-sa2-2021, not published by the publisher.", "examples": [ "eq.Yuendumu - Anmatjere" ] }, { "name": "lga_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Local Government Area (2025) the point falls in. Joined by location from abs-lga-2025, not published by the publisher. Values: 70200, 70420, 70540, 70620, 70700, 71000, 71500, 71700, 72200, 72300, 72330, 72800, 73600, 74050, 74550, 74560, 74660, 74680, 79399.", "examples": [ "eq.79399" ] }, { "name": "lga_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Local Government Area (2025) the point falls in. Joined by location from abs-lga-2025, not published by the publisher. Values: Alice Springs, Barkly, Belyuen, Central Desert, Coomalie, Darwin, East Arnhem, Groote Archipelago, Katherine, Litchfield, MacDonnell, Palmerston, Roper Gulf, Tiwi Islands, Unincorporated NT, Victoria Daly, Wagait, West Arnhem, West Daly.", "examples": [ "eq.West Daly" ] }, { "name": "sal_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Suburb and Locality (2021) the point falls in. Joined by location from abs-suburbs-localities-2021, not published by the publisher.", "examples": [ "eq.70302" ] }, { "name": "sal_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Suburb and Locality (2021) the point falls in. Joined by location from abs-suburbs-localities-2021, not published by the publisher.", "examples": [ "eq.Yulara" ] }, { "name": "poa_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Postal Area (2021) the point falls in. Joined by location from abs-postal-areas-2021, not published by the publisher.", "examples": [ "eq.4825" ] }, { "name": "poa_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Postal Area (2021) the point falls in. Joined by location from abs-postal-areas-2021, not published by the publisher.", "examples": [ "eq.4825" ] }, { "name": "sed_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the State Electoral Division (2025) the point falls in. Joined by location from abs-state-electoral-divisions-2025, not published by the publisher.", "examples": [ "eq.70025" ] }, { "name": "sed_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the State Electoral Division (2025) the point falls in. Joined by location from abs-state-electoral-divisions-2025, not published by the publisher.", "examples": [ "eq.Wanguri" ] }, { "name": "ced_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Commonwealth Electoral Division (2025) the point falls in. Joined by location from abs-federal-electoral-divisions-2025, not published by the publisher. Values: 701, 702.", "examples": [ "eq.702" ] }, { "name": "ced_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Commonwealth Electoral Division (2025) the point falls in. Joined by location from abs-federal-electoral-divisions-2025, not published by the publisher. Values: Lingiari, Solomon.", "examples": [ "eq.Solomon" ] }, { "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": [ "nt-fuel-prices-history" ] }, "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": "date", "in": "query", "schema": { "type": "string" }, "description": "date. The day the prices were reported. Some workbooks hold the date as text with a midnight time, read as the same day. From 2017-11-01 to 2024-12-01." }, { "name": "brand_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: AMPOL, Astron, Ausfuel, BP, Caltex, Caltex Woolworths, Coles Express, EG Ampol, FuelXpress, Independent, Indervon, Liberty, Mobil, Mogas, On The Run, Puma Energy, Shell, Shell Coles Express, Shell Reddy Express, United.", "examples": [ "eq.United" ] }, { "name": "region_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Barkly, Central Australia, Darwin, East Arnhem, Katherine, Litchfield, Palmerston, Tiwi Island, Top End Rural.", "examples": [ "eq.Top End Rural" ] }, { "name": "suburb", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "postcode", "in": "query", "schema": { "type": "string" }, "description": "string. As published. Most workbooks hold the postcode as a number, which drops the leading zero (800 for 0800). Some rows from July to November 2023 keep it, so a filter on one postcode needs both forms.", "examples": [ "eq.886" ] }, { "name": "lat", "in": "query", "schema": { "type": "string" }, "description": "number. From -25.839525 to 0.0." }, { "name": "long", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.0 to 137.973541." }, { "name": "diesel", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.9 to 999.0." }, { "name": "premium_98", "in": "query", "schema": { "type": "string" }, "description": "number. From 4.34 to 1039.0." }, { "name": "premium_95", "in": "query", "schema": { "type": "string" }, "description": "number. From 22.481333 to 1012.0." }, { "name": "unleaded_91", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.894767 to 586.2." }, { "name": "premium_diesel", "in": "query", "schema": { "type": "string" }, "description": "number. From 1.957534 to 272.9." }, { "name": "lpg", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.95 to 279.9." }, { "name": "low_aromatic_fuel", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.9 to 999.0." }, { "name": "e85", "in": "query", "schema": { "type": "string" }, "description": "number. From 96.840845 to 249.909302.", "examples": [ "eq.249.909302" ] }, { "name": "e10", "in": "query", "schema": { "type": "string" }, "description": "number. From 1.828378 to 165.9." }, { "name": "b20", "in": "query", "schema": { "type": "string" }, "description": "number." }, { "name": "sa2_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Statistical Area Level 2 (2021) the point falls in. Joined by location from abs-sa2-2021, not published by the publisher.", "examples": [ "eq.702051068" ] }, { "name": "sa2_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Statistical Area Level 2 (2021) the point falls in. Joined by location from abs-sa2-2021, not published by the publisher.", "examples": [ "eq.Yuendumu - Anmatjere" ] }, { "name": "lga_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Local Government Area (2025) the point falls in. Joined by location from abs-lga-2025, not published by the publisher. Values: 70200, 70420, 70540, 70620, 70700, 71000, 71500, 71700, 72200, 72300, 72330, 72800, 73600, 74050, 74550, 74560, 74660, 74680, 79399.", "examples": [ "eq.79399" ] }, { "name": "lga_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Local Government Area (2025) the point falls in. Joined by location from abs-lga-2025, not published by the publisher. Values: Alice Springs, Barkly, Belyuen, Central Desert, Coomalie, Darwin, East Arnhem, Groote Archipelago, Katherine, Litchfield, MacDonnell, Palmerston, Roper Gulf, Tiwi Islands, Unincorporated NT, Victoria Daly, Wagait, West Arnhem, West Daly.", "examples": [ "eq.West Daly" ] }, { "name": "sal_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Suburb and Locality (2021) the point falls in. Joined by location from abs-suburbs-localities-2021, not published by the publisher.", "examples": [ "eq.70302" ] }, { "name": "sal_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Suburb and Locality (2021) the point falls in. Joined by location from abs-suburbs-localities-2021, not published by the publisher.", "examples": [ "eq.Yulara" ] }, { "name": "poa_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Postal Area (2021) the point falls in. Joined by location from abs-postal-areas-2021, not published by the publisher.", "examples": [ "eq.4825" ] }, { "name": "poa_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Postal Area (2021) the point falls in. Joined by location from abs-postal-areas-2021, not published by the publisher.", "examples": [ "eq.4825" ] }, { "name": "sed_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the State Electoral Division (2025) the point falls in. Joined by location from abs-state-electoral-divisions-2025, not published by the publisher.", "examples": [ "eq.70025" ] }, { "name": "sed_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the State Electoral Division (2025) the point falls in. Joined by location from abs-state-electoral-divisions-2025, not published by the publisher.", "examples": [ "eq.Wanguri" ] }, { "name": "ced_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Commonwealth Electoral Division (2025) the point falls in. Joined by location from abs-federal-electoral-divisions-2025, not published by the publisher. Values: 701, 702.", "examples": [ "eq.702" ] }, { "name": "ced_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Commonwealth Electoral Division (2025) the point falls in. Joined by location from abs-federal-electoral-divisions-2025, not published by the publisher. Values: Lingiari, Solomon.", "examples": [ "eq.Solomon" ] }, { "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": [ "nt-fuel-prices-history" ] }, "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": "date", "in": "query", "schema": { "type": "string" }, "description": "date. The day the prices were reported. Some workbooks hold the date as text with a midnight time, read as the same day. From 2017-11-01 to 2024-12-01." }, { "name": "brand_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: AMPOL, Astron, Ausfuel, BP, Caltex, Caltex Woolworths, Coles Express, EG Ampol, FuelXpress, Independent, Indervon, Liberty, Mobil, Mogas, On The Run, Puma Energy, Shell, Shell Coles Express, Shell Reddy Express, United.", "examples": [ "eq.United" ] }, { "name": "region_name", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Barkly, Central Australia, Darwin, East Arnhem, Katherine, Litchfield, Palmerston, Tiwi Island, Top End Rural.", "examples": [ "eq.Top End Rural" ] }, { "name": "suburb", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "postcode", "in": "query", "schema": { "type": "string" }, "description": "string. As published. Most workbooks hold the postcode as a number, which drops the leading zero (800 for 0800). Some rows from July to November 2023 keep it, so a filter on one postcode needs both forms.", "examples": [ "eq.886" ] }, { "name": "lat", "in": "query", "schema": { "type": "string" }, "description": "number. From -25.839525 to 0.0." }, { "name": "long", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.0 to 137.973541." }, { "name": "diesel", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.9 to 999.0." }, { "name": "premium_98", "in": "query", "schema": { "type": "string" }, "description": "number. From 4.34 to 1039.0." }, { "name": "premium_95", "in": "query", "schema": { "type": "string" }, "description": "number. From 22.481333 to 1012.0." }, { "name": "unleaded_91", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.894767 to 586.2." }, { "name": "premium_diesel", "in": "query", "schema": { "type": "string" }, "description": "number. From 1.957534 to 272.9." }, { "name": "lpg", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.95 to 279.9." }, { "name": "low_aromatic_fuel", "in": "query", "schema": { "type": "string" }, "description": "number. From 0.9 to 999.0." }, { "name": "e85", "in": "query", "schema": { "type": "string" }, "description": "number. From 96.840845 to 249.909302.", "examples": [ "eq.249.909302" ] }, { "name": "e10", "in": "query", "schema": { "type": "string" }, "description": "number. From 1.828378 to 165.9." }, { "name": "b20", "in": "query", "schema": { "type": "string" }, "description": "number." }, { "name": "sa2_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Statistical Area Level 2 (2021) the point falls in. Joined by location from abs-sa2-2021, not published by the publisher.", "examples": [ "eq.702051068" ] }, { "name": "sa2_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Statistical Area Level 2 (2021) the point falls in. Joined by location from abs-sa2-2021, not published by the publisher.", "examples": [ "eq.Yuendumu - Anmatjere" ] }, { "name": "lga_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Local Government Area (2025) the point falls in. Joined by location from abs-lga-2025, not published by the publisher. Values: 70200, 70420, 70540, 70620, 70700, 71000, 71500, 71700, 72200, 72300, 72330, 72800, 73600, 74050, 74550, 74560, 74660, 74680, 79399.", "examples": [ "eq.79399" ] }, { "name": "lga_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Local Government Area (2025) the point falls in. Joined by location from abs-lga-2025, not published by the publisher. Values: Alice Springs, Barkly, Belyuen, Central Desert, Coomalie, Darwin, East Arnhem, Groote Archipelago, Katherine, Litchfield, MacDonnell, Palmerston, Roper Gulf, Tiwi Islands, Unincorporated NT, Victoria Daly, Wagait, West Arnhem, West Daly.", "examples": [ "eq.West Daly" ] }, { "name": "sal_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Suburb and Locality (2021) the point falls in. Joined by location from abs-suburbs-localities-2021, not published by the publisher.", "examples": [ "eq.70302" ] }, { "name": "sal_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Suburb and Locality (2021) the point falls in. Joined by location from abs-suburbs-localities-2021, not published by the publisher.", "examples": [ "eq.Yulara" ] }, { "name": "poa_2021_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Postal Area (2021) the point falls in. Joined by location from abs-postal-areas-2021, not published by the publisher.", "examples": [ "eq.4825" ] }, { "name": "poa_2021_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Postal Area (2021) the point falls in. Joined by location from abs-postal-areas-2021, not published by the publisher.", "examples": [ "eq.4825" ] }, { "name": "sed_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the State Electoral Division (2025) the point falls in. Joined by location from abs-state-electoral-divisions-2025, not published by the publisher.", "examples": [ "eq.70025" ] }, { "name": "sed_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the State Electoral Division (2025) the point falls in. Joined by location from abs-state-electoral-divisions-2025, not published by the publisher.", "examples": [ "eq.Wanguri" ] }, { "name": "ced_2025_code", "in": "query", "schema": { "type": "string" }, "description": "string. Code of the Commonwealth Electoral Division (2025) the point falls in. Joined by location from abs-federal-electoral-divisions-2025, not published by the publisher. Values: 701, 702.", "examples": [ "eq.702" ] }, { "name": "ced_2025_name", "in": "query", "schema": { "type": "string" }, "description": "string. Name of the Commonwealth Electoral Division (2025) the point falls in. Joined by location from abs-federal-electoral-divisions-2025, not published by the publisher. Values: Lingiari, Solomon.", "examples": [ "eq.Solomon" ] }, { "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": [ "nt-fuel-prices-history" ] }, "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" } } } } } } } } } } }