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:
Querying
Get 5 results containing "jones" in any field:
curl https://devweb.datansw.links.com.au/data/api/action/datastore_search \
-H"Authorization:$API_TOKEN" -d '
{
"resource_id": "c1f1ee89-818f-49ac-ba93-ff6893eb5e1e",
"limit": 5,
"q": "jones"
}'const resp = await fetch(`https://devweb.datansw.links.com.au/data/api/action/datastore_search`, {
method: 'POST',
headers: {
'content-type': 'application/json',
authorization: API_TOKEN
},
body: JSON.stringify({
resource_id: 'c1f1ee89-818f-49ac-ba93-ff6893eb5e1e',
limit: 5,
q: 'jones'
})
})
await resp.json()$json = @'
{
"resource_id": "c1f1ee89-818f-49ac-ba93-ff6893eb5e1e",
"limit": 5,
"q": "jones"
}
'@
$response = Invoke-RestMethod https://devweb.datansw.links.com.au/data/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://devweb.datansw.links.com.au/data/', apikey=API_TOKEN)
result = rc.action.datastore_search(
resource_id="c1f1ee89-818f-49ac-ba93-ff6893eb5e1e",
limit=5,
q="jones",
)
print(result['records'])library(httr2)
req <- request("https://devweb.datansw.links.com.au/data/api/action/datastore_search")
result <- req %>%
req_headers(Authorization = API_TOKEN) %>%
req_body_json(list(
resource_id = 'c1f1ee89-818f-49ac-ba93-ff6893eb5e1e',
limit = 5,
q = 'jones'))
req_perform %>%
resp_body_jsoncurl https://devweb.datansw.links.com.au/data/api/action/datastore_search \
-H"Authorization:$API_TOKEN" -d '
{
"resource_id": "c1f1ee89-818f-49ac-ba93-ff6893eb5e1e",
"filters": {
"subject": ["watershed", "survey"],
"stage": "active"
}
}'const resp = await fetch(`https://devweb.datansw.links.com.au/data/api/action/datastore_search`, {
method: 'POST',
headers: {
'content-type': 'application/json',
authorization: API_TOKEN
},
body: JSON.stringify({resource_id: 'c1f1ee89-818f-49ac-ba93-ff6893eb5e1e', filters: {
subject: ['watershed', 'survey'],
stage: 'active'
}})})
await resp.json()$json = @'
{
"resource_id": "c1f1ee89-818f-49ac-ba93-ff6893eb5e1e",
"filters": {
"subject": ["watershed", "survey"],
"stage": "active"
}
}
'@
$response = Invoke-RestMethod https://devweb.datansw.links.com.au/data/api/action/datastore_search`
-Method Post -Body $json -Headers @{"Authorization"="$API_TOKEN"}
$response.result.recordsfrom ckanapi import RemoteCKAN
rc = RemoteCKAN('https://devweb.datansw.links.com.au/data/', apikey=API_TOKEN)
result = rc.action.datastore_search(
resource_id="c1f1ee89-818f-49ac-ba93-ff6893eb5e1e",
filters={
"subject": ["watershed", "survey"],
"stage": "active",
},
)
print(result['records'])library(httr2)
req <- request("https://devweb.datansw.links.com.au/data/api/action/datastore_search")
result <- req %>%
req_headers(Authorization = API_TOKEN) %>%
req_body_json(list(
resource_id='c1f1ee89-818f-49ac-ba93-ff6893eb5e1e',
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) Query example (results containing 'jones')