---
title: "Dataset Metadata"
method: GET
path: "/metadata"
---

# Dataset Metadata

`GET /metadata`

## Request

- Base URL: `https://portal.sqd.dev/datasets/bitcoin-mainnet`
- URL: `https://portal.sqd.dev/datasets/bitcoin-mainnet/metadata`
- Auth: none required
- TypeScript: <https://skmtc.dev/sqd/apis/sqd-portal-api-bitcoin-dataset-endpoints/docs/metadata/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves metadata describing the dataset, including its name, aliases, start block, and real-time status.

## Response `200`

Dataset metadata response

- DatasetMetadata
  - `dataset` string, required: The default name used to reference this dataset (e.g., tron-mainnet).
  - `aliases` string[], required: Alternative names for the dataset.
  - `real_time` boolean, required: Indicates if the dataset has real-time data.
  - `start_block` integer: The block number of the first known block.

---

[API](https://skmtc.dev/sqd/apis/sqd-portal-api-bitcoin-dataset-endpoints.md) - [All operations](https://skmtc.dev/sqd/apis/sqd-portal-api-bitcoin-dataset-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/sqd/apis/sqd-portal-api-bitcoin-dataset-endpoints/revisions/cf9d60e495b1?raw)