Skip to main content
POST
Give query: an official gene symbol (TP53), an alias (P53, HER2) or an Ensembl gene ID (ENSG00000141510; a version suffix is dropped). Letters, digits, dots, dashes and _ only. taxon_id picks the organism and is human (9606) unless set. Returns the matching live genes, up to limit: genes whose official symbol is the query first, then genes that carry it as an alias, each in the source’s order, with the NCBI Gene ID (the input of Gene Summary), the symbol, the full name, the aliases, the nomenclature status, the organism, the chromosome, the cytogenetic band and the gene page link. matched_on says how each gene matched. A search hit that carries the query as neither its symbol nor an alias is dropped. ambiguous is true when more than one gene matched and none has the query as its official symbol. An unknown query returns an empty matches list. Replaced and discontinued Gene IDs are not returned. A query whose search finds more than 20 live records fails rather than returning a partial answer. Data from NCBI Gene at the US National Center for Biotechnology Information; official human symbols are assigned by the HUGO Gene Nomenclature Committee.

Authentication

Requires x402 payment in the payment-signature header.

Request Body

string
required
An official gene symbol (TP53), an alias (P53, HER2) or an Ensembl gene ID (ENSG00000141510, a version suffix is dropped). 1 to 40 characters. Letters, digits, dots, dashes and _ only, starting with a letter or digit.
integer
The organism as an NCBI Taxonomy ID; 9606 (human) unless set, 10090 is mouse. From 1 to 999999999. Defaults to 9606.
integer
The most matching genes to return. From 1 to 10. Defaults to 5.

Response (200 OK)

Top-level envelope: success (boolean) and data (object). All fields below are nested under data.
string
Durable job ID for audit and lookup
string
Job status: completed
string
Always gene_resolve
object
The answer, described under Result below
object
Where the answer came from and when
string
The public body the data comes from. Always US National Center for Biotechnology Information.
string
public when the data comes from a public body, commercial otherwise
string
When the lookup was made, as an ISO 8601 UTC time
string
When the source says the fact was last updated, or null when the source gives no date

Result

Nested under data.result.
object[]
Matching live genes, official symbol matches first, then alias matches, up to limit.
string
The NCBI Gene ID, the input of Gene Summary.
string
The gene symbol. null when the source gives no value.
string
The full name. null when the source gives no value.
string
symbol, alias or ensembl: how the gene matched the query.
string[]
Other symbols the gene is known by.
string
Whether the symbol is official or interim; null when the source gives neither.
object
The organism the gene belongs to.
string
The organism’s scientific name, for example Homo sapiens. null when the source gives no value.
string
The organism’s common name, for example human. null when the source gives no value.
number
The organism’s NCBI Taxonomy ID. null when the source gives no value.
string
The chromosome, for example 17. null when the source gives no value.
string
The cytogenetic band, for example 17p13.1. null when the source gives no value.
string
The gene page URL.
boolean
True when more than one gene matched and none has the query as its official symbol, before applying limit.
See Pricing for this tool’s price. A wallet (x402) call receives it in the 402 quote before anything is charged; a call paid from prepaid credits is charged when the API accepts the request and answers 200.

Notes

  • Results return inline. The finished job stays available at /v1/requests/{request_id}