ckan.uk_dataset

stable Standard

One UK government dataset by name/slug (data.gov.uk).

GET /v1/ckan/uk_dataset

What you get#

One Ckan record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit 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
`id`	string	yes	(required)	Dataset id or slug	max 121 chars; must match `[a-z0-9][a-z0-9_-]{2,120}`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/ckan/uk_dataset?id=climate-resilience-documents" \
  -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": "9023a2a3-bf51-48f6-bb93-6c1d4acaa424",
      "name": "Climate resilience documents",
      "description": "<dp-prose>\n  <p>This dataset includes links to policies, strategies and documents relevant to climate resilience on a wide range of geographic scales. The project was undertaken with the guidance of Leeds City Council and Leeds Climate Commission and contains a large amount of Leeds specific policies and data.</p>\n  <h2>Please note</h2>\n  <ul>\n    <li>\n      <p>This dataset was created as part of ",
      "slug": "climate-resilience-documents",
      "category": "Data Mill North",
      "date": "2026-09-25T12:07:29Z"
    },
    "ext": {
      "resources": 6
    },
    "package": {
      "license": null
    }
  },
  "metadata": {
    "platform": "ckan",
    "endpoint": "uk_dataset",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "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`	`entity.name`	-
`notes`	`entity.description`	-
`name`	`entity.slug`	-
`organization.title`	`entity.category`	-
`metadata_modified`	`entity.date`	`toIsoDate`
`num_resources`	`ext.resources`	`toNumber`
`license_title`	`package.license`	-

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours 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 day more (marked stale).
A "not found" is remembered for 5 minutes 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`	That record does not exist. Free; do not retry.
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).