CKAN icon

CKAN

Interact with the CKAN API

Resource Search

AI-generated

Summary

Searches for data resources across all public datasets on a CKAN instance and returns a list of matching resources with their metadata.

Inputs

  • ckanUrl (required) — The base URL of the CKAN instance (e.g., https://demo.ckan.org).
  • query (required) — One or more 'field:term' pairs separated by spaces (e.g., 'name:District format:CSV'). All terms are AND-ed together.
  • order_by — Field to sort results by, e.g., 'name' or 'format'.
  • limit — Maximum number of resources to return (default: 20).
  • offset — Number of resources to skip for pagination (default: 0).

Output shape

An array of items, each containing a 'success' flag and a 'data' object with the CKAN API result list.

The CKAN API returns a count and a list of matching resource dicts. If the CKAN API returns an error object, the node throws a NodeApiError. Pagination is supported via offset and limit.

Examples

Example 1: Find all CSV files named 'District' on a CKAN instance

ckanUrl: https://demo.ckan.org, query: 'name:District format:CSV', limit: 10

Example 2: Retrieve the first 50 resources sorted by name

ckanUrl: https://demo.ckan.org, query: '*', order_by: 'name', limit: 50, offset: 0

Links

Discussion