GET /virus/taxon/{taxon}/annotation_report
Summary: Get a virus annotation report by taxon
Operation ID: virus_annotation_reports_by_taxon
Auth: unknown
Operation ID: virus_annotation_reports_by_taxon
Auth: unknown
Description
Get virus annotation report by taxon. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.
Parameters (13)
filter.annotated_only
(boolean, query, optional, default: False)
If true, limit to annotated genomes.
filter.complete_only
(boolean, query, optional, default: False)
Limit to genomes designated as complete, as defined by the submitter.
filter.geo_location
(string, query, optional)
Limit to genomes collected from the specififed geographic location.
filter.host
(string, query, optional)
Limit to genomes isolated from the specified host species (NCBI Taxonomy ID, common or scientific name).
filter.pangolin_classification
(string, query, optional)
Limit to SARS-CoV-2 genomes from the specified Pango lineage.
filter.refseq_only
(boolean, query, optional, default: False)
If true, limit to RefSeq genomes.
filter.released_since
(string, query, optional)
filter.updated_since
(string, query, optional)
filter.usa_state
(string, query, optional)
Limit to genomes collected from the specified U.S. state (two-letter abbreviation).
page_size
(integer, query, optional, default: 20)
The maximum number of virus data reports to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
page_token
(string, query, optional)
A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
table_fields
(array, query, optional)
Specify which fields to include in the tabular report. Additional fields are described here: [virus annotation report fields](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/command-line-tools/using-dataformat/virus-data-reports/#virus-annotation-report-fields). Use of this parameter requires the HTTP header, `accept: text/tab-separated-values`.
taxon
(string, path, required)
NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank
Examples (1)
| Title | Type | URL | Action |
|---|---|---|---|
| Get a virus annotation report by taxon | openapi-spec |
https://api.ncbi.nlm.nih.gov/datasets/v2/virus/taxon/1335626/annotation_report?filter.refseq_only=True&filter.annotated_only=True&filter.released_since=2025-01-15&filter.updated_since=2025-01-15&filter.host=9606&filter.pangolin_classification=LP.8.1&filter.geo_location=USA&filter.usa_state=CA&filter.complete_only=True&table_fields=['accession', 'gene-cds-name', 'gene-cds-nuc-fasta-range-start', 'gene-cds-nuc-fasta-range-stop'] |
Probe History
Status Codes
| Time | Status | Latency | Size |
|---|---|---|---|
| 2026-03-23 09:00:17.957293 | 200 | 459ms |