---
title: "data.gov.hk dataset detail"
method: GET
path: "/api/v1/data-gov-hk/dataset/{id}"
tags: ["Public Finance & Government"]
---

# data.gov.hk dataset detail

`GET /api/v1/data-gov-hk/dataset/{id}`

Fetch full dataset metadata and embedded resource URLs via CKAN `package_show`. Resource URLs point to the publishing department's host (HKO, EPD, Transport Department, Hospital Authority etc.); Sugra passes them through unchanged - download resources directly from upstream.

## Path parameters

- `id` string, required — Dataset slug (CKAN `name`) as listed by `/data-gov-hk/datasets?group=...`.

## Query parameters

- `lang` string — Portal language: `en`, `tc`, or `sc`.

## Response `200`

Full dataset record with organization, resources, tags, license and extras.

- EnvelopeHkDatasetPayload
  - `data` HkDatasetPayload, required — Response payload for `/api/v1/data-gov-hk/dataset/{id}`. Passthrough of the upstream CKAN `package_show` result, with resource URLs embedded. Consumers download resources directly from their source hosts.
    - `lang` string, required — Portal language code echoed back.
    - `dataset` object, required — Full dataset record including organization, resources, tags, license and extras.
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/4c4530760ba1/schema)