Research area
Variants
Namespace
gnomad
Listed tools
22
Upstream source
gnomAD

Research tasks

  • Resolve a gene before exploring population variation
  • Compare a variant in the appropriate dataset and reference assembly
  • Review coverage and filtering alongside allele counts

Start with tool discovery

The catalog lists gnomad_search_genes as a representative tool. After connecting your client, inspect the tools and input requirements returned by the service before submitting a query.

Identifiers to prepare

  • Gene symbol or alias
  • Ensembl gene identifier
  • CHROM-POS-REF-ALT with reference assembly
  • rsID resolved to a canonical variant identifier

All available tools (22)

The router surfaces these tools namespaced under gnomad_*:

get_server_capabilitiesUse this when a client needs supported tools, datasets, population codes, recommended workflows, the live ClinVar release date, or current limitations. Returns ~7kB.

Use this when a client needs supported tools, datasets, population codes, recommended workflows, the live ClinVar release date, or current limitations. Returns ~7kB.

get_variant_frequenciesUse this when a caller has a fully-resolved CHROM-POS-REF-ALT id and needs allele counts/frequencies per population. Pair with get_clinvar_variant_details for clinical context. Compact defaults trim subcohort and zero-AC rows; toggle the boolean flags to expand, or use response_mode='full' for the most-inclusive breakdown or response_mode='minimal' for just the headline + overall/max-pop summary. Returns a `truncated` block when filters drop rows so the LLM can re-call with explicit overrides. Returns ~2-4kB (minimal ~0.6kB).

Use this when a caller has a fully-resolved CHROM-POS-REF-ALT id and needs allele counts/frequencies per population. Pair with get_clinvar_variant_details for clinical context. Compact defaults trim subcohort and zero-AC rows; toggle the boolean flags to expand, or use response_mode='full' for the most-inclusive breakdown or response_mode='minimal' for just the headline + overall/max-pop summary. Returns a `truncated` block when filters drop rows so the LLM can re-call with explicit overrides. Returns ~2-4kB (minimal ~0.6kB).

Input parameters

  • dataset(string) — gnomad_r4 (GRCh38, default, largest cohort), gnomad_r3 (GRCh38, whole-genome), gnomad_r2_1 (GRCh37 legacy)
  • exclude_zero_populations(boolean) — Drop populations with allele_count == 0.
  • include_sex_split(boolean) — Include _XX/_XY sex-split rows.
  • include_subcohorts(boolean) — Include non_topmed_*, non_ukb_*, 1kg_*, hgdp_*, controls_* rows.
  • populations(any) — Restrict to these population codes (e.g. ['afr','nfe']). None returns all kept rows.
  • response_mode(string) — compact (default) = today's behavior, honoring the include_subcohorts/include_sex_split/exclude_zero_populations toggles. full = most-inclusive population detail (subcohorts + sex-split + zero-AC rows). minimal = headline + overall/max-pop summary + _meta only (drops the exome/genome per-population arrays). response_mode='full' and response_mode='minimal' take PRECEDENCE over the explicit toggles above.
  • variant_id(string) [required] — CHROM-POS-REF-ALT (e.g. 1-55051215-G-GA). Use M-POS-REF-ALT only with get_mitochondrial_variant.
get_variant_detailsUse this when a caller needs transcript consequences or in-silico predictors for a single variant id. This tool does NOT return ClinVar clinical significance — for that call get_clinvar_variant_details. Prefer get_variant_frequencies if only allele counts are needed; this tool returns the larger annotation payload. Compact trims the exome/genome population breakdown (drops subcohort, sex-split, and zero-AC rows; toggle the booleans to expand) and emits a `truncated` block per source. Returns compact ~3-6kB, full up to ~50kB.

Use this when a caller needs transcript consequences or in-silico predictors for a single variant id. This tool does NOT return ClinVar clinical significance — for that call get_clinvar_variant_details. Prefer get_variant_frequencies if only allele counts are needed; this tool returns the larger annotation payload. Compact trims the exome/genome population breakdown (drops subcohort, sex-split, and zero-AC rows; toggle the booleans to expand) and emits a `truncated` block per source. Returns compact ~3-6kB, full up to ~50kB.

