Air Quality Data - Air quality API

<built-in method title of str object at 0x7f8e7fdf1870>

Air quality API

Download URL: https://www.dpie.nsw.gov.au/air-quality/air-quality-data-services/air-quality-api

Details
Last updated	10/07/2020
Date Created	10/07/2020
File format	HTML
Licence	Creative Commons Attribution

There are no views created for this resource yet.

Additional Information

Field	Value
Title	Air quality API
Data last updated	10/07/2020
Metadata last updated	04/02/2025
Format	HTML
License	Creative Commons Attribution
Original URL	https://www.dpie.nsw.gov.au/air-quality/air-quality-data-services/air-quality-api

CKAN Data API

Access resource data via a web API with powerful query support. Further information in the main CKAN Data API and DataStore documentation.

Code examples:

curl JavaScript PowerShell Python R

Querying

Get 5 results containing "jones" in any field:

curl https://data.nsw.gov.au/data/en/api/action/datastore_search \
  -H"Authorization:$API_TOKEN" -d '
{
  "resource_id": "499ab6ce-e01f-4041-83ec-d508c16338cc",
  "limit": 5,
  "q": "jones"
}'

const resp = await fetch(`https://data.nsw.gov.au/data/en/api/action/datastore_search`, {
    method: 'POST',
    headers: {
        'content-type': 'application/json',
        authorization: API_TOKEN
    },
    body: JSON.stringify({
        resource_id: '499ab6ce-e01f-4041-83ec-d508c16338cc',
        limit: 5,
        q: 'jones'
    })
})
await resp.json()

$json = @'
{
  "resource_id": "499ab6ce-e01f-4041-83ec-d508c16338cc",
  "limit": 5,
  "q": "jones"
}
'@
$response = Invoke-RestMethod https://data.nsw.gov.au/data/en/api/action/datastore_search`
  -Method Post -Body $json -Headers @{"Authorization"="$API_TOKEN"}
$response.result.records

(using the ckanapi client library)

from ckanapi import RemoteCKAN

rc = RemoteCKAN('https://data.nsw.gov.au/data/en/', apikey=API_TOKEN)
result = rc.action.datastore_search(
    resource_id="499ab6ce-e01f-4041-83ec-d508c16338cc",
    limit=5,
    q="jones",
)
print(result['records'])

library(httr2)

req <- request("https://data.nsw.gov.au/data/en/api/action/datastore_search")
result <- req %>% 
    req_headers(Authorization = API_TOKEN) %>% 
    req_body_json(list(
        resource_id = '499ab6ce-e01f-4041-83ec-d508c16338cc',
        limit = 5,
        q = 'jones'))
    req_perform %>% 
    resp_body_json

Get results with either "watershed" or "survey" as subject and "active" as its stage:

curl https://data.nsw.gov.au/data/en/api/action/datastore_search \
-H"Authorization:$API_TOKEN" -d '
{
"resource_id": "499ab6ce-e01f-4041-83ec-d508c16338cc",
  "filters": {
    "subject": ["watershed", "survey"],
    "stage": "active"
  }
}'

const resp = await fetch(`https://data.nsw.gov.au/data/en/api/action/datastore_search`, {
    method: 'POST',
    headers: {
        'content-type': 'application/json',
        authorization: API_TOKEN
    },
    body: JSON.stringify({resource_id: '499ab6ce-e01f-4041-83ec-d508c16338cc', filters: {
        subject: ['watershed', 'survey'],
        stage: 'active'
    }})})
await resp.json()

$json = @'
{
  "resource_id": "499ab6ce-e01f-4041-83ec-d508c16338cc",
  "filters": {
    "subject": ["watershed", "survey"],
    "stage": "active"
  }
}
'@
$response = Invoke-RestMethod https://data.nsw.gov.au/data/en/api/action/datastore_search`
  -Method Post -Body $json -Headers @{"Authorization"="$API_TOKEN"}
$response.result.records

from ckanapi import RemoteCKAN

rc = RemoteCKAN('https://data.nsw.gov.au/data/en/', apikey=API_TOKEN)
result = rc.action.datastore_search(
    resource_id="499ab6ce-e01f-4041-83ec-d508c16338cc",
    filters={
      "subject": ["watershed", "survey"],
      "stage": "active",
    },
)
print(result['records'])

library(httr2)

req <- request("https://data.nsw.gov.au/data/en/api/action/datastore_search")
result <- req %>% 
    req_headers(Authorization = API_TOKEN) %>% 
    req_body_json(list(
        resource_id='499ab6ce-e01f-4041-83ec-d508c16338cc', 
        filters = list(
            subject = list("watershed", "survey"), 
            stage = "active")))
    req_perform %>% 
    resp_body_json

Using the API with this Web Browser

Some API endpoints may be accessed using a GET query string.

Query example (first 5 results)

https://data.nsw.gov.au/data/en/api/action/datastore_search?resource_id=499ab6ce-e01f-4041-83ec-d508c16338cc&limit=5

Query example (results containing 'jones')

https://data.nsw.gov.au/data/en/api/action/datastore_search?resource_id=499ab6ce-e01f-4041-83ec-d508c16338cc&q=jones