NCncats
Genome

Get genome annotation report summary information by genome assembly accession

Changed on

Get genome annotation report summary information by genome assembly accession in JSON format, including chromosome names and gene types.

post/genome/annotation_summary

Request

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

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

accessionstring
chromosomesstring[]
gene_typesstring[]
empty_columnsstring[]

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