NCncats
Genome

Get a download summary (preview) of a genome annotation data package by genome assembly accession

Changed on

Get a downlaod summary (preview) of a genome annotation data package, including counts and file sizes, in JSON format.

get/genome/accession/{accession}/annotation_report/download_summary

Request

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

Path parameters

accessionstring required

A single genome assembly accession

Query parameters

annotation_idsstring[]

Limit to one or more features annotated on the genome by specifying a number corresponding to a row_id (unstable).

symbolsstring[]

Limit to annotated features matching the given gene symbol (case-sensitive).

locationsstring[]

Limit to features annotated at a specific location on the genome, by specifying a chromosome name or accession and optional start-stop range.

gene_typesstring[]

Limit to features of a specified gene locus type.

search_textstring[]

Limit to features that match the specified gene symbol, gene name or protein name.

sort.fieldstring
sort.direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASCENDING' | 'SORT_DIRECTION_DESCENDING'
include_annotation_typeV2GenomeAnnotationRequestAnnotationType[]

Specify which sequence files to include in the data package. Options include gene (GENOME_FASTA), transcript (RNA_FASTA), and protein (PROT_FASTA) sequences.

Response

A successful response

record_countinteger
assembly_countinteger
resource_updated_onstring date-time

Changes

  • e5d4400c8e5dRevision changes
    • warning

      deleted the query request parameter include_tabular_header

    • warning

      deleted the query request parameter table_fields

    • warning

      deleted the query request parameter table_format

    • info

      added the enum value DEFAULT to the property items/ of the query request parameter include_annotation_type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

  • 6b24249801ecRevision changes
    • breaking

      for the query request parameter include_tabular_header, default value INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY was added

    • breaking

      for the query request parameter sort.direction, default value SORT_DIRECTION_UNSPECIFIED was added

    • breaking

      for the query request parameter table_format, default value NO_TABLE was added

    • info

      the response's property default value UNKNOWN_ASSEMBLY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ASSEMBLY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_WARNING_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ORGANELLE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ORGANELLE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_TAXONOMY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_TAXONOMY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_VIRUS_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_VIRUS_ERROR_CODE was added for the status