v1

latestOpenAPI 3.0.12026-08-06107337528.9 KB
Genome

Get genome annotation reports by genome assembly accession

Get genome annotation reports by genome assembly accession, where each report represents a single feature annotated on the genome. 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}/annotation_report

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'
page_sizeinteger

The maximum number of features to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, page_token can be used to retrieve the remaining results.

table_format'NO_TABLE' | 'SUMMARY' | 'PRODUCT'

Optional pre-defined template for processing a tabular data request

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

Specify when to include the table header when requesting a tabular report.

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.

Response

A successful response

total_countinteger
next_page_tokenstring