Get Gene Record
get_geneRead-onlyIdempotent
Retrieve the complete HGNC record for any gene using an HGNC ID, current or previous symbol, or alias. Includes name, status, location, cross-references, and more.
Instructions
Return the full HGNC record for a gene, resolved from an HGNC id, current symbol, previous symbol, or alias. Includes name, status, locus group/type, location, aliases/previous symbols, gene groups, and all cross-references. response_mode controls verbosity (compact drops dates/provenance; minimal keeps identity + anchor ids). Signature: get_gene(query, response_mode=).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | A gene symbol (current/previous/alias, case-insensitive) or HGNC id (HGNC:1100 or 1100). | |
| response_mode | No | Verbosity: minimal | compact | standard | full (default compact). | compact |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| name | No | ||
| _meta | No | ||
| field | No | ||
| status | No | ||
| symbol | No | ||
| hgnc_id | No | ||
| message | No | ||
| omim_id | No | ||
| success | No | ||
| location | No | ||
| obsolete | No | ||
| entrez_id | No | ||
| retryable | No | ||
| candidates | No | ||
| error_code | No | ||
| gene_group | No | ||
| locus_type | No | ||
| match_type | No | ||
| locus_group | No | ||
| mane_select | No | ||
| prev_symbol | No | ||
| replaced_by | No | ||
| uniprot_ids | No | ||
| alias_symbol | No | ||
| gene_group_id | No | ||
| allowed_values | No | ||
| ensembl_gene_id | No | ||
| recovery_action | No | ||
| requested_query | No | ||
| refseq_accession | No |