Search alleles
pgx_search_allelesInspect CPIC allele function, evidence, definition metadata and complete population frequencies for geneSymbol. Name matches literally first, then a matching gene prefix before a star allele may be removed; clinicalFunctionalStatus matches literal text case-insensitively. Discover genes with pgx_list_reference. Definitions are metadata, not variant interpretation. Frequencies are source fractions; inferred frequencies are not observations and do not establish individual risk. Pages have a 24,000-byte complete-result soft budget; an indivisible exception sets oversizedRow. Continue with page.nextOffset.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Exact source allele name; blank means unset. | |
| limit | No | Positive safe-integer row limit; values above 100 are clamped to 100 with a notice (default 25). | |
| offset | No | Zero-based offset; use nextOffset to continue (default 0). | |
| geneSymbol | Yes | Gene symbol, such as CYP2C19 or HLA-B; outer whitespace is ignored. | |
| clinicalFunctionalStatus | No | Case-insensitive literal source clinical functional status; blank means unset. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | Effective public page limit. | |
| page | No | Source pagination metadata. | |
| error | No | Present when the call failed. Absent on success. | |
| items | No | Source alleles, embedded definitions and population frequencies. | |
| shown | No | Number of returned rows, equal to page.returned. | |
| notices | No | Notices about this result; empty when none apply. | |
| truncated | No | Whether more matching rows remain after this page. | |
| provenance | No | Live source attribution and retrieval details. | |
| oversizedRow | No | Whether one complete indivisible row exceeds the soft byte budget. | |
| effectiveQuery | No | Effective allele selectors and page bounds. |