Get Variant Counts
get_variant_countsRead-onlyIdempotent
Retrieve per-position variant counts from gnomAD and/or ClinVar for a transcript, with optional range and source filtering.
Instructions
Return per-position gnomAD and/or ClinVar variant counts on a built landscape, filtered by source (both|gnomad|clinvar). Accepts a single position, a [position_start, position_stop] range, or the whole protein (paginated); when source includes clinvar each residue's ClinVar variants are listed with NCBI urls. Signature: get_variant_counts(transcript_id=, position=, position_start=, position_stop=, source=, response_mode=).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| transcript_id | Yes | A versioned Ensembl transcript id (the .N version suffix is required), e.g. ENST00000269305.4. Resolve a gene symbol with resolve_transcript first. | |
| position | No | A single 1-based residue position. | |
| position_start | No | Inclusive start of a residue range. | |
| position_stop | No | Inclusive stop of a residue range. | |
| source | No | Variant source to report: both|gnomad|clinvar (default both). | both |
| response_mode | No | Verbosity: minimal|compact|standard|full (default compact). | compact |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| success | Yes | ||
| _meta | No | ||
| error_code | No | ||
| message | No | ||
| retryable | No | ||
| recovery_action | No | ||
| field | No | ||
| hint | No | ||
| candidates | No | ||
| recommended_citation | No | ||
| data_versions | No | ||
| transcript_id | No | ||
| source | No | ||
| total | No | ||
| returned | No | ||
| positions | No | ||
| pagination | No |