---
title: "data.gov.hk datasets list"
method: GET
path: "/api/v1/data-gov-hk/datasets"
tags: ["Public Finance & Government"]
---

# data.gov.hk datasets list

`GET /api/v1/data-gov-hk/datasets`

List datasets on the Hong Kong portal. When `group` is supplied, the response includes full package summaries for datasets in that group (CKAN `group_show?include_datasets=true`). With no `group` filter, the response returns the complete bare-slug index via CKAN `package_list` (no metadata). Upstream does not expose `package_search`; use `group` or a dataset ID on `/dataset/{id}` to retrieve metadata.

## Query parameters

- `group` string, nullable — Optional group slug filter (see `/data-gov-hk/groups`). When omitted, returns the full slug index.
- `lang` string — Portal language: `en`, `tc`, or `sc`.

## Response `200`

Either full dataset summaries (filtered by group) or the bare dataset slug index.

- EnvelopeHkDatasetsPayload
  - `data` HkDatasetsPayload, required — Response payload for `/api/v1/data-gov-hk/datasets`.
    - `lang` string, required — Portal language code echoed back.
    - `group` string, nullable — Group slug filter applied (empty when listing across all groups).
    - `group_title` string, nullable — Human-readable title of the group when a group filter is applied.
    - `package_count` integer, required — Total datasets available for the current scope (group or whole portal).
    - `datasets` object[], nullable — Full package summaries when filtered by group (from CKAN `group_show`).
    - `names` string[], nullable — Bare dataset slug list when no group filter is applied (from CKAN `package_list`).
    - `count` integer, required — Number of records returned in this response.
  - `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/d3e3d9c28132/schema)