Get Gene Group
get_gene_groupRead-onlyIdempotent
Retrieve a HGNC gene group or family by numeric ID or name. Returns member genes in symbol‑ordered summaries with pagination support.
Instructions
Browse a HGNC gene group/family by numeric group id (e.g. '1157') or by name (e.g. 'RAF family'). Returns the member genes as symbol-ordered summaries. Members are paginated with limit + offset; the response carries member_count, returned, truncated, and next_offset, and (when truncated) a next_commands entry that fetches the next page. A name matching several groups returns the candidate groups so you can re-call with a specific id. Signature: get_gene_group(group, limit=, offset=, response_mode=).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group | Yes | Gene group id (numeric) or group name. | |
| limit | No | Max members (default 200). | |
| offset | No | Skip this many members for pagination (default 0). | |
| response_mode | No | Verbosity: minimal | compact | standard | full (default compact). | compact |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| _meta | No | ||
| field | No | ||
| limit | No | ||
| score | No | ||
| offset | No | ||
| matches | No | ||
| members | No | ||
| message | No | ||
| success | No | ||
| group_id | No | ||
| obsolete | No | ||
| returned | No | ||
| ambiguous | No | ||
| retryable | No | ||
| truncated | No | ||
| candidates | No | ||
| error_code | No | ||
| group_name | No | ||
| match_count | No | ||
| next_offset | No | ||
| replaced_by | No | ||
| member_count | No | ||
| allowed_values | No | ||
| recovery_action | No |