---
title: "Get genome annotation reports by genome assembly accession"
method: POST
path: "/genome/annotation_report"
tags: ["Genome"]
---

# Get genome annotation reports by genome assembly accession

`POST /genome/annotation_report`

Get genome annotation reports by genome assembly accession, where each report represents a single feature annotated on the genome. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.

## Request body

- V2GenomeAnnotationRequest
  - `accession` string
  - `annotation_ids` string[]
  - `symbols` string[]
  - `locations` string[]
  - `gene_types` string[]
  - `search_text` string[]
  - `sort` V2SortField[]
    - `field` string
    - `direction` 'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASCENDING' | 'SORT_DIRECTION_DESCENDING'
  - `include_annotation_type` V2GenomeAnnotationRequestAnnotationType[]
  - `page_size` integer
  - `table_fields` string[]
  - `table_format` 'NO_TABLE' | 'SUMMARY' | 'PRODUCT'
  - `include_tabular_header` 'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'
  - `page_token` string

## Response `200`

A successful response

- V2reportsGenomeAnnotationReportPage
  - `reports` V2reportsGenomeAnnotationReportMatch[]
    - `annotation` V2reportsGenomeAnnotation
      - `gene_id` string, uint64
      - `symbol` string
      - `description` string
      - `name` string
      - `tax_id` string, uint64
      - `taxname` string
      - `common_name` string
      - `type` 'UNKNOWN' | 'tRNA' | 'rRNA' | 'snRNA' | 'scRNA' | 'snoRNA' | 'PROTEIN_CODING' | 'PSEUDO' | 'TRANSPOSON' | 'miscRNA' | 'ncRNA' | 'BIOLOGICAL_REGION' | 'OTHER'
      - `gene_type` string
      - `rna_type` 'rna_UNKNOWN' | 'premsg' | 'tmRna'
      - `orientation` 'none' | 'plus' | 'minus'
      - `locus_tag` string
      - `reference_standards` V2reportsGenomicRegion[]
        - `gene_range` V2reportsSeqRangeSet
          - `accession_version` string
          - `range` V2reportsRange[]
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
        - `type` 'UNKNOWN' | 'REFSEQ_GENE' | 'PSEUDOGENE' | 'BIOLOGICAL_REGION' | 'OTHER'
      - `genomic_regions` V2reportsGenomicRegion[]
        - `gene_range` V2reportsSeqRangeSet
          - `accession_version` string
          - `range` V2reportsRange[]
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
        - `type` 'UNKNOWN' | 'REFSEQ_GENE' | 'PSEUDOGENE' | 'BIOLOGICAL_REGION' | 'OTHER'
      - `transcripts` V2reportsTranscript[]
        - `accession_version` string
        - `name` string
        - `length` integer
        - `cds` V2reportsSeqRangeSet
          - `accession_version` string
          - `range` V2reportsRange[]
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
        - `genomic_locations` V2reportsGenomicLocation[]
          - `genomic_accession_version` string
          - `sequence_name` string
          - `genomic_range` V2reportsRange
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
          - `exons` V2reportsRange[]
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
        - `ensembl_transcript` string
        - `protein` V2reportsProtein
          - `accession_version` string
          - `name` string
          - `length` integer
          - `isoform_name` string
          - `ensembl_protein` string
          - `mature_peptides` V2reportsMaturePeptide[]
            - `accession_version` string
            - `name` string
            - `length` integer
        - `type` 'UNKNOWN' | 'PROTEIN_CODING' | 'NON_CODING' | 'PROTEIN_CODING_MODEL' | 'NON_CODING_MODEL'
        - `select_category` 'SELECT_UNKNOWN' | 'REFSEQ_SELECT' | 'MANE_SELECT' | 'MANE_PLUS_CLINICAL'
      - `proteins` V2reportsProtein[]
        - `accession_version` string
        - `name` string
        - `length` integer
        - `isoform_name` string
        - `ensembl_protein` string
        - `mature_peptides` V2reportsMaturePeptide[]
          - `accession_version` string
          - `name` string
          - `length` integer
      - `chromosomes` string[]
      - `swiss_prot_accessions` string[]
      - `ensembl_gene_ids` string[]
      - `omim_ids` string[]
      - `synonyms` string[]
      - `annotations` V2reportsAnnotation[]
        - `assembly_accession` string
        - `assembly_name` string
        - `annotation_name` string
        - `annotation_release_date` string
        - `genomic_locations` V2reportsGenomicLocation[]
          - `genomic_accession_version` string
          - `sequence_name` string
          - `genomic_range` V2reportsRange
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
          - `exons` V2reportsRange[]
            - `begin` string, uint64
            - `end` string, uint64
            - `orientation` 'none' | 'plus' | 'minus'
            - `order` integer
            - `ribosomal_slippage` integer
    - `query` 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
    - `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[]
    - `row_id` 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
  - `total_count` integer
  - `next_page_token` string

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/ncats/apis/ncbi-datasets-api.md) · [All operations](https://skmtc.net/ncats/apis/ncbi-datasets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ncats/ncbi-datasets-api/revisions/e5d4400c8e5d/schema)