Enigma Clinical API
The 63 JSON endpoints behind the Enigma Clinical web application, with parameters, authentication and example requests.
Overview
Every endpoint answers JSON over HTTPS. Variant IDs are GRCh38 chrom-pos-ref-alt (for example 7-140753336-A-T). Most endpoints return public reference data, need no credentials and are cached at the CDN. The machine-readable description is at /api/openapi.json; import it into Postman, Insomnia or an OpenAPI client generator.
Cohort data needs a Firebase ID token in an Authorization: Bearer … header: any signed-in account for aggregate statistics, and an account approved by an administrator for row-level variant data. Get the token from the Firebase SDK (await auth.currentUser.getIdToken()) after signing in to Enigma Clinical; it expires after an hour. Cohort endpoints return aggregates only and never sample identifiers.
This API serves the web application. There are no API keys yet, no rate-limit guarantees, and response shapes may change between releases. Please respect the licence of each upstream source (see Data sources) and cite the platform when you use it.
Search
Turn free text into genes, variants and other targets.
/api/search/PublicGene and rsID suggestions
Fast suggestions for the search box (genes and rsIDs, via gnomAD). Other formats return no results and the parsed kind, so callers know to ask /api/resolve.
Caching: Server data cache and CDN.
| Parameter | In | Description | Example |
|---|---|---|---|
qrequired | query | Search text (truncated to a safe length). | BRCA |
curl -s \ "https://clinical.enigmagenomics.com/api/search/?q=BRCA"
/api/resolve/PublicResolve any supported query
Turns any supported search format (gene, variant ID, rsID, HGVS c./p./g., ClinGen allele, region, cytoband, ISCN, SV, HPO/MONDO/OMIM/Orphanet ID …) into canonical targets: { query, kind, recognisedAs, results[], message? }.
Caching: Server data cache and CDN; explained misses are cached too.
| Parameter | In | Description | Example |
|---|---|---|---|
qrequired | query | Query in any supported format. | NM_000546.6:c.743G>A |
curl -s \ "https://clinical.enigmagenomics.com/api/resolve/?q=NM_000546.6%3Ac.743G%3EA"
Cohort
Saudi cohort data. Aggregates only; sample identifiers are never returned.
/api/hasura/Approved accountRead-only GraphQL proxy
Forwards a read-only GraphQL query to the Saudi cohort database. Mutations, subscriptions and introspection are rejected. Frequencies are stored as percentages.
Caching: Not cached.
curl -s \
-X POST \
-H "Authorization: Bearer $FIREBASE_ID_TOKEN" \
-H "Content-Type: application/json" \
-d '{"target":"sgp","query":"query { exomes_samples24dec(where: {symbol: {_eq: \"HBB\"}}, limit: 5) { variant_id allele_count allele_number allele_frequency } }","variables":{}}' \
"https://clinical.enigmagenomics.com/api/hasura/"/api/igv/sgp/Approved accountCohort variants in a window
Variant ID, cohort allele frequency (fraction) and first VEP consequence for every cohort variant in a window; used by the genome browser track.
Caching: Private browser cache only.
| Parameter | In | Description | Example |
|---|---|---|---|
chromrequired | query | Chromosome without "chr". | 11 |
startrequired | query | Window start (1-based). | 5226900 |
endrequired | query | Window end. | 5227100 |
curl -s \ -H "Authorization: Bearer $FIREBASE_ID_TOKEN" \ "https://clinical.enigmagenomics.com/api/igv/sgp/?chrom=11&start=5226900&end=5227100"
/api/insights/Signed-in accountCohort statistics
Variants by consequence and ClinVar group, novelty against gnomAD, frequency spectrum, top genes and phenotype counts. Counts of fewer than five individuals are withheld.
curl -s \ -H "Authorization: Bearer $FIREBASE_ID_TOKEN" \ "https://clinical.enigmagenomics.com/api/insights/"
/api/knockouts/Approved accountHomozygous loss-of-function registry
Every cohort site with at least one homozygous individual and a predicted loss-of-function VEP consequence (transcript ablation, splice acceptor/donor, stop gained, frameshift, start lost): { terms[], rows[], truncated, generatedAt }. Site-level rows only (variant, gene, allele counts, homozygotes, gnomAD max AF, consequence, ClinVar); sample identifiers are never returned. LOFTEE confidence is not applied, so some sites are low-confidence LoF. `truncated` is true when the list hit its 30,000-row ceiling.
Caching: Private browser cache for an hour; the server keeps the assembled list for a day.
curl -s \ -H "Authorization: Bearer $FIREBASE_ID_TOKEN" \ "https://clinical.enigmagenomics.com/api/knockouts/"
/api/clinvar-discordance/Approved accountClinVar discordance alerts
Cohort sites whose ClinVar germline classification the cohort argues against (P/LP above BA1 or BS1, P/LP homozygotes in dominant-only genes, B/LB loss-of-function in haploinsufficient genes), each with reason codes and a severity.
Caching: One day on the server; one hour in the browser (private). Sources: ClinVar, GenCC, ClinGen Dosage Sensitivity.
curl -s \ -H "Authorization: Bearer $FIREBASE_ID_TOKEN" \ "https://clinical.enigmagenomics.com/api/clinvar-discordance/"
/api/stats/PublicHeadline counts
Live aggregate counts from the cohort table for the home page.
Caching: One day, server and CDN.
curl -s \ "https://clinical.enigmagenomics.com/api/stats/"
/api/founder-variants/Approved accountFounder variant registry
ClinVar pathogenic or likely pathogenic cohort sites enriched at least 10× over the gnomAD v4 maximum genetic-ancestry-group AF, or absent from gnomAD with AC ≥ 2: { criteria, rows[], truncated, generatedAt }. Site-level rows only; frequencies are percentages.
Caching: One day on the server; private one hour in the browser.
curl -s \ -H "Authorization: Bearer $FIREBASE_ID_TOKEN" \ "https://clinical.enigmagenomics.com/api/founder-variants/"
Variant
Annotation and evidence for one GRCh38 small variant (chrom-pos-ref-alt).
/api/gnomad/variant/{id}/PublicgnomAD v4 variant
gnomAD v4 frequencies by genetic-ancestry group, consequences and ClinVar for one variant.
Caching: One day. Sources: gnomAD (ODbL).
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/gnomad/variant/7-140753336-A-T/"
/api/clinvar/variant/{id}/PublicLive ClinVar record
Germline classification, somatic clinical impact and oncogenicity, matched on the exact allele.
Sources: NCBI E-utilities (public domain).
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/clinvar/variant/7-140753336-A-T/"
/api/classification/variant/{id}/PublicAutomated ACMG/AMP classification
Points-based germline classification from licence-free public evidence, with ClinGen CSpec rules where implemented and expert-panel classifications. Research use only; each source fails soft and unreachable sources are listed.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/classification/variant/7-140753336-A-T/"
/api/myvariant/variant/{id}/PublicIn-silico predictors (dbNSFP)
Licence-free dbNSFP predictor scores via MyVariant.info. "No record" is `available: false`, not a 404.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/myvariant/variant/7-140753336-A-T/"
/api/protein/transcripts/{id}/PublicTranscript consequences
Every Ensembl and RefSeq transcript the variant falls in or near (Ensembl VEP): HGVS c./p., consequence, exon/intron, MANE flags.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/protein/transcripts/7-140753336-A-T/"
/api/gtex/variant/{id}/PublicGTEx eQTLs and sQTLs
Significant single-tissue eQTLs and sQTLs (GTEx V11) for the exact allele. Empty lists mean no significant QTL.
Caching: One week.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/gtex/variant/7-140753336-A-T/"
/api/variant-sv/{id}/PublicStructural context of a position
gnomAD-SV and exome CNV records overlapping the position, ClinGen dosage regions and genes containing it, and gnomAD coverage.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/variant-sv/7-140753336-A-T/"
/api/variant-sv/{id}/clinvar/PublicClinVar SVs over a position
Live ClinVar structural records (≥ 50 bp) that overlap the variant’s span.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/variant-sv/7-140753336-A-T/clinvar/"
/api/rare-disease/variant/{id}/PublicConditions for a variant
Conditions ClinVar records for the variant with MONDO, Orphanet and OMIM IDs, the aggregate classification per condition and the gene–disease validity of `gene`.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
gene | query | Gene symbol hint from the page (optional). | BRAF |
curl -s \ "https://clinical.enigmagenomics.com/api/rare-disease/variant/7-140753336-A-T/?gene=BRAF"
Gene
Gene-level annotation, expression, somatic and structural context.
/api/gnomad/gene/{id}/PublicgnomAD gene annotation
Gene model, constraint and transcripts from gnomAD.
Caching: One day, server and CDN.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | Gene symbol or Ensembl gene ID. | ENSG00000157764 |
curl -s \ "https://clinical.enigmagenomics.com/api/gnomad/gene/ENSG00000157764/"
/api/gnomad/gene/{id}/clinvar/PublicClinVar variants in a gene
ClinVar variants in the gene, via gnomAD.
Caching: One day.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | Ensembl gene ID. | ENSG00000157764 |
curl -s \ "https://clinical.enigmagenomics.com/api/gnomad/gene/ENSG00000157764/clinvar/"
/api/gnomad/gene/{id}/coverage/PublicgnomAD read depth over a gene
gnomAD v4 exome and genome read depth over the coding exons of the gene's MANE Select (else canonical) transcript: per-exon summaries and a binned profile.
Caching: One day. Sources: gnomAD (ODbL).
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | Ensembl gene ID or gene symbol. | ENSG00000157764 |
curl -s \ "https://clinical.enigmagenomics.com/api/gnomad/gene/ENSG00000157764/coverage/"
/api/gnomad/gene/{id}/rmc/PublicRegional missense constraint
gnomAD v2.1.1 regional missense constraint (published on GRCh37; amino-acid ranges are build-independent). `status` says whether regions were found, the gene was searched without evidence, or it was not searched. 404 when gnomAD v2 has no such gene.
Caching: One day. Sources: gnomAD (ODbL).
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | Ensembl gene ID or gene symbol. | ENSG00000157764 |
curl -s \ "https://clinical.enigmagenomics.com/api/gnomad/gene/ENSG00000157764/rmc/"
/api/gnomad/transcript/{id}/PublicTranscript
One transcript from gnomAD with its MANE Select / Plus Clinical status. RefSeq IDs are mapped through MANE.
Caching: One day.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | Ensembl (ENST) or RefSeq (NM_) transcript ID. | ENST00000646891 |
curl -s \ "https://clinical.enigmagenomics.com/api/gnomad/transcript/ENST00000646891/"
/api/gtex/gene/{id}/PublicGTEx tissue expression
Per-tissue TPM summaries with violin densities and median isoform expression (GTEx V11). 404 `{ notFound: true }` when GTEx has no such gene.
Caching: One week.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | Ensembl gene ID or symbol. | BRAF |
chrom | query | Picks between same-symbol genes (PAR). | 7 |
curl -s \ "https://clinical.enigmagenomics.com/api/gtex/gene/BRAF/?chrom=7"
/api/gene/{gene}/somatic/PublicCancer-driver role and CIViC
IntOGen driver role and CIViC summary with evidence counts per molecular profile.
Sources: IntOGen, CIViC (CC0).
| Parameter | In | Description | Example |
|---|---|---|---|
generequired | path | HGNC gene symbol. | BRAF |
curl -s \ "https://clinical.enigmagenomics.com/api/gene/BRAF/somatic/"
/api/gene/{gene}/mutations/PublicSomatic mutations (TCGA)
Mutation frequency by cancer type and samples per residue / protein change across TCGA PanCancer Atlas, with protein length and Pfam domains. Counts only.
| Parameter | In | Description | Example |
|---|---|---|---|
generequired | path | HGNC gene symbol. | BRAF |
curl -s \ "https://clinical.enigmagenomics.com/api/gene/BRAF/mutations/"
/api/gene/{gene}/protein/PublicProtein length and Pfam domains
Reviewed human UniProt entry for the gene (accession, name, length) and its Pfam domains from InterPro. Feeds the gene-page protein lollipop.
Caching: One week. Sources: UniProt (CC BY 4.0), InterPro/Pfam (CC0).
| Parameter | In | Description | Example |
|---|---|---|---|
generequired | path | HGNC gene symbol. | BRAF |
curl -s \ "https://clinical.enigmagenomics.com/api/gene/BRAF/protein/"
/api/gene/{gene}/sv/PublicSVs and CNVs in a gene
gnomAD-SV v4 and exome CNV v4 records in the gene, with ClinGen dosage sensitivity for the gene and the curated regions it lies in.
| Parameter | In | Description | Example |
|---|---|---|---|
generequired | path | Gene symbol or Ensembl gene ID. | PMP22 |
curl -s \ "https://clinical.enigmagenomics.com/api/gene/PMP22/sv/"
/api/protein/clinvar/{gene}/PublicClinVar P/LP on protein codons
Pathogenic and likely pathogenic ClinVar variants of a gene placed on the codons of one transcript, with its coding intervals.
| Parameter | In | Description | Example |
|---|---|---|---|
generequired | path | HGNC gene symbol. | BRAF |
transcriptrequired | query | Ensembl transcript ID. | ENST00000646891 |
curl -s \ "https://clinical.enigmagenomics.com/api/protein/clinvar/BRAF/?transcript=ENST00000646891"
/api/protein/uniprot/{accession}/PublicProtein features and structure
UniProt features, Pfam domains (InterPro), AlphaFold DB model with per-residue pLDDT and per-residue AlphaMissense means.
| Parameter | In | Description | Example |
|---|---|---|---|
accessionrequired | path | UniProtKB accession. | P15056 |
curl -s \ "https://clinical.enigmagenomics.com/api/protein/uniprot/P15056/"
/api/protein/cancer-counts/PublicTumour mutations at a codon
Tumour mutations at one codon and in the whole protein across cBioPortal public studies.
| Parameter | In | Description | Example |
|---|---|---|---|
entrezrequired | query | NCBI Gene ID. | 673 |
codonrequired | query | Codon number. | 600 |
lengthrequired | query | Protein length in residues. | 766 |
curl -s \ "https://clinical.enigmagenomics.com/api/protein/cancer-counts/?entrez=673&codon=600&length=766"
/api/repeat/{locus}/PublicSTR allele-size distributions
gnomAD v4 short-tandem-repeat allele sizes for one catalogued locus, by repeat unit and genetic-ancestry group.
Sources: gnomAD (ODbL).
| Parameter | In | Description | Example |
|---|---|---|---|
locusrequired | path | Catalogued repeat locus ID. | HTT |
curl -s \ "https://clinical.enigmagenomics.com/api/repeat/HTT/"
Structural variants
SVs, CNVs, insertions, MEIs and translocations.
/api/dosage/PublicClinGen dosage sensitivity
ClinGen haploinsufficiency and triplosensitivity scores for one gene (`gene`), or the curated genes and recurrent CNV regions overlapping a GRCh38 interval (`region`, at most 50 Mb): { genesListDate, regionsListDate, gene?, genes[], regions[] }. Pass exactly one of the two parameters; `gene` is null when ClinGen has not curated the gene.
Caching: CDN (bundled curation lists). Sources: ClinGen Dosage Sensitivity (CC0).
| Parameter | In | Description | Example |
|---|---|---|---|
gene | query | HGNC gene symbol (or use region). | PMP22 |
region | query | GRCh38 interval chrom-start-end or chrom:start-end (or use gene). | 17-14000000-16000000 |
curl -s \ "https://clinical.enigmagenomics.com/api/dosage/?gene=PMP22®ion=17-14000000-16000000"
/api/sv/{id}/PublicSV / CNV summary
Names, genes and exons, ClinGen dosage, gnomAD-SV and exome CNV overlaps and automated ACMG CNV points.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | chrom-start-end-TYPE (DEL, DUP, INV, CNV, CPX), chrom-pos-L<length>-INS, chromA-posA-chromB-posB-BND, or chrom-pos-ALU|L1|SVA|HERVK. | 22-18912231-21465672-DEL |
curl -s \ "https://clinical.enigmagenomics.com/api/sv/22-18912231-21465672-DEL/"
/api/sv/{id}/transcripts/PublicTranscripts hit by an SV
GENCODE transcripts overlapped by the interval, with MANE flags, exons hit and the share of span, exons and coding bases inside the event.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | chrom-start-end-TYPE (DEL, DUP, INV, CNV, CPX), chrom-pos-L<length>-INS, chromA-posA-chromB-posB-BND, or chrom-pos-ALU|L1|SVA|HERVK. | 22-18912231-21465672-DEL |
curl -s \ "https://clinical.enigmagenomics.com/api/sv/22-18912231-21465672-DEL/transcripts/"
/api/sv/{id}/clinvar/PublicOverlapping ClinVar SVs
Live ClinVar structural records (≥ 50 bp) overlapping the event, or near an insertion / breakend.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | chrom-start-end-TYPE (DEL, DUP, INV, CNV, CPX), chrom-pos-L<length>-INS, chromA-posA-chromB-posB-BND, or chrom-pos-ALU|L1|SVA|HERVK. | 22-18912231-21465672-DEL |
curl -s \ "https://clinical.enigmagenomics.com/api/sv/22-18912231-21465672-DEL/clinvar/"
/api/sv/{id}/literature/PublicPublications for an SV region
Europe PMC publications for the cytoband, ClinGen region diseases and dosage-sensitive genes the event overlaps.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | chrom-start-end-TYPE (DEL, DUP, INV, CNV, CPX), chrom-pos-L<length>-INS, chromA-posA-chromB-posB-BND, or chrom-pos-ALU|L1|SVA|HERVK. | 22-18912231-21465672-DEL |
curl -s \ "https://clinical.enigmagenomics.com/api/sv/22-18912231-21465672-DEL/literature/"
/api/sv/{id}/phenotype/PublicPhenotype match for an SV
For each HPO term, the genes in the event that HPO annotates to the term or a more specific one.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | chrom-start-end-TYPE (DEL, DUP, INV, CNV, CPX), chrom-pos-L<length>-INS, chromA-posA-chromB-posB-BND, or chrom-pos-ALU|L1|SVA|HERVK. | 22-18912231-21465672-DEL |
hporequired | query | Comma-separated HPO term IDs. | HP:0001250,HP:0000252 |
curl -s \ "https://clinical.enigmagenomics.com/api/sv/22-18912231-21465672-DEL/phenotype/?hpo=HP%3A0001250%2CHP%3A0000252"
Pharmacogenomics
CPIC gene–drug pairs, star alleles and drug facts.
/api/pgx/drugs/PublicDrugs with CPIC pairs
Every drug with a CPIC gene–drug pair, best CPIC level first.
curl -s \ "https://clinical.enigmagenomics.com/api/pgx/drugs/"
/api/pgx/drug/{name}/PublicOne drug
CPIC gene–drug pairs, guidelines, dosing recommendations, Drug Repurposing Hub mechanisms and indications, and star-allele functions. Unknown drugs are 404 with `suggestions`.
| Parameter | In | Description | Example |
|---|---|---|---|
namerequired | path | Drug name. | clopidogrel |
curl -s \ "https://clinical.enigmagenomics.com/api/pgx/drug/clopidogrel/"
/api/pgx/gene/{symbol}/PublicCPIC facts for a gene
CPIC facts and gene–drug pairs for one gene (`{ gene: null, pairs: [] }` when CPIC has none).
| Parameter | In | Description | Example |
|---|---|---|---|
symbolrequired | path | HGNC gene symbol. | CYP2C19 |
curl -s \ "https://clinical.enigmagenomics.com/api/pgx/gene/CYP2C19/"
/api/gene/{gene}/alleles/PublicCPIC star alleles
Star alleles of a pharmacogene with clinical function, activity value, evidence strength and Near Eastern frequency.
Sources: CPIC (CC0).
| Parameter | In | Description | Example |
|---|---|---|---|
generequired | path | HGNC gene symbol. | CYP2C19 |
curl -s \ "https://clinical.enigmagenomics.com/api/gene/CYP2C19/alleles/"
/api/pgx/variant/{id}/PublicPGx at a variant
CPIC star alleles defined at the position, the gene–drug pairs of its gene and the ClinPGx accession.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 10-94781859-G-A |
rsid | query | rsID hint (optional). | rs4244285 |
gene | query | Gene symbol hint from the page (optional). | CYP2C19 |
curl -s \ "https://clinical.enigmagenomics.com/api/pgx/variant/10-94781859-G-A/?rsid=rs4244285&gene=CYP2C19"
Disease & phenotype
Rare-disease catalogue, MONDO diseases and HPO phenotypes.
/api/rare-disease/catalogue/PublicRare-disease catalogue
Every active Orphanet entry in compact rows, with MONDO mappings, GenCC and ClinGen validity.
Sources: Orphanet (CC BY 4.0), GenCC and ClinGen (CC0).
curl -s \ "https://clinical.enigmagenomics.com/api/rare-disease/catalogue/"
/api/rare-disease/disease/{id}/PublicRare-disease facts
Orphanet inheritance, onset, prevalence, category and genes, and ClinGen / GenCC gene–disease validity.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | MONDO, ORPHA or OMIM disease ID. | MONDO:0011382 |
curl -s \ "https://clinical.enigmagenomics.com/api/rare-disease/disease/MONDO%3A0011382/"
/api/rare-disease/gene/{symbol}/PublicRare diseases for a gene
ClinGen and GenCC gene–disease validity (every submitter) and Orphanet disorders.
| Parameter | In | Description | Example |
|---|---|---|---|
symbolrequired | path | HGNC gene symbol. | HBB |
curl -s \ "https://clinical.enigmagenomics.com/api/rare-disease/gene/HBB/"
/api/ontology/disease/{id}/PublicMONDO disease
Definition, inheritance, genes (Monarch) and ancestor/child graph (OLS4). OMIM and Orphanet IDs are mapped to MONDO.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | MONDO, OMIM or Orphanet ID. | MONDO:0011382 |
curl -s \ "https://clinical.enigmagenomics.com/api/ontology/disease/MONDO%3A0011382/"
/api/ontology/disease/{id}/phenotypes/PublicPhenotypes of a disease
HPO phenotypes annotated to a disease, with frequency and onset where given.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | MONDO disease ID. | MONDO:0011382 |
curl -s \ "https://clinical.enigmagenomics.com/api/ontology/disease/MONDO%3A0011382/phenotypes/"
/api/ontology/phenotype/{id}/PublicHPO term
Definition, synonyms, references and ancestor/child graph.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | HPO term ID. | HP:0001250 |
curl -s \ "https://clinical.enigmagenomics.com/api/ontology/phenotype/HP%3A0001250/"
/api/ontology/phenotype/{id}/associations/PublicGenes and diseases for an HPO term
Genes and diseases annotated directly to the term (Monarch Initiative).
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | HPO term ID. | HP:0001250 |
curl -s \ "https://clinical.enigmagenomics.com/api/ontology/phenotype/HP%3A0001250/associations/"
Literature
Articles, citations and variants mentioned in them.
/api/literature/variant/{id}/PublicPublications for a variant
Publications from LitVar2, Europe PMC, PubTator3 and PubMed. gene, hgvsp, hgvsc and rsid are optional hints.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
mode | query | Germline or somatic ranking.One of: germline, somatic | somatic |
gene | query | Gene symbol hint from the page (optional). | BRAF |
hgvsp | query | Protein change hint. | p.Val600Glu |
hgvsc | query | Coding change hint. | — |
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
mode | query | Germline or somatic ranking.One of: germline, somatic | somatic |
gene | query | Gene symbol hint from the page (optional). | BRAF |
hgvsp | query | Protein change hint. | p.Val600Glu |
hgvsc | query | Coding change hint. | — |
rsid | query | rsID hint. | rs113488022 |
curl -s \ "https://clinical.enigmagenomics.com/api/literature/variant/7-140753336-A-T/?mode=somatic&gene=BRAF&hgvsp=p.Val600Glu&rsid=rs113488022"
/api/article/{pmid}/PublicOne article
PubMed record and abstract, Europe PMC citation count and full-text links, PubTator3 concepts.
| Parameter | In | Description | Example |
|---|---|---|---|
pmidrequired | path | PubMed ID. | 12068308 |
curl -s \ "https://clinical.enigmagenomics.com/api/article/12068308/"
/api/article/{pmid}/citations/PublicArticles citing an article
The 100 most-cited or most recent citing articles from Europe PMC, with the total count.
| Parameter | In | Description | Example |
|---|---|---|---|
pmidrequired | path | PubMed ID. | 12068308 |
sort | query | Order.One of: cited, recent | cited |
curl -s \ "https://clinical.enigmagenomics.com/api/article/12068308/citations/?sort=cited"
/api/article/{pmid}/variants/PublicVariants mentioned in an article
Variants PubTator3 finds in the title and abstract, resolved to canonical variant IDs.
| Parameter | In | Description | Example |
|---|---|---|---|
pmidrequired | path | PubMed ID. | 12068308 |
curl -s \ "https://clinical.enigmagenomics.com/api/article/12068308/variants/"
Oncology
Somatic evidence, oncogenicity facts, tumour types, fusions and trials.
/api/somatic/variant/{id}/PublicSomatic evidence
CIViC, cBioPortal, GDC, Cancer Genome Interpreter and FDA companion diagnostics for a variant. Counts and public identifiers only.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/somatic/variant/7-140753336-A-T/"
/api/somatic/oncogenicity/{id}/PublicOncogenicity and tier evidence
Licence-free facts for the SVIG-UK oncogenicity and AMP/ASCO/CAP tier engines, which run in the browser.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | GRCh38 small variant as chrom-pos-ref-alt. | 7-140753336-A-T |
curl -s \ "https://clinical.enigmagenomics.com/api/somatic/oncogenicity/7-140753336-A-T/"
/api/somatic/oncotree/PublicOncoTree tumour types
Bundled OncoTree tumour types for the tumour-type picker.
Caching: One week. Sources: OncoTree (CC BY 4.0).
curl -s \ "https://clinical.enigmagenomics.com/api/somatic/oncotree/"
/api/fusion/{id}/PublicGene fusion
Evidence for an ordered gene pair.
| Parameter | In | Description | Example |
|---|---|---|---|
idrequired | path | Ordered gene pair (5′::3′). | BCR::ABL1 |
curl -s \ "https://clinical.enigmagenomics.com/api/fusion/BCR%3A%3AABL1/"
/api/trials/PublicClinical trials
ClinicalTrials.gov search (one page of 100 studies), the merged list for a variant or gene page (`scope`), or the country facet (`facet=countries`). A search needs at least one of cond, term, intr, locn or country; filters use ClinicalTrials.gov's own codes, so results match the same search on clinicaltrials.gov. Each study carries its eligible sex, minimum and maximum age and standard age groups (`ageGroups`: CHILD, ADULT, OLDER_ADULT).
Caching: Six hours. Sources: ClinicalTrials.gov (public domain).
| Parameter | In | Description | Example |
|---|---|---|---|
cond | query | Condition. | Breast Cancer |
term | query | Other terms (gene, protein change, keyword). | — |
intr | query | Intervention. | — |
locn | query | Location text (city, region). | — |
country | query | Country name or "gulf". | Saudi Arabia |
| Parameter | In | Description | Example |
|---|---|---|---|
cond | query | Condition. | Breast Cancer |
term | query | Other terms (gene, protein change, keyword). | — |
intr | query | Intervention. | — |
locn | query | Location text (city, region). | — |
country | query | Country name or "gulf". | Saudi Arabia |
status | query | Comma-separated status codes (rec, not, enr, act, ava, com, sus, ter, wit, unk …), or "active". In scope lists: active or all. | rec,not |
phase | query | Comma-separated phases (0, 1, 2, 3, 4, NA). | 2,3 |
type | query | Comma-separated study types (int, obs, exp). | — |
age | query | Comma-separated age groups the study accepts (ClinicalTrials.gov standard ages): child (birth–17), adult (18–64), older (65+). | child |
sex | query | Studies that accept this sex (studies open to all included). Leave out for all.One of: f, m | — |
funder | query | Comma-separated funder types (industry, nih, fed, other). | — |
sort | query | Sort order (default relevance).One of: relevance, updated, start, enrolment | — |
scope | query | Merged list for a page.One of: variant, gene | — |
variant | query | Variant ID when scope=variant. | — |
gene | query | Gene symbol when scope is set. | — |
hgvsp | query | HGVS protein change when scope=variant, e.g. p.Val600Glu. | — |
mode | query | Context list mode when scope is set.One of: germline, somatic | — |
facet | query | Facet list instead of studies.One of: countries | — |
page | query | Next-page token. | — |
curl -s \ "https://clinical.enigmagenomics.com/api/trials/?cond=Breast+Cancer&country=Saudi+Arabia&status=rec%2Cnot&phase=2%2C3&age=child"
Tools
Coordinate conversion between genome builds.
/api/liftover/PublicLift one position, variant, region or SV
Converts one line between GRCh38 (hg38), GRCh37 (b37) and hg19: a small variant (11-5227002-T-A, chr11:5227002:T:A), a position (7-140753336), a region (chr7:140753336-140753500) or an SV/MEI ID (8-127734450-127764981-DUP). Returns { from, to, results[1], sources }. A line that cannot be read or lifted comes back as a `failed` result, not a 400; reference bases are checked against the target build.
Caching: Server data cache and CDN; unreadable lines are kept for an hour. Sources: Ensembl REST assembly map and sequence.
| Parameter | In | Description | Example |
|---|---|---|---|
qrequired | query | One line (at most 300 characters). | 11-5227002-T-A |
from | query | Source build (default hg38). GRCh38 and GRCh37 are accepted.One of: hg38, b37, hg19 | hg38 |
to | query | Target build (default b37 from hg38, else hg38).One of: hg38, b37, hg19 | b37 |
curl -s \ "https://clinical.enigmagenomics.com/api/liftover/?q=11-5227002-T-A&from=hg38&to=b37"
/api/liftover/PublicLift a batch of lines
The batch form of GET /api/liftover/: send `queries` (an array of strings) or `text` (one query per line), with optional `from` and `to`. At most 500 lines of 300 characters each. Returns { from, to, results[], sources, error? }, one result per line in order; `error` reports lines that failed because Ensembl did not respond.
Caching: Not cached. Sources: Ensembl REST assembly map and sequence.
curl -s \
-X POST \
-H "Content-Type: application/json" \
-d '{"queries":["11-5227002-T-A","chr7:140753336-140753500"],"from":"hg38","to":"b37"}' \
"https://clinical.enigmagenomics.com/api/liftover/"Account
Records kept for the signed-in account.
/api/audit/Signed-in accountAppend an audit event
Appends one event to the tamper-evident (hash-chained) audit log. The account comes from the verified ID token, never from the body; the server sets the time and the chain hash. Any signed-in account may log its own activity, at most 60 events a minute. Returns 201 { stored: true, seq, hash }, or 202 { stored: false, reason } when the log store is not configured (local development).
Caching: Never cached (no-store).
curl -s \
-X POST \
-H "Authorization: Bearer $FIREBASE_ID_TOKEN" \
-H "Content-Type: application/json" \
-d '{"action":"view_variant","target":"7-140753336-A-T"}' \
"https://clinical.enigmagenomics.com/api/audit/"Meta
This description of the API.
/api/openapi.json/PublicThis OpenAPI document
OpenAPI 3.1 description of every endpoint listed here.
Caching: One hour.
curl -s \ "https://clinical.enigmagenomics.com/api/openapi.json/"