count_rowsread-only
Count, sum, average, minimum or maximum rows of a served dataset across the whole table, grouped by up to three fields. For the rows themselves use query_rows.
Field names and values for group_by and where come from…
group_by: array?, limit: integer?, metric: string?, slug: string, version: string?, where: object?
diff_versionsread-only
Compare two consecutive versions of a served dataset row by row on its key fields, to see what a publisher changed between releases. from and to must be adjacent dates in the version history from get_dataset, older…
from: string, slug: string, to: string
find_dataset_page
Search every dataset on Australia's government open-data portals by title, publisher or topic and open the results page. Datasets served here are marked.
q: string?
get_datasetread-only
Read a served dataset's data package and full version history: licence, attribution, whole-table files and the version dates diff_versions and the version parameter take. It carries no rows. To answer from the rows…
slug: string
list_backlogread-only
List the datasets people have asked publicdata.au to build, most votes first. Use it to see what is wanted or under way, or to check that a vote counted.
To add a vote use upvote_dataset. To read a dataset that is…
list_fieldsread-only
List a served dataset's fields, with their types, descriptions, ranges and values, before querying it. Call it before query_rows or count_rows unless you already know the exact names and values, because where matches…
slug: string
list_partitionsread-only
List the download files that split a served dataset's newest version by one field, such as one file per year. Use it to hand someone a slice of the data as a file. It gives file links and no rows, so to answer a…
field: string, slug: string
query_rowsread-only
Read individual rows of a served dataset, filtered across the whole table. For totals and breakdowns use count_rows, and for files use get_dataset or list_partitions.
Field names and values for where, select and order…
limit: integer?, offset: integer?, order: string?, select: array?, slug: string, version: string?, where: object?
request_dataset
Vote for a government dataset by its portal URL. A URL the catalogue holds becomes a vote for that dataset; the answer says so or explains why it cannot take one. No identity is recorded.
url: string
search_catalogueread-only
Search every dataset listed on Australia's government portals, including the many publicdata.au does not serve yet. Its records describe data held elsewhere, which cannot be queried here.
Use it when search_datasets…
jurisdiction: string?, offset: integer?, query: string, votable_only: boolean?
search_datasetsread-only
Find the slug of a served dataset. Start here for any question about Australian government data, since the other tools read only the datasets this finds.
Every word in query must match the title, summary, publisher…
query: string
upvote_dataset
Add one anonymous vote for a government dataset that publicdata.au does not serve yet, so it is built sooner. To read a served dataset use search_datasets, and to see the votes so far use list_backlog.
slug is a vote…
slug: string
