publicdata.au

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 first. Any other pair returns a 404 error, so step through a longer span one pair at a time. A dataset with no key, which list_fields shows as an empty key, gets row counts only, and a dataset with one version has nothing to compare. One answer holds the counts of rows added, removed, changed and unchanged, the keys of the rows added, removed and changed, and up to ten changed rows with their old and new values. The call costs nothing against the rate limit.

diff_versions

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 list_fields. sum and avg need a numeric or true-or-false field. min and max take any field. version can be any date in the version history from get_dataset. A version too large for one file is stored as period parts and answered from them. A filter on the period field reads only the parts it can match, and parts names the periods read. Groups come back largest first, and truncated means raise limit or narrow where. An unknown field or version returns an error naming it. Each call costs two of the 60 queries each address may make in 10 seconds.

count_rows

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 values exactly and an unknown field is an error. It also names the key fields diff_versions compares on and the partition fields list_partitions accepts. slug is lowercase letters, digits and hyphens, the part after /d/ in a dataset page URL, such as au-road-deaths. The answer describes the newest version, in one page. The call costs nothing against the rate limit. A slug that is not served or not loaded for queries returns an error.

list_fields

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 question use query_rows or count_rows instead, and for the whole table as one file use get_dataset. field must be one of the partition_by fields that list_fields names, and any other field returns a 404 error. Every value comes back in one answer, with no paging. The call costs nothing against the rate limit.

list_partitions

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 already served use search_datasets. Votes on catalogue records that no entry has claimed yet come back apart, under the vote key search_catalogue uses. The whole backlog comes back in one answer, with no paging, and the call costs nothing against the rate limit.

list_backlog

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 come from list_fields. Filters hold at most 90 values per call, and a list value cannot contain a comma. version can be any date in the version history from get_dataset. A version too large for one file is stored as period parts and answered from them, in period order. A filter on the period field reads only the parts it can match, and parts names the periods read. One page holds up to limit rows, and offset steps through the rest until next_offset is null. An unknown field or version returns an error naming it. Each call costs two of the 60 queries each address may make in 10 seconds.

query_rows

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 use query_rows or count_rows, and for field names use list_fields. slug is lowercase letters, digits and hyphens, the part after /d/ in a dataset page URL, such as au-road-deaths. The whole history comes back in one answer, with no paging. It needs no key or sign-in, and costs nothing against the rate limit. A slug that is not served returns a 404 error.

get_dataset

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, keywords or a field name. A word matches its plural and other endings but never as a prefix, so bus does not find business. Up to 50 matches come back in one answer, with no paging. If nothing matches, try fewer or broader words, then search_catalogue. Each call costs one of the 60 queries each address may make in 10 seconds.

search_datasets

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 finds nothing, to find where a dataset is published, or to pick one for upvote_dataset. query matches every word against the title, summary and publisher, as search_datasets does. A page holds 20 records, those that can take a vote first. Pass next_offset as offset for the next page, up to 5000. Each call costs three of the 60 queries each address may make in 10 seconds.

search_catalogue

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 key from search_catalogue, such as act-3u5a-ve4j, or a list_backlog slug. A dataset that is served, being built or closed returns an error saying it is not open for votes. No identity is recorded, so a vote cannot be withdrawn, and a second vote from the same caller on the same day adds nothing. The answer gives the dataset's vote total after this call. The call costs nothing against the rate limit.

upvote_dataset