Get Gene Cross-References
get_gene_cross_referencesMaps a gene symbol or HGNC ID to external database cross-references including NCBI, Ensembl, UniProt, RefSeq, and OMIM. Supports filtering by database and response verbosity.
Instructions
Return external database cross-references for a gene (forward identifier mapping): NCBI Gene, Ensembl, UniProt, RefSeq, MANE Select, OMIM, UCSC, VEGA, CCDS, MGI, RGD, Orphanet, COSMIC, PubMed. response_mode sets the default field set: minimal=NCBI+Ensembl ids; compact (default)=the high-value ids (NCBI, Ensembl, UniProt, RefSeq, MANE Select, OMIM, CCDS); standard/full=every populated field. databases optionally filters to specific sources by field key OR friendly label (e.g. 'mane', 'ncbi', 'uniprot') and OVERRIDES the response_mode tier; an unknown key is rejected with invalid_input + did-you-mean. Resolve the gene from an id/symbol/alias first. Signature: get_gene_cross_references(query, databases=, response_mode=).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | A gene symbol (current/previous/alias, case-insensitive) or HGNC id (HGNC:1100 or 1100). | |
| databases | No | Optional database filter, e.g. ['ensembl','uniprot','omim']. | |
| response_mode | No | Verbosity: minimal | compact | standard | full (default compact). | compact |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| _meta | No | ||
| field | No | ||
| symbol | No | ||
| hgnc_id | No | ||
| message | No | ||
| success | No | ||
| obsolete | No | ||
| retryable | No | ||
| candidates | No | ||
| error_code | No | ||
| match_type | No | ||
| replaced_by | No | ||
| allowed_values | No | ||
| database_count | No | ||
| recovery_action | No | ||
| cross_references | No |