v1

latestOpenAPI 3.0.12026-08-06107337528.9 KB
Gene

Get a gene data report for a gene ortholog set by GeneID

Get a gene data report for a gene ortholog set by GeneID in JSON format.

get/gene/id/{gene_id}/orthologs

Path parameters

gene_idinteger required

A single NCBI GeneID

Query parameters

returned_content'COMPLETE' | 'IDS_ONLY'

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

taxon_filterstring[]

Limit to genes from the specified NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank.

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.

Response

A successful response

total_countinteger
next_page_tokenstring