What you get#
Onekey exposes CKAN as 5 endpoints behind one API key: 1 endpoint return one record (data is an object) and 4 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for CKAN also works for the rest of the government & public data category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
australia_search | Search Australian open government datasets (data.gov.au, CKAN). | q*, rows | 5 | stable |
canada_search | Search Canadian open government datasets (open.canada.ca, CKAN). | q*, rows | 5 | stable |
swiss_search | Search Swiss open government datasets (opendata.swiss, CKAN; titles are German). | q*, rows | 5 | stable |
uk_dataset | One UK government dataset by name/slug (data.gov.uk). | id* | 1 | stable |
uk_search | Search UK government open datasets (data.gov.uk, CKAN). | q*, rows | 5 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls ckan.uk_dataset (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/ckan/uk_dataset?id=climate-resilience-documents" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from CKAN, with the same names as on every other platform. The count is how many of its 5 mapped endpoints return the field; a field the source lacks is null, never missing. 1 platform-specific field (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
entity.date | ISO 8601 date | 5 |
entity.description | string | 5 |
entity.id | string | 5 |
entity.name | string | 5 |
entity.slug | string | 5 |
entity.category | string | 3 |
package.license | string | 3 |
The full schema is in Unified schema.
Pricing#
CKAN calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.