Skip to main content
POST
Describe a gene from its NCBI Gene ID or its official symbol: the symbol, the full name, the aliases and other names, the organism, the chromosome and cytogenetic band, the position on the current assembly with the strand, the exon count, the curated summary of its function with the note saying who wrote it, and the OMIM ids. Give exactly one of gene_id and symbol; taxon_id picks the organism for a symbol search and is human (9606) unless set. A symbol is matched without regard to case in the organism; when several genes carry it, the first is described and the rest are listed in other_gene_ids. status says whether the record is live, replaced (then current_gene_id names the record to use) or discontinued. gene is null when no gene has the id or the symbol. Covers every organism with genes in the US National Center for Biotechnology Information’s Gene database. Coordinates are zero-based, as the source gives them.

Authentication

Requires x402 payment in the payment-signature header.

Request Body

string
An NCBI Gene ID, digits only, for example 7157. Digits only, 1 to 12.
string
An official gene symbol, for example TP53, matched without regard to case in the organism taxon_id names. 1 to 30 characters. No spaces, quotes or square brackets.
integer
The organism as an NCBI Taxonomy ID, used with symbol; 9606 (human) unless set, 10090 is mouse. From 1 to 999999999. Defaults to 9606.

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_summary
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
The gene described; null when no gene has the id or the symbol.
string
The NCBI Gene ID.
string
The gene symbol. null when the source gives no value.
string
The full name. null when the source gives no value.
string
live, replaced or discontinued.
string
The Gene ID that replaced this record; null unless status is replaced.
string[]
Other symbols the gene is known by.
string[]
Other names the gene or its product is known by.
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.
object
The position on the current assembly; null when the source places the gene nowhere.
string
The assembly the position is on, for example GCF_000001405.40. null when the source gives no value.
string
The chromosome sequence the position is on, for example NC_000017.11. null when the source gives no value.
number
The smaller coordinate, zero-based. null when the source gives no value.
number
The larger coordinate, zero-based. null when the source gives no value.
string
The strand: + or -. null when the source gives no value.
number
How many exons the source counts. null when the source gives no value.
string
The curated summary of the gene’s function. null when the source gives no value.
string
Who wrote the summary and when, for example “provided by RefSeq, Dec 2016”. null when the source gives no value.
string[]
The gene’s OMIM ids.
string[]
The other Gene IDs a symbol search found, after the one described; empty otherwise.
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}