NCncats
Genome

Get a genome sequence report by genome assembly accession

Changed on

Get a genome sequence report by genome assembly accession. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.

get/genome/accession/{accession}/sequence_reports

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

chromosomesstring[]

Limit to sequences with the specified chromosome names

role_filtersstring[]

Limit to sequences with the specified "role", where possible roles are assembled-molecule, unlocalized-scaffold, or unplaced-scaffold

table_fieldsstring[]
count_assembly_unplacedboolean

Include the count of unplaced scaffold sequences

page_sizeinteger

The maximum number of genome assemblies to return. Maximum is 1000. If the number of results exceeds the page size, page_token can be used to retrieve the remaining results.

page_tokenstring

A page token is returned when the results count exceeds page size. Use this token along with previous request parameters to retrieve the next page of results. When page_token is empty, all results have been retrieved.

include_tabular_header'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'

Response

A successful response

total_countinteger
next_page_tokenstring

Changes

  • e5d4400c8e5dRevision changes
    • breaking

      for the query request parameter page_size, default value 20 was removed

  • 6b24249801ecRevision changes
    • breaking

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