ckan.canada_search

stable Advanced

Search Canadian open government datasets (open.canada.ca, CKAN).

GET /v1/ckan/canada_search

What you get#

A list of Ckan results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search text	max 80 chars; must match `[\w .,'&+:()-]{1,80}`; trimmed, repeated spaces collapsed
`rows`	string	no	`10`	Rows (1-50)	max 2 chars; must match `[1-9]\d?\|50`; trimmed

Request#

curl "https://api.onekey.dev/v1/ckan/canada_search?q=climate&rows=3" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Ckan response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "09ffaeb5-ec8f-5bb5-bdcb-3436ccf26f58",
        "name": "Climatic Regions",
        "description": "Contained within 3rd Edition (1957) of the Atlas of Canada is a map that shows the division of Canada into climatic regions according to the classification of the climates of the world developed by W. Koppen. Koppen first divided the world into five major divisions to which he assigned the letters A, B, C, D, and E. The letters represent the range of divisions from tropical climate (A) to polar cl",
        "slug": "09ffaeb5-ec8f-5bb5-bdcb-3436ccf26f58",
        "date": "2022-03-14T19:51:11Z"
      },
      "ext": {
        "resources": 4
      }
    },
    {
      "entity": {
        "id": "d3db9de0-25fa-5716-ad6c-e9c1749bb9de",
        "name": "Soil Climate",
        "description": "Contained within the 4th Edition (1974) of the Atlas of Canada is a set of two maps. One shows soil temperature classes and the second shows soil moisture regimes and subclasses. These maps are supplemented by a text giving detailed definitions for both soil temperature classes and soil moisture regimes and sub classes.",
        "slug": "d3db9de0-25fa-5716-ad6c-e9c1749bb9de",
        "date": "2022-03-14T19:36:09Z"
      },
      "ext": {
        "resources": 6
      }
    }
  ],
  "metadata": {
    "platform": "ckan",
    "endpoint": "canada_search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`entity.id`	-
`title_translated.en`	`entity.name`	-
`notes_translated.en`	`entity.description`	-
`name`	`entity.slug`	-
`metadata_modified`	`entity.date`	`toIsoDate`
`num_resources`	`ext.resources`	`toNumber`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).