---
title: "Get a download summary of a SARS-CoV-2 protein data package by protein name"
method: POST
path: "/virus/taxon/sars2/protein"
tags: ["Virus"]
---

# Get a download summary of a SARS-CoV-2 protein data package by protein name

`POST /virus/taxon/sars2/protein`

## Request

- Base URL: `https://api.ncbi.nlm.nih.gov/datasets/v2`
- URL: `https://api.ncbi.nlm.nih.gov/datasets/v2/virus/taxon/sars2/protein`
- Auth: API key in header `api-key`

Get a download summary of a SARS-CoV-2 protein data package, including counts and file sizes, in JSON format.

## Request body

- V2Sars2ProteinDatasetRequest
  - `proteins` string[]
  - `refseq_only` boolean
  - `annotated_only` boolean
  - `released_since` string, date-time
  - `updated_since` string, date-time
  - `host` string
  - `pangolin_classification` string
  - `geo_location` string
  - `usa_state` string
  - `complete_only` boolean
  - `table_fields` V2VirusTableField[]
  - `include_sequence` V2ViralSequenceType[]
  - `aux_report` V2VirusDatasetReportType[]
  - `format` 'tsv' | 'csv' | 'jsonl'

## Response `200`

A successful response

- V2DownloadSummary
  - `record_count` integer
  - `assembly_count` integer
  - `resource_updated_on` string, date-time
  - `hydrated` V2DownloadSummaryHydrated
    - `estimated_file_size_mb` integer
    - `url` string
    - `cli_download_command_line` string
  - `dehydrated` V2DownloadSummaryDehydrated
    - `estimated_file_size_mb` integer
    - `url` string
    - `cli_download_command_line` string
    - `cli_rehydrate_command_line` string
  - `errors` V2reportsError[]
    - `assembly_error_code` 'UNKNOWN_ASSEMBLY_ERROR_CODE' | 'INVALID_BIOPROJECT_IDS' | 'NO_ASSEMBLIES_FOR_BIOPROJECTS' | 'INVALID_TAXON' | 'MISSING_SEARCH_FIELD' | 'INVALID_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_ASSEMBLY_NAMES' | 'INVALID_WGS_ACCESSIONS' | 'NO_ASSEMBLIES_FOR_WGS_ACCESSIONS'
    - `gene_error_code` 'UNKNOWN_GENE_ERROR_CODE' | 'INCOMPLETE_LOOKUP_SYMBOL' | 'INVALID_TAXON_GENE_ARGUMENT'
    - `organelle_error_code` 'UNKNOWN_ORGANELLE_ERROR_CODE' | 'INVALID_ORGANELLE_TAXON' | 'NO_ORGANELLES_FOR_ACCESSION'
    - `virus_error_code` 'UNKNOWN_VIRUS_ERROR_CODE'
    - `taxonomy_error_code` 'UNKNOWN_TAXONOMY_ERROR_CODE' | 'INVALID_TAXONOMY_TAXON'
    - `sequence_error_code` 'UNKNOWN_SEQUENCE_ERROR_CODE' | 'INVALID_SEQUENCE_ACCESSION'
    - `reason` string
    - `message` string
    - `invalid_identifiers` string[]
  - `messages` V2reportsMessage[]
    - `error` V2reportsError
      - `assembly_error_code` 'UNKNOWN_ASSEMBLY_ERROR_CODE' | 'INVALID_BIOPROJECT_IDS' | 'NO_ASSEMBLIES_FOR_BIOPROJECTS' | 'INVALID_TAXON' | 'MISSING_SEARCH_FIELD' | 'INVALID_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_ASSEMBLY_NAMES' | 'INVALID_WGS_ACCESSIONS' | 'NO_ASSEMBLIES_FOR_WGS_ACCESSIONS'
      - `gene_error_code` 'UNKNOWN_GENE_ERROR_CODE' | 'INCOMPLETE_LOOKUP_SYMBOL' | 'INVALID_TAXON_GENE_ARGUMENT'
      - `organelle_error_code` 'UNKNOWN_ORGANELLE_ERROR_CODE' | 'INVALID_ORGANELLE_TAXON' | 'NO_ORGANELLES_FOR_ACCESSION'
      - `virus_error_code` 'UNKNOWN_VIRUS_ERROR_CODE'
      - `taxonomy_error_code` 'UNKNOWN_TAXONOMY_ERROR_CODE' | 'INVALID_TAXONOMY_TAXON'
      - `sequence_error_code` 'UNKNOWN_SEQUENCE_ERROR_CODE' | 'INVALID_SEQUENCE_ACCESSION'
      - `reason` string
      - `message` string
      - `invalid_identifiers` string[]
    - `warning` V2reportsWarning
      - `gene_warning_code` 'UNKNOWN_GENE_WARNING_CODE' | 'ACCESSION_VERSION_MISMATCH' | 'REPLACED_GENE_ID' | 'DISCONTINUED_GENE_ID' | 'UNRECOGNIZED_GENE_ID' | 'UNRECOGNIZED_GENE_SYMBOL' | 'UNRECOGNIZED_ACCESSION' | 'UNRECOGNIZED_TAX_TOKEN' | 'NO_GENE_ANNOTATION_FOUND' | 'ABOVE_SPECIES_TAXON'
      - `reason` string
      - `message` string
      - `replaced_id` V2reportsWarningReplacedId
        - `requested` string
        - `returned` string
      - `unrecognized_identifier` string
  - `available_files` V2DownloadSummaryAvailableFiles
    - `all_genomic_fasta` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `genome_gff` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `genome_gbff` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `rna_fasta` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `prot_fasta` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `genome_gtf` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `cds_fasta` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `sequence_report` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `annotation_report` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-08-06** `e5d4400c8e5d`: 1 breaking, 2 info
  - removed the enum value `BIOSAMPLE` of the request property `include_sequence/items/`
  - added the optional property `errors/items/sequence_error_code` to the response with the `200` status
  - added the optional property `messages/items/error/sequence_error_code` to the response with the `200` status
- **2025-05-08** `6b24249801ec`: 15 info
  - the `` request property default value `DATASET_REPORT` was added
  - the `` request property default value `GENOME` was added
  - the `` request property default value `unspecified` was added
  - the `format` request property default value `tsv` was added
  - …11 more
- **2025-04-28** `f08be9b66e16`: 15 info
  - the `` request property default value `DATASET_REPORT` was removed
  - the `` request property default value `GENOME` was removed
  - the `` request property default value `unspecified` was removed
  - the `format` request property default value `tsv` was removed
  - …11 more
- **2025-02-08** `00bdccfc6283`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ncats/apis/ncbi-datasets-api/changes/virus/taxon/sars2/protein/post.md)

---

[API](https://skmtc.dev/ncats/apis/ncbi-datasets-api.md) - [All operations](https://skmtc.dev/ncats/apis/ncbi-datasets-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ncats/apis/ncbi-datasets-api/revisions/b24db4bc7ca5?raw)