NCncats
Genome

Get a genome annotation data package by genome assembly accession

Changed on

Download an annotation data package including sequence and a detailed annotation report by genome assembly accession.

post/genome/annotation_report/download

Request

  • Base URL
    https://api.ncbi.nlm.nih.gov/datasets/v2
  • Auth
    API key in header api-key

Query parameters

filenamestring

Output file name.

Request body

accessionstring
annotation_idsstring[]
symbolsstring[]
locationsstring[]
gene_typesstring[]
search_textstring[]
include_annotation_typeV2GenomeAnnotationRequestAnnotationType[]
page_sizeinteger
table_fieldsstring[]
table_format'NO_TABLE' | 'SUMMARY' | 'PRODUCT'
include_tabular_header'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'
page_tokenstring

Response

A successful response

Changes

  • e5d4400c8e5dRevision changes
    • info

      added the new DEFAULT enum value to the request property /

  • 6b24249801ecRevision changes
    • info

      the request property default value DEFAULT was added

    • info

      the request property default value SORT_DIRECTION_UNSPECIFIED was added

    • info

      the request property default value INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY was added

    • info

      the request property default value NO_TABLE was added