---
title: "Get the size of a dataset."
method: GET
path: "/size"
---

# Get the size of a dataset.

`GET /size`

Returns the size (number of rows, storage) of the dataset. Use the optional config parameter to filter the response on a subset.

## Query parameters

- `dataset` string, required
- `config` string

## Response `200`

The size of the dataset.

- union
  - DatasetSizeResponse
    - `size` object, required
      - `dataset` DatasetSize, required
        - `dataset` string, required
        - `num_bytes_original_files` integer
        - `num_bytes_parquet_files` integer, required
        - `num_bytes_memory` integer, required
        - `num_rows` integer, required
        - `estimated_num_rows` integer, nullable, required
      - `configs` ConfigSize[], required
        - `dataset` string, required
        - `config` string, required
        - `num_bytes_original_files` integer
        - `num_bytes_parquet_files` integer, required
        - `num_bytes_memory` integer, required
        - `num_rows` integer, required
        - `num_columns` integer, required
        - `estimated_num_rows` integer, nullable, required
      - `splits` SplitSize[], required
        - `dataset` string, required
        - `config` string, required
        - `split` string, required
        - `num_bytes_parquet_files` integer, required
        - `num_bytes_memory` integer, required
        - `num_rows` integer, required
        - `num_columns` integer, required
        - `estimated_num_rows` integer, nullable, required
    - `pending` Job[], required
      - `dataset` string, required
      - `kind` string, required
      - `config` string, required
      - `split` string, nullable, required
    - `failed` Job[], required
      - `dataset` string, required
      - `kind` string, required
      - `config` string, required
      - `split` string, nullable, required
    - `partial` boolean, required — True means that the response has been computed on part of the dataset (typically the first 5GB). False means that the complete dataset was used.
  - ConfigSizeResponse
    - `size` object, required
      - `config` ConfigSize, required
        - `dataset` string, required
        - `config` string, required
        - `num_bytes_original_files` integer
        - `num_bytes_parquet_files` integer, required
        - `num_bytes_memory` integer, required
        - `num_rows` integer, required
        - `num_columns` integer, required
        - `estimated_num_rows` integer, nullable, required
      - `splits` SplitSize[], required
        - `dataset` string, required
        - `config` string, required
        - `split` string, required
        - `num_bytes_parquet_files` integer, required
        - `num_bytes_memory` integer, required
        - `num_rows` integer, required
        - `num_columns` integer, required
        - `estimated_num_rows` integer, nullable, required
    - `partial` boolean, required — True means that the response has been computed on part of the dataset (typically the first 5GB). False means that the complete dataset was used.

## Other responses

- `401` — If the external authentication step on the Hugging Face Hub failed, and no authentication mechanism has been provided. Retry with authentication.
- `404` — If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access.
- `422` — The 'dataset' parameter has not been provided or is invalid.
- `500` — The server crashed, the response still hasn't been generated (the process is asynchronous), or the response couldn't be generated successfully due to an error in the dataset itself. The client can retry after a time, in particular in the case of the response still being processed. If the error does not vanish, it's possibly due to a bug in the API software or in the dataset, and should be reported.
- `501` — The server does not implement the feature.

---

[API](https://skmtc.net/huggingface/apis/dataset-viewer-server-api.md) · [All operations](https://skmtc.net/huggingface/apis/dataset-viewer-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/huggingface/dataset-viewer-server-api/versions/5048b8c0f4f9/schema)