---
title: "Get a virus annotation report by taxon"
method: GET
path: "/virus/taxon/{taxon}/annotation_report"
tags: ["Virus"]
---

# Get a virus annotation report by taxon

`GET /virus/taxon/{taxon}/annotation_report`

## Request

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

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.

## Path parameters

- `taxon` string, required

## Query parameters

- `filter.refseq_only` boolean
- `filter.annotated_only` boolean
- `filter.released_since` string, date-time
- `filter.updated_since` string, date-time
- `filter.host` string
- `filter.pangolin_classification` string
- `filter.geo_location` string
- `filter.usa_state` string
- `filter.complete_only` boolean
- `table_fields` string[]
- `page_size` integer
- `page_token` string

## Response `200`

A successful response

- V2reportsVirusAnnotationReportPage
  - `reports` V2reportsVirusAnnotationReport[]
    - `accession` string
    - `isolate_name` string
    - `genes` V2reportsVirusGene[]
      - `name` string
      - `gene_id` integer
      - `nucleotide` V2reportsSeqRangeSetFasta
        - `seq_id` string
        - `accession_version` string
        - `title` string
        - `sequence_hash` string
        - `range` V2reportsRange[]
          - `begin` string, uint64
          - `end` string, uint64
          - `orientation` 'none' | 'plus' | 'minus'
          - `order` integer
          - `ribosomal_slippage` integer
      - `cds` V2reportsVirusPeptide[]
        - `accession` string
        - `name` string
        - `other_names` string[]
        - `nucleotide` V2reportsSeqRangeSetFasta
          - `seq_id` string
          - `accession_version` string
          - `title` string
          - `sequence_hash` string
          - `range` V2reportsRange[]
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
        - `protein` V2reportsSeqRangeSetFasta
          - `seq_id` string
          - `accession_version` string
          - `title` string
          - `sequence_hash` string
          - `range` V2reportsRange[]
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
        - `pdb_ids` string[]
        - `cdd` V2reportsConservedDomain[]
          - `accession` string
          - `name` string
          - `range` V2reportsRange
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
        - `uni_prot_kb` V2reportsVirusPeptideUniProtId
          - `id` string
          - `name` string
        - `mature_peptide` V2reportsVirusPeptide[]
        - `protein_completeness` 'UNKNOWN' | 'COMPLETE' | 'PARTIAL'
  - `total_count` integer
  - `next_page_token` string

## Other responses

- `default`: An unexpected error response.

## Changes

- **2025-05-08** `6b24249801ec`: 10 info
  - the `orientation` response's property default value `none` was added for the status `200` (media type: application/json)
  - the `orientation` response's property default value `none` was added for the status `200` (media type: application/json)
  - the `orientation` response's property default value `none` was added for the status `200` (media type: application/json)
  - the `orientation` response's property default value `none` was added for the status `200` (media type: application/json)
  - …6 more
- **2025-04-28** `f08be9b66e16`: 10 info
  - the `orientation` response's property default value `none` was removed for the status `200` (media type: application/json)
  - the `orientation` response's property default value `none` was removed for the status `200` (media type: application/json)
  - the `orientation` response's property default value `none` was removed for the status `200` (media type: application/json)
  - the `orientation` response's property default value `none` was removed for the status `200` (media type: application/json)
  - …6 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/ncats/apis/ncbi-datasets-api/changes/virus/taxon/:taxon/annotation_report/get.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)