GET /virus/taxon/sars2/protein/{proteins}/download
Summary: Get a SARS-CoV-2 protein data package by protein name
Operation ID: sars2_protein_download
Auth: unknown
Operation ID: sars2_protein_download
Auth: unknown
Description
Download a SARS-CoV-2 protein data package including sequence, annotation, BioSample data and a detailed data report by protein name.
Parameters (13)
annotated_only
(boolean, query, optional, default: False)
If true, limit results to annotated genomes.
aux_report
(array, query, optional)
Specify which report files to include in the data package. The virus data report is always included, and its inclusion is not affected by this parameter.
complete_only
(boolean, query, optional, default: False)
Limit to genomes designated as complete, as defined by the submitter.
filename
(string, query, optional, default: ncbi_dataset.zip)
Output file name.
geo_location
(string, query, optional)
Limit to genomes collected from the specififed geographic location.
host
(string, query, optional)
Limit to genomes isolated from the specified host species (NCBI Taxonomy ID, common or scientific name).
include_sequence
(array, query, optional)
Specify which sequence files to include in the data package.
pangolin_classification
(string, query, optional)
Limit to SARS-CoV-2 genomes with the specified Pango lineage.
proteins
(array, path, required)
One or more SARS-CoV-2 protein names
refseq_only
(boolean, query, optional, default: False)
If true, limit results to RefSeq genomes.
released_since
(string, query, optional)
updated_since
(string, query, optional)
usa_state
(string, query, optional)
Limit to genomes collected from the specified U.S. state (two-letter abbreviation).
Examples (1)
| Title | Type | URL | Action |
|---|---|---|---|
| Get a SARS-CoV-2 protein data package by protein name | openapi-spec |
https://api.ncbi.nlm.nih.gov/datasets/v2/virus/taxon/sars2/protein/spike protein/download?refseq_only=True&annotated_only=True&released_since=2025-01-15&updated_since=2025-01-15&host=9606&pangolin_classification=LP.8.1&geo_location=USA&usa_state=CA&complete_only=True&include_sequence=['CDS', 'PROTEIN']&aux_report=ANNOTATION |
Probe History
Status Codes
| Time | Status | Latency | Size |
|---|---|---|---|
| 2026-03-23 10:16:20.833712 | 400 | 337ms |