NCncats
Genome

Get a genome data package by genome assembly accession

Changed on

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

get/genome/accession/{accessions}/download

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.

hydrated'FULLY_HYDRATED' | 'DATA_REPORT_ONLY'

Specify whether to download a hydrated (with sequence and annotation files included) or dehydrated data package. A dehydrated data package includes the assembly data report and fetch.txt, which includes paths to the requested data files on NCBI servers.

filenamestring

Output file name.

Response

A successful response

Changes

  • e5d4400c8e5dRevision changes
    • info

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

  • 6b24249801ecRevision changes
    • breaking

      for the query request parameter hydrated, default value FULLY_HYDRATED was added

    • breaking

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