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:

Get 5 results containing "jones" in any field: 
curl https://opendatanepal.com/en_GB/api/action/datastore_search \
  -H"Authorization:$API_TOKEN" -d '
{
  "resource_id": "c0e05fb1-97fd-4772-872e-9caadfd3663b",
  "limit": 5,
  "q": "jones"
}'
const resp = await fetch(`https://opendatanepal.com/en_GB/api/action/datastore_search`, {
    method: 'POST',
    headers: {
        'content-type': 'application/json',
        authorization: API_TOKEN
    },
    body: JSON.stringify({
        resource_id: 'c0e05fb1-97fd-4772-872e-9caadfd3663b',
        limit: 5,
        q: 'jones'
    })
})
await resp.json()
$json = @'
{
  "resource_id": "c0e05fb1-97fd-4772-872e-9caadfd3663b",
  "limit": 5,
  "q": "jones"
}
'@
$response = Invoke-RestMethod https://opendatanepal.com/en_GB/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://opendatanepal.com/en_GB/', apikey=API_TOKEN)
result = rc.action.datastore_search(
    resource_id="c0e05fb1-97fd-4772-872e-9caadfd3663b",
    limit=5,
    q="jones",
)
print(result['records'])
library(httr2)

req <- request("https://opendatanepal.com/en_GB/api/action/datastore_search")
result <- req %>% 
    req_headers(Authorization = API_TOKEN) %>% 
    req_body_json(list(
        resource_id = 'c0e05fb1-97fd-4772-872e-9caadfd3663b',
        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://opendatanepal.com/en_GB/api/action/datastore_search \
-H"Authorization:$API_TOKEN" -d '
{
"resource_id": "c0e05fb1-97fd-4772-872e-9caadfd3663b",
  "filters": {
    "subject": ["watershed", "survey"],
    "stage": "active"
  }
}'
const resp = await fetch(`https://opendatanepal.com/en_GB/api/action/datastore_search`, {
    method: 'POST',
    headers: {
        'content-type': 'application/json',
        authorization: API_TOKEN
    },
    body: JSON.stringify({resource_id: 'c0e05fb1-97fd-4772-872e-9caadfd3663b', filters: {
        subject: ['watershed', 'survey'],
        stage: 'active'
    }})})
await resp.json()
$json = @'
{
  "resource_id": "c0e05fb1-97fd-4772-872e-9caadfd3663b",
  "filters": {
    "subject": ["watershed", "survey"],
    "stage": "active"
  }
}
'@
$response = Invoke-RestMethod https://opendatanepal.com/en_GB/api/action/datastore_search`
  -Method Post -Body $json -Headers @{"Authorization"="$API_TOKEN"}
$response.result.records
from ckanapi import RemoteCKAN

rc = RemoteCKAN('https://opendatanepal.com/en_GB/', apikey=API_TOKEN)
result = rc.action.datastore_search(
    resource_id="c0e05fb1-97fd-4772-872e-9caadfd3663b",
    filters={
      "subject": ["watershed", "survey"],
      "stage": "active",
    },
)
print(result['records'])
library(httr2)

req <- request("https://opendatanepal.com/en_GB/api/action/datastore_search")
result <- req %>% 
    req_headers(Authorization = API_TOKEN) %>% 
    req_body_json(list(
        resource_id='c0e05fb1-97fd-4772-872e-9caadfd3663b', 
        filters = list(
            subject = list("watershed", "survey"), 
            stage = "active")))
    req_perform %>% 
    resp_body_json
SQL query example: 
curl https://opendatanepal.com/en_GB/api/action/datastore_search_sql \
  -H"Authorization:$API_TOKEN" -d @- <<END
{
  "sql": "SELECT * FROM \"c0e05fb1-97fd-4772-872e-9caadfd3663b\" WHERE title LIKE 'jones'"
}
END
const resp = await fetch(`https://opendatanepal.com/en_GB/api/action/datastore_search_sql`, {
    method: 'POST',
    headers: {
        'content-type': 'application/json',
        authorization: API_TOKEN
    },
    body: JSON.stringify({
        sql: `SELECT * FROM "c0e05fb1-97fd-4772-872e-9caadfd3663b" WHERE title LIKE 'jones'`
    })
})
await resp.json()
$json = @'
{
  "sql": "SELECT * from \"c0e05fb1-97fd-4772-872e-9caadfd3663b\" WHERE title LIKE 'jones'"
}
'@
$response = Invoke-RestMethod https://opendatanepal.com/en_GB/api/action/datastore_search_sql`
  -Method Post -Body $json -Headers @{"Authorization"="$API_TOKEN"}
$response.result.records
from ckanapi import RemoteCKAN

rc = RemoteCKAN('https://opendatanepal.com/en_GB/', apikey=API_TOKEN)
result = rc.action.datastore_search_sql(
    sql="""SELECT * from "c0e05fb1-97fd-4772-872e-9caadfd3663b" WHERE title LIKE 'jones'"""
)
print(result['records'])
library(httr2)

req <- request("https://opendatanepal.com/en_GB/api/action/datastore_search_sql")
result <- req %>% 
    req_headers(Authorization = API_TOKEN) %>% 
    req_body_json(list(
        sql = "SELECT * FROM \"c0e05fb1-97fd-4772-872e-9caadfd3663b\" WHERE title LIKE 'jones'"))
    req_perform %>% 
    resp_body_json