Input parameters

  • dataset(string) — gnomad_r4 (GRCh38, default, largest cohort), gnomad_r3 (GRCh38, whole-genome), gnomad_r2_1 (GRCh37 legacy)
  • exclude_zero_populations(boolean) — Drop populations with allele_count == 0 (compact mode).
  • include_sex_split(boolean) — Include _XX/_XY sex-split rows.
  • include_subcohorts(boolean) — Include non_topmed_*, non_ukb_*, 1kg_*, hgdp_*, controls_* rows.
  • max_transcripts(integer) — Cap on transcript_consequences in compact mode.
  • populations(any) — Restrict population rows to these codes (e.g. ['afr','nfe']). None keeps all kept rows.
  • response_mode(string) — compact strips raw GraphQL extras and trims the population breakdown (see the toggles below); full passes through everything.
  • variant_id(string) [required] — CHROM-POS-REF-ALT id (e.g. 1-55051215-G-GA). Use get_mitochondrial_variant for M-POS-REF-ALT.
compare_variant_across_datasetsUse this when a caller wants to see how one variant's allele frequencies shift across gnomAD releases (r4 vs r3 vs r2_1) and which populations diverge most. Datasets that lack the variant are marked present=false (partial success); the GRCh37 gnomad_r2_1 leg is auto-lifted from the GRCh38 id. Pair with get_clinvar_variant_details for clinical context. Compact (default) drops the per-dataset population arrays (comparison.per_population_af_deltas keeps the per-pop AFs); response_mode='full' returns the raw rows. Returns ~2-4kB compact, ~3-8kB full.

Use this when a caller wants to see how one variant's allele frequencies shift across gnomAD releases (r4 vs r3 vs r2_1) and which populations diverge most. Datasets that lack the variant are marked present=false (partial success); the GRCh37 gnomad_r2_1 leg is auto-lifted from the GRCh38 id. Pair with get_clinvar_variant_details for clinical context. Compact (default) drops the per-dataset population arrays (comparison.per_population_af_deltas keeps the per-pop AFs); response_mode='full' returns the raw rows. Returns ~2-4kB compact, ~3-8kB full.

Input parameters

  • auto_liftover(boolean) — Lift the GRCh38 id to GRCh37 for gnomad_r2_1. Off skips r2_1 with a build note.
  • datasets(any) — Datasets to compare. None compares gnomad_r4, gnomad_r3, gnomad_r2_1.
  • populations(any) — Restrict per-population rows to these codes (e.g. ['afr','nfe']). None keeps all.
  • response_mode(string) — compact (default) drops the duplicated per-dataset exome/genome population arrays (~half the payload) since comparison.per_population_af_deltas already carries every per-population AF; full keeps the raw ac/an rows; minimal returns the headline + per-dataset present flags + comparison.overall_af_by_dataset + _meta only (drops the raw per-dataset rows and per_population_af_deltas).
  • variant_id(string) [required] — GRCh38 CHROM-POS-REF-ALT id (e.g. 1-55039974-G-T). r2_1 is auto-lifted to GRCh37.
