> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sqd.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Dataset Metadata

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



## OpenAPI

````yaml /en/api/catalog/substrate/openapi.yaml get /metadata
openapi: 3.1.0
info:
  title: SQD Portal API - Substrate Dataset Endpoints
  description: >-
    API endpoints for interacting with Substrate datasets under the SQD Portal,
    specifically for the Polkadot dataset.
  version: 1.0.0
servers:
  - url: https://portal.sqd.dev/datasets/polkadot
    description: SQD Portal's endpoint for Polkadot
security: []
paths:
  /metadata:
    get:
      summary: Dataset Metadata
      description: >-
        Retrieves metadata describing the dataset, including its name, aliases,
        start block, and real-time status.
      responses:
        '200':
          description: Dataset metadata response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetMetadata'
      x-codeSamples:
        - lang: shell
          source: >
            curl --compressed
            'https://portal.sqd.dev/datasets/polkadot/metadata'
        - lang: python
          label: Dataset Metadata
          source: |
            import requests

            response = requests.get(
                "https://portal.sqd.dev/datasets/polkadot/metadata"
            )
            data = response.json()
        - lang: javascript
          label: Dataset Metadata
          source: >
            const response = await
            fetch("https://portal.sqd.dev/datasets/polkadot/metadata");

            const data = await response.json();
components:
  schemas:
    DatasetMetadata:
      type: object
      properties:
        dataset:
          type: string
          description: The default name used to reference this dataset
        aliases:
          type: array
          items:
            type: string
          description: Alternative names for the dataset
        real_time:
          type: boolean
          description: Indicates if the dataset has real-time data
        start_block:
          type: integer
          format: int64
          description: The block number of the first known block
      required:
        - dataset
        - aliases
        - real_time

````