GET /virus/taxon/{taxon}/genome/download
Summary: Get a virus genome data package by taxon
Operation ID: virus_genome_download
Auth: unknown
Operation ID: virus_genome_download
Auth: unknown
Description
Download a virus genome data package including sequence, annotation, BioSample data and a detailed data report by taxon.
Parameters (14)
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 specified 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 from the specified Pango lineage.
refseq_only
(boolean, query, optional, default: False)
If true, limit results to RefSeq genomes.
released_since
(string, query, optional)
taxon
(string, path, required)
NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank
updated_since
(string, query, optional)
usa_state
(string, query, optional)
Limit to genomes collected from the specified U.S. state (two-letter abbreviation).
use_psg
(boolean, query, optional)
Experimental approach to retrieving sequence data.
Examples (1)
| Title | Type | URL | Action |
|---|---|---|---|
| Get a virus genome data package by taxon | openapi-spec |
https://api.ncbi.nlm.nih.gov/datasets/v2/virus/taxon/1335626/genome/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=['GENOME', 'CDS', 'PROTEIN']&aux_report=BIOSAMPLE |
Probe History
Status Codes
| Time | Status | Latency | Size |
|---|---|---|---|
| 2026-03-23 10:36:49.817863 | 400 | 337ms |