NCncats
Genome

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

Changed on

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

get/genome/accession/{accessions}/download_summary

Request

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

Path parameters

accessionsstring[] required

One or more genome assembly accessions, limited to 100

Query parameters

chromosomesstring[]

Only return genomic fasta sequence for the specified chromosomes.

include_annotation_typeV2AnnotationForAssemblyType[]

Specify which sequence, annotation, and report files to include in the data package. The assembly data report is always included, and its inclusion is not affected by this parameter.

Response

A successful response

record_countinteger
assembly_countinteger
resource_updated_onstring date-time

Changes

  • e5d4400c8e5dRevision changes
    • 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

      removed the enum value GENOME_GB from the property items/ of the query request parameter include_annotation_type

    • 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