v1

latestOpenAPI 3.0.12026-08-06107337528.9 KB

Gene

Get gene metadata by gene symbol

Get a gene summary by by gene symbol. By default, in paged JSON format, but also available as tabular (accept: text/tab-separated-values) or json-lines (accept: application/x-ndjson)

get/gene/symbol/{symbols}/taxon/{taxon}

Path parameters

symbolsstring[] required

One or more gene symbols

taxonstring required

NCBI Taxonomy ID or name (common or scientific, any taxonomic rank) for the provided gene symbol

Query parameters

returned_content'COMPLETE' | 'IDS_ONLY' | 'COUNTS_ONLY'

Return complete gene reports, or abbreviated reports with either GeneIDs only or GeneIDs, transcript and protein counts.

locus_tagsstring[]

Gene locus tags

table_fieldsstring[]

Specify which fields to include in the tabular report. Additional fields are described here: Create a table from the gene data reports. Use of this parameter requires the HTTP header, accept: text/tab-separated-values.

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_sizeinteger

The maximum number of gene reports 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.

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.

accession_filterstring[]

Filter tabular product report to only include the selected accessions. Use of this parameter requires the HTTP header, accept: text/tab-separated-values.

tax_search_subtreeboolean

If true, include genes from taxonomic ranks below the requested taxon.

sort.fieldstring

sort.direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASCENDING' | 'SORT_DIRECTION_DESCENDING'

Response

A successful response

total_countinteger

next_page_tokenstring