Resolve Gene Symbol
resolve_symbolResolve any gene symbol or HGNC ID to its canonical HGNC record, returning the approved symbol and match type.
Instructions
Resolve any gene symbol or HGNC id to its canonical record. Accepts a current symbol, a previous (withdrawn) symbol, an alias, or an HGNC id in either form (HGNC:1100 or 1100), case-insensitively. Returns {hgnc_id, approved_symbol, match_type (hgnc_id|current|previous|alias)}. An alias shared by several genes returns an ambiguous_query error with the candidate list (not silently picked); a withdrawn/merged symbol returns a not_found error that redirects to the successor record. Signature: resolve_symbol(query, 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). | |
| response_mode | No | Verbosity: minimal | compact | standard | full (default compact). | compact |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| name | No | ||
| note | No | ||
| _meta | No | ||
| field | No | ||
| query | No | ||
| status | No | ||
| hgnc_id | No | ||
| message | No | ||
| success | No | ||
| location | No | ||
| obsolete | No | ||
| ambiguous | No | ||
| retryable | No | ||
| candidates | No | ||
| error_code | No | ||
| locus_type | No | ||
| match_type | No | ||
| replaced_by | No | ||
| other_matches | No | ||
| allowed_values | No | ||
| approved_symbol | No | ||
| candidate_count | No | ||
| recovery_action | No |