---
title: "Get information about the sources of the data in HDX HAPI"
method: GET
path: "/api/v2/metadata/dataset"
tags: ["Metadata"]
---

# Get information about the sources of the data in HDX HAPI

`GET /api/v2/metadata/dataset`

Get information about the <a href="https://data.humdata.org/dataset">HDX Datasets</a> that are used as data sources
for HDX HAPI. Datasets contain one or more resources, which are the sources of the data found in HDX HAPI.

## Query parameters

- `app_identifier` string, nullable, required — base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint.
- `dataset_hdx_id` string, nullable — Filter the response by the dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX.
- `dataset_hdx_stub` string, nullable — Filter the response by the URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX.
- `dataset_hdx_title` string, nullable — Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change.
- `hdx_provider_stub` string, nullable — Filter the response by the URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of `https://data.humdata.org/organization/[hdx_provider_stub]` will load the provider's page on HDX.
- `hdx_provider_name` string, nullable — Filter the response by the display name of the provider (organization) of the dataset on HDX.
- `output_format` 'csv' | 'json'
- `limit` integer — Maximum number of records to return. The system will not return more than 10,000 records.
- `offset` integer — Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.

## Response `200`

Successful Response

- HapiGenericResponseDatasetResponse
  - `data` DatasetResponse[], required
    - `dataset_hdx_id` string, required — The dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX.
    - `dataset_hdx_stub` string, required — The URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX.
    - `dataset_hdx_title` string, required — The title of the dataset as it appears in the HDX interface. This name is not unique and can change.
    - `hdx_provider_stub` string, required — The URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of `https://data.humdata.org/organization/[hdx_provider_stub]` will load the provider's page on HDX.
    - `hdx_provider_name` string, required — The display name of the provider (organization) of the dataset on HDX.
    - `hdx_link` string, uri, required
    - `hdx_api_link` string, uri, required
    - `provider_hdx_link` string, uri, required
    - `provider_hdx_api_link` string, uri, required

## Other responses

- `400` — Bad Request
- `422` — Validation Error
- `500` — Internal Server Error

---

[API](https://skmtc.dev/humdata/apis/hdx-apis.md) · [All operations](https://skmtc.dev/humdata/apis/hdx-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/humdata/hdx-apis/revisions/cc1970bc392c/schema)