compute_carrier_frequencyUse this when a caller needs an estimated carrier/affected frequency derived from a single gnomAD allele frequency under Hardy-Weinberg assumptions for AR, AD, or X-linked inheritance. Pure local math on top of get_variant_frequencies; returns a one-line `headline`, Wilson 95% CIs, per-population breakdown, and provenance (short citations + a gnomad://citations pointer in compact mode; full citations with response_mode='full'). Estimates are research-use only, never clinical decision support. Returns ~2-4kB.

Use this when a caller needs an estimated carrier/affected frequency derived from a single gnomAD allele frequency under Hardy-Weinberg assumptions for AR, AD, or X-linked inheritance. Pure local math on top of get_variant_frequencies; returns a one-line `headline`, Wilson 95% CIs, per-population breakdown, and provenance (short citations + a gnomad://citations pointer in compact mode; full citations with response_mode='full'). Estimates are research-use only, never clinical decision support. Returns ~2-4kB.

Input parameters

  • dataset(string) — gnomad_r4 (GRCh38, default, largest cohort), gnomad_r3 (GRCh38), gnomad_r2_1 (GRCh37 legacy)
  • inheritance(string) [required] — AR=autosomal-recessive (2pq carrier, q^2 affected); AD=autosomal-dominant (1-(1-q)^2); XL=X-linked (sex-split).
  • method(string) — hwe = 2pq from AF; hom_corrected = (ac - 2*hom)/(an/2) observed variant carrier rate.
  • populations(any) — Restrict per_population rows to these population codes (e.g. ['afr','nfe']). None returns all.
  • response_mode(string) — compact (default) returns short citations + a citations_ref pointer to gnomad://citations; full inlines the complete bibliographic citations and assumptions prose; minimal returns the headline + global `overall` block + _meta (drops the per-population rows and full citations).
  • variant_id(string) [required] — CHROM-POS-REF-ALT (e.g. 7-117559590-ATCT-A). Autosomal/X-Y only.
get_gene_detailsUse this when a caller has a gene id or symbol and needs constraint scores (pLI/oe_lof), canonical transcript, and basic coordinates. Follow with get_gene_variants if they then need per-variant rows. Returns compact ~2kB, full up to ~30kB.

Use this when a caller has a gene id or symbol and needs constraint scores (pLI/oe_lof), canonical transcript, and basic coordinates. Follow with get_gene_variants if they then need per-variant rows. Returns compact ~2kB, full up to ~30kB.

Input parameters

  • gene(string) [required] — Gene symbol (e.g. PCSK9) or Ensembl gene ID (ENSG...).
  • reference_genome(string) — Lookup build for gene coordinates and constraint. GRCh38 default.
  • response_mode(string) — compact drops heavy arrays (transcripts, exons, alt_transcripts) and emits a truncated block; full passes through everything; minimal returns the headline + symbol/gene_id + pLI/oe_lof + coordinates + _meta only.
get_gene_variantsUse this when a caller wants per-variant rows for an Ensembl gene. Caps large results at 500; consequence/AF/AC filters and include_populations control payload size. Reports cap use in `truncated` and describes retained population fields in `population_projection`. Returns ~5-45kB at the default limit=100.

Use this when a caller wants per-variant rows for an Ensembl gene. Caps large results at 500; consequence/AF/AC filters and include_populations control payload size. Reports cap use in `truncated` and describes retained population fields in `population_projection`. Returns ~5-45kB at the default limit=100.

Input parameters

  • consequence(any) — Exact VEP major_consequence term to keep (e.g. 'missense_variant', 'stop_gained'); not a category like 'lof'. An unrecognised term is rejected as invalid_input, not zeroed.
  • dataset(string) — gnomad_r4 (GRCh38, default, largest cohort), gnomad_r3 (GRCh38, whole-genome), gnomad_r2_1 (GRCh37 legacy)
  • exclude_zero_populations(boolean) — Drop populations with allele_count == 0 from each variant.
  • gene_id(string) [required] — Ensembl gene ID.
  • include_populations(boolean) — Keep each variant's per-population breakdown (trimmed). Set False to drop the population arrays entirely (keeps ac/an/af) for a lean list scan — the biggest token saving.
  • include_sex_split(boolean) — Include _XX/_XY sex-split rows.
  • include_subcohorts(boolean) — Include non_topmed_*, non_ukb_*, 1kg_*, hgdp_*, controls_* rows.
  • limit(integer) — Max variants returned (hard cap 500).
  • max_af(any) — Drop variants whose AF exceeds this threshold.
  • min_ac(any) — Drop variants whose AC is below this threshold.
compute_gene_carrier_frequencyUse this when a caller needs gene-level autosomal-recessive carrier frequency across qualifying pathogenic variants, not a single variant. Run this server-side computation once per gene; do not loop over variants. Returns global and per-population carrier frequency, genetic and Bayesian prevalence, a headline, provenance, and contributing variants. Research use only; not clinical decision support. Returns ~4-30kB (gene/limit dependent).

Use this when a caller needs gene-level autosomal-recessive carrier frequency across qualifying pathogenic variants, not a single variant. Run this server-side computation once per gene; do not loop over variants. Returns global and per-population carrier frequency, genetic and Bayesian prevalence, a headline, provenance, and contributing variants. Research use only; not clinical decision support. Returns ~4-30kB (gene/limit dependent).

Input parameters

  • clinvar_star_threshold(integer) — Minimum ClinVar gold stars for a P/LP match.
  • conflicting_threshold(number) — Min %% of P/LP submissions to accept a conflicting variant.
  • dataset(string) — gnomad_r4 (GRCh38, default), gnomad_r3 (GRCh38), gnomad_r2_1 (GRCh37).
  • exclude_genomes_only(boolean) — Drop genome-only variants.
  • exclude_gnomad_filtered(boolean) — Drop variants that failed gnomAD QC filters.
  • exclude_high_af(boolean) — Drop variants with AF >= 0.05 (ACMG BA1) instead of flagging.
  • exclude_high_hom(boolean) — Drop variants with excess homozygotes instead of flagging.
  • gene(string) [required] — Gene symbol (e.g. CFTR) or Ensembl gene ID (ENSG...).
  • include_clinvar(boolean) — Use ClinVar Pathogenic/Likely-pathogenic evidence.
  • include_conflicting_clinvar(boolean) — Include conflicting ClinVar variants, resolved by P/LP submission share. Resolution is batched server-side (~1 extra request per 24 conflicting variants), so this stays fast.
  • include_lof_hc(boolean) — Count LOFTEE high-confidence LoF on the canonical transcript.
  • include_missense(boolean) — Count missense/inframe variants (requires ClinVar P/LP).
  • method(string) — hom_exclusion=GCR 1-prod(1-VCR) (default); hwe=2pq; simplified=2*sum(AF).
  • penetrance(number) — Penetrance for Bayesian prevalence (q^2 * penetrance).
  • response_mode(string) — compact caps the contributing-variant list; full returns all; minimal returns the headline + global block + contributing-variant COUNT + _meta (drops per-population rows and the contributing-variant list).
  • top_variants_limit(integer) — Cap on contributing variants in compact mode.
get_gene_summaryUse this when a caller wants a one-shot gene dossier: constraint (pLI/oe_lof), canonical and MANE-Select transcripts, top pathogenic ClinVar variants, and expression (mean pext + top GTEx tissues). Pass a gene symbol (e.g. PCSK9) or Ensembl gene ID (ENSG...). Use include_clinvar / include_constraint / include_expression to fetch only the sections you need (e.g. include_clinvar=false + include_constraint=false for expression-only). Follow with get_gene_variants for per-variant rows. Returns compact ~3-8kB (ClinVar-dependent); include_clinvar=false trims it most.

Use this when a caller wants a one-shot gene dossier: constraint (pLI/oe_lof), canonical and MANE-Select transcripts, top pathogenic ClinVar variants, and expression (mean pext + top GTEx tissues). Pass a gene symbol (e.g. PCSK9) or Ensembl gene ID (ENSG...). Use include_clinvar / include_constraint / include_expression to fetch only the sections you need (e.g. include_clinvar=false + include_constraint=false for expression-only). Follow with get_gene_variants for per-variant rows. Returns compact ~3-8kB (ClinVar-dependent); include_clinvar=false trims it most.

Input parameters

  • clinvar_limit(integer) — Cap on top_pathogenic ClinVar rows in compact mode.
  • dataset(string) — gnomad_r4 (GRCh38, default), gnomad_r3 (GRCh38), gnomad_r2_1 (GRCh37 legacy)
  • gene(string) [required] — Gene symbol (e.g. PCSK9) or Ensembl gene ID (ENSG...).
  • include_clinvar(boolean) — Include the ClinVar block. False drops it entirely (~10kB saved on ClinVar-dense genes) — combine with include_constraint=False for expression-only.
  • include_constraint(boolean) — Include the gnomAD constraint block (pLI/oe_lof).
  • include_expression(boolean) — Include the best-effort expression block (mean pext + top GTEx tissues). False skips the extra GTEx upstream call.
  • response_mode(string) — compact ranks pathogenic ClinVar into clinvar_summary; full returns the raw clinvar_variants list AND the per-base pext regions; minimal returns the headline + top-line constraint + ClinVar pathogenic COUNT + _meta only. compact/minimal drop expression.pext regions (a truncated_pext marker with expression.mean_pext preserved); full retains them. All honor include_clinvar/include_constraint.
get_clinvar_variant_detailsUse this when a caller needs ClinVar clinical significance, review status, gold stars, or submissions for a single variant id. Complementary to get_variant_frequencies for clinical workflows. compact (default) drops per-submission provenance bookkeeping; response_mode='full' keeps it. Returns ~2-8kB compact, larger with full or a high submissions_limit.

Use this when a caller needs ClinVar clinical significance, review status, gold stars, or submissions for a single variant id. Complementary to get_variant_frequencies for clinical workflows. compact (default) drops per-submission provenance bookkeeping; response_mode='full' keeps it. Returns ~2-8kB compact, larger with full or a high submissions_limit.

Input parameters

  • reference_genome(string) — Lookup build for the variant id. GRCh38 (default) or GRCh37.
  • response_mode(string) — compact (default) drops the per-submission sha256/retrieved_at integrity bookkeeping (keeps the fenced condition/submitter text); full returns the complete fenced provenance.
  • submissions_limit(integer) — Cap on submissions[] returned. Default 25.
  • variant_id(string) [required] — CHROM-POS-REF-ALT id (autosomes, X, Y, M/MT), e.g. 7-117559590-ATCT-A. Match the build to reference_genome (GRCh38 default).
get_clinvar_metaUse this when a caller only needs the ClinVar release date or revision currently served by gnomAD -- cheaper than full capabilities. Returns <1kB. DEPRECATED: prefer get_server_capabilities.

Use this when a caller only needs the ClinVar release date or revision currently served by gnomAD -- cheaper than full capabilities. Returns <1kB. DEPRECATED: prefer get_server_capabilities.

compute_variant_liftoverUse this when a caller has a variant id in one reference build and needs the equivalent id in the other. Works BOTH directions (GRCh37<->GRCh38); the converted coordinate is in each result's `target_variant_id` (and `target_reference_genome` names the build). Use this BEFORE calling frequency tools if the dataset and coordinate build do not match. Returns <1kB.

Use this when a caller has a variant id in one reference build and needs the equivalent id in the other. Works BOTH directions (GRCh37<->GRCh38); the converted coordinate is in each result's `target_variant_id` (and `target_reference_genome` names the build). Use this BEFORE calling frequency tools if the dataset and coordinate build do not match. Returns <1kB.

Input parameters

  • source_genome(string) [required] — Reference build of source_variant_id.
  • source_variant_id(string) [required] — Variant ID to convert (CHROM-POS-REF-ALT). Mitochondrial M/MT prefixes are accepted.
get_regionUse this when a caller wants genes and/or ClinVar variants in a small region (<=100kb). Spans larger than 100kb are clamped and a `truncated` block reports it. Per-category caps (`max_clinvar_variants`, `max_genes`) keep payload bounded; surplus rows are summarised in a `truncated_payload` block. For per-variant SNV listings use get_gene_variants instead. Returns ~5-30kB at compact defaults; up to ~50kB with compact_rows=False.

Use this when a caller wants genes and/or ClinVar variants in a small region (<=100kb). Spans larger than 100kb are clamped and a `truncated` block reports it. Per-category caps (`max_clinvar_variants`, `max_genes`) keep payload bounded; surplus rows are summarised in a `truncated_payload` block. For per-variant SNV listings use get_gene_variants instead. Returns ~5-30kB at compact defaults; up to ~50kB with compact_rows=False.

Input parameters

  • compact_rows(boolean) — Project clinvar/gene rows to a compact key set.
  • dataset(string) — gnomad_r4 (GRCh38, default, largest cohort), gnomad_r3 (GRCh38, whole-genome), gnomad_r2_1 (GRCh37 legacy)
  • include_clinvar(boolean) — Include ClinVar variants in the region.
  • include_genes(boolean) — Include overlapping genes.
  • max_clinvar_variants(integer) — Cap on clinvar_variants[] returned. Default 100.
  • max_genes(integer) — Cap on genes[] returned. Default 50.
  • region(string) [required] — Region in chr-start-stop format (e.g. 17-7674232-7674252).
get_coverageUse this when a caller needs gnomAD read-depth coverage for a gene, region, or single variant. Pass ONE target — a gene symbol, Ensembl gene ID, region (chr-start-stop), or variant (CHROM-POS-REF-ALT) — and the scope is auto-detected. Gene/region return per-position bins plus a {mean_coverage, fraction_over_20} summary; variant returns scalar coverage. Compact mode trims each bin and caps bin count. Returns ~3-40kB compact (bin-count dependent), larger with response_mode='full'.

Use this when a caller needs gnomAD read-depth coverage for a gene, region, or single variant. Pass ONE target — a gene symbol, Ensembl gene ID, region (chr-start-stop), or variant (CHROM-POS-REF-ALT) — and the scope is auto-detected. Gene/region return per-position bins plus a {mean_coverage, fraction_over_20} summary; variant returns scalar coverage. Compact mode trims each bin and caps bin count. Returns ~3-40kB compact (bin-count dependent), larger with response_mode='full'.

Input parameters

  • dataset(string) — gnomad_r4 (GRCh38, default), gnomad_r3 (GRCh38), gnomad_r2_1 (GRCh37 legacy)
  • max_bins(integer) — Cap on coverage bins per source (gene/region). Summary still reflects all bins.
  • response_mode(string) — compact trims each bin to pos/mean/median/over_20/over_30; full keeps all over_* thresholds.
  • target(string) [required] — Gene symbol, Ensembl gene ID (ENSG...), region (chr-start-stop, span capped at 100kb), or variant (CHROM-POS-REF-ALT) for scalar per-variant coverage. The scope is auto-detected.
get_structural_variantUse this when a caller has a gnomAD structural variant id (deletions, duplications, inversions, translocations/BND, complex/CPX, MCNV). SV ids come from search_structural_variants (search a gene/region first); they are NOT resolvable by resolve_variant_id, which is SNV/indel only. For SNVs/indels use get_variant_frequencies instead. Compact (default) drops heavy histograms + the duplicated flat gene list and emits a `truncated` block; response_mode='full' returns everything. Returns compact ~2-5kB; full ~10-20kB (histograms + populations).

Use this when a caller has a gnomAD structural variant id (deletions, duplications, inversions, translocations/BND, complex/CPX, MCNV). SV ids come from search_structural_variants (search a gene/region first); they are NOT resolvable by resolve_variant_id, which is SNV/indel only. For SNVs/indels use get_variant_frequencies instead. Compact (default) drops heavy histograms + the duplicated flat gene list and emits a `truncated` block; response_mode='full' returns everything. Returns compact ~2-5kB; full ~10-20kB (histograms + populations).

Input parameters

  • dataset(string) — Structural-variant dataset: gnomad_sv_r4 (GRCh38, default) or gnomad_sv_r2_1 (GRCh37).
  • response_mode(string) — compact drops heavy age/genotype-quality histograms and the duplicated flat gene list; full returns the raw payload.
  • variant_id(string) [required] — gnomAD SV identifier as returned by search_structural_variants (e.g. BND_chr12_e99836ac, DEL_chr1_1234abcd). Discover ids via search_structural_variants for a gene/region; do not guess the suffix.
get_mitochondrial_variantUse this when a caller has a mitochondrial variant id (M-POS-REF-ALT). Mitochondrial ploidy and heteroplasmy fields are returned; for autosomal variants use get_variant_frequencies. By default zero-count heteroplasmy bins are trimmed and a `truncated.kind=heteroplasmy_zeros` block reports the count; set `include_heteroplasmy_zeros=True` to keep them. Returns ~2-4kB.

Use this when a caller has a mitochondrial variant id (M-POS-REF-ALT). Mitochondrial ploidy and heteroplasmy fields are returned; for autosomal variants use get_variant_frequencies. By default zero-count heteroplasmy bins are trimmed and a `truncated.kind=heteroplasmy_zeros` block reports the count; set `include_heteroplasmy_zeros=True` to keep them. Returns ~2-4kB.

Input parameters

  • dataset(string) — gnomad_r4 (GRCh38, default) or gnomad_r3 (GRCh38); gnomad_r2_1 does not include mitochondrial variants
  • include_heteroplasmy_zeros(boolean) — Keep zero-count bins in heteroplasmy_distribution histograms.
  • variant_id(string) [required] — Mitochondrial variant in M-POS-REF-ALT format. Accepts chrM-, MT-, and chrMT- aliases (normalized to M-).
get_transcript_detailsUse this when a caller has an Ensembl transcript id and needs exon structure and (by default) a compact GTEx tissue-expression summary for that transcript. GTEx is sourced via the gene path; the lookup is best-effort, so exon structure is returned even if expression is unavailable. For gene-level info use get_gene_details. Returns ~3-8kB (set include_expression=False to skip GTEx).

Use this when a caller has an Ensembl transcript id and needs exon structure and (by default) a compact GTEx tissue-expression summary for that transcript. GTEx is sourced via the gene path; the lookup is best-effort, so exon structure is returned even if expression is unavailable. For gene-level info use get_gene_details. Returns ~3-8kB (set include_expression=False to skip GTEx).

Input parameters

  • include_expression(boolean) — Attach a compact GTEx tissue-expression summary (top tissues) for this transcript via the gene path. Set False to skip the extra upstream call and return only exon structure.
  • reference_genome(string) — Lookup build for the transcript. GRCh38 default.
  • transcript_id(string) [required] — Ensembl transcript ID (ENST + 11 digits, optional .version).
search_structural_variantsUse this when a caller wants the list of structural variants overlapping a gene or region. Pass ONE target — a gene symbol, Ensembl gene ID, or region (CHROM-START-STOP) — and the scope is auto-detected. SV variant_id values are OPAQUE (e.g. DEL_19_1), NOT CHROM-POS-REF-ALT, so no SNV id grammar is applied; fetch a single SV by id with get_structural_variant. sv_dataset is the DISTINCT structural-variant dataset enum (gnomad_sv_r4=GRCh38 default, gnomad_sv_r2_1=GRCh37), not the SNV dataset. Type/length filters are applied client-side. An empty match is a success with returned=0, not an error. Returns ~3-30kB (limit-dependent).

Use this when a caller wants the list of structural variants overlapping a gene or region. Pass ONE target — a gene symbol, Ensembl gene ID, or region (CHROM-START-STOP) — and the scope is auto-detected. SV variant_id values are OPAQUE (e.g. DEL_19_1), NOT CHROM-POS-REF-ALT, so no SNV id grammar is applied; fetch a single SV by id with get_structural_variant. sv_dataset is the DISTINCT structural-variant dataset enum (gnomad_sv_r4=GRCh38 default, gnomad_sv_r2_1=GRCh37), not the SNV dataset. Type/length filters are applied client-side. An empty match is a success with returned=0, not an error. Returns ~3-30kB (limit-dependent).

Input parameters

  • limit(integer) — Max SV rows returned (hard cap 500).
  • max_length(any) — Drop SVs longer than this length (bp).
  • min_length(any) — Drop SVs shorter than this length (bp).
  • response_mode(string) — compact projects each row to a fixed key-set; full is reserved.
  • sv_dataset(string) — Structural-variant dataset (DISTINCT from SNV datasets). gnomad_sv_r4 (GRCh38, default), gnomad_sv_r2_1 (GRCh37).
  • sv_type(any) — Filter by SV class (uppercase enum). An unrecognised value is rejected as invalid_input.
  • target(string) [required] — Gene symbol, Ensembl gene ID (ENSG...), or region (CHROM-START-STOP, e.g. 19-11089000-11200000). The scope is auto-detected.
search_genesUse this when a caller has a fuzzy gene query (symbol, alias, partial name). Follow with get_gene_details for full constraint metrics. Note: gnomAD's gene autocomplete returns a bounded set and may omit exact members of a large gene family for a SHORT prefix (e.g. 'GRIN' does not return GRIN1/GRIN2B). If an expected gene is missing, query its FULL symbol (e.g. 'GRIN1') or call get_gene_details/get_gene_summary directly. Returns ~1-3kB.

Use this when a caller has a fuzzy gene query (symbol, alias, partial name). Follow with get_gene_details for full constraint metrics. Note: gnomAD's gene autocomplete returns a bounded set and may omit exact members of a large gene family for a SHORT prefix (e.g. 'GRIN' does not return GRIN1/GRIN2B). If an expected gene is missing, query its FULL symbol (e.g. 'GRIN1') or call get_gene_details/get_gene_summary directly. Returns ~1-3kB.

Input parameters

  • limit(integer) — Max matches returned.
  • query(string) [required] — Gene symbol, name fragment, or Ensembl ID.
  • reference_genome(string) — Reference build to search gene symbols/ids within. GRCh38 default.
resolve_variant_idUse this when the caller only has an rsID, partial coordinates, or text fragment and needs to obtain a canonical gnomAD variant id. With enrich=True (default) the top hits include gene_symbol, major_consequence, and AF so the caller can rank candidates without a follow-up call. Returns ~1-5kB (enrichment dependent).

Use this when the caller only has an rsID, partial coordinates, or text fragment and needs to obtain a canonical gnomAD variant id. With enrich=True (default) the top hits include gene_symbol, major_consequence, and AF so the caller can rank candidates without a follow-up call. Returns ~1-5kB (enrichment dependent).

Input parameters

  • dataset(string) — gnomad_r4 (GRCh38, default, largest cohort), gnomad_r3 (GRCh38, whole-genome), gnomad_r2_1 (GRCh37 legacy)
  • enrich(boolean) — Second-pass fetch gene_symbol, major_consequence, and AF for the top 5 hits.
  • limit(integer) — Max candidate variant ids returned.
  • query(string) [required] — rsID, CHROM-POS-REF-ALT, or 'CHROM:POS'.
search_variantsUse this when a caller uses the legacy tool name -- deprecated alias for resolve_variant_id. Mirrors the same enrichment behaviour; will be removed in the next release. Returns ~1-5kB (deprecated alias).

Use this when a caller uses the legacy tool name -- deprecated alias for resolve_variant_id. Mirrors the same enrichment behaviour; will be removed in the next release. Returns ~1-5kB (deprecated alias).

Input parameters

  • dataset(string) — gnomad_r4 (GRCh38, default, largest cohort), gnomad_r3 (GRCh38, whole-genome), gnomad_r2_1 (GRCh37 legacy)
  • enrich(boolean) — Second-pass fetch gene_symbol, major_consequence, and AF for the top 5 hits.
  • limit(integer) — Max candidate variant ids returned.
  • query(string) [required] — rsID, CHROM-POS-REF-ALT, or 'CHROM:POS'.
get_diagnosticsUse this when an LLM hits repeated errors or needs server health information; returns recent error history, server version, upstream availability flag, and recent_schema_drift entries so an LLM that hit output_validation_failed can self-diagnose. Returns <1kB.

Use this when an LLM hits repeated errors or needs server health information; returns recent error history, server version, upstream availability flag, and recent_schema_drift entries so an LLM that hit output_validation_failed can self-diagnose. Returns <1kB.

Database & release provenance

Data mode
none
Attestation
unhosted
Release version
v9.0.5
ghcr.io/berntpopp/gnomad-link@sha256:a098bbbb7cc82b9f75177f902d6f5efe6a2f5b115ea068897b010497976a922a

Review the response

Keep the source record link and submitted identifiers with your notes. Record the dataset version and retrieval date when available. This page does not contain a captured gnomAD response.