Variants
curl --request GET \
--url https://catalog-api-dev.demo.igvf.org/api/variantsimport requests
url = "https://catalog-api-dev.demo.igvf.org/api/variants"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://catalog-api-dev.demo.igvf.org/api/variants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"_id": "<string>",
"chr": "<string>",
"pos": 123,
"ref": "<string>",
"alt": "<string>",
"annotations": {
"bravo_af": 123,
"gnomad_af_total": 123,
"gnomad_af_afr": 123,
"gnomad_af_afr_female": 123,
"gnomad_af_afr_male": 123,
"gnomad_af_ami": 123,
"gnomad_af_ami_female": 123,
"gnomad_af_ami_male": 123,
"gnomad_af_amr": 123,
"gnomad_af_amr_female": 123,
"gnomad_af_amr_male": 123,
"gnomad_af_asj": 123,
"gnomad_af_asj_female": 123,
"gnomad_af_asj_male": 123,
"gnomad_af_eas": 123,
"gnomad_af_eas_female": 123,
"gnomad_af_eas_male": 123,
"gnomad_af_female": 123,
"gnomad_af_fin": 123,
"gnomad_af_fin_female": 123,
"gnomad_af_fin_male": 123,
"gnomad_af_male": 123,
"gnomad_af_nfe": 123,
"gnomad_af_nfe_female": 123,
"gnomad_af_nfe_male": 123,
"gnomad_af_oth": 123,
"gnomad_af_oth_female": 123,
"gnomad_af_oth_male": 123,
"gnomad_af_sas": 123,
"gnomad_af_sas_male": 123,
"gnomad_af_sas_female": 123,
"gnomad_af_raw": 123,
"GENCODE_category": "<string>",
"funseq_description": "<string>"
},
"source": "<string>",
"source_url": "<string>",
"organism": "<string>",
"rsid": [
"<string>"
],
"spdi": "<string>",
"hgvs": "<string>",
"ca_id": "<string>",
"strain": [
"<string>"
],
"qual": "<string>",
"files_filesets": "<string>"
}
]{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}API Reference
Variants
Retrieve genetic variants.
Example: organism = Homo sapiens or Mus musculus.
mouse_strain = CAST_EiJ (only for mouse variants).
The examples below are specific to Homo sapiens:
region = chr1:1157520-1158189 (maximum length: 10kb),
GENCODE_category = coding or noncoding (only for human variants),
rsid = rs58658771,
spdi = NC_000020.11:3658947:A:G,
hgvs = NC_000020.11:g.3658948A>G,
ca_id = CA739473472,
variant_id = NC_000020.11:3658947:A:G.
The limit parameter controls the page size and can not exceed 500.
Pagination is 0-based.
Variants
curl --request GET \
--url https://catalog-api-dev.demo.igvf.org/api/variantsimport requests
url = "https://catalog-api-dev.demo.igvf.org/api/variants"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://catalog-api-dev.demo.igvf.org/api/variants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"_id": "<string>",
"chr": "<string>",
"pos": 123,
"ref": "<string>",
"alt": "<string>",
"annotations": {
"bravo_af": 123,
"gnomad_af_total": 123,
"gnomad_af_afr": 123,
"gnomad_af_afr_female": 123,
"gnomad_af_afr_male": 123,
"gnomad_af_ami": 123,
"gnomad_af_ami_female": 123,
"gnomad_af_ami_male": 123,
"gnomad_af_amr": 123,
"gnomad_af_amr_female": 123,
"gnomad_af_amr_male": 123,
"gnomad_af_asj": 123,
"gnomad_af_asj_female": 123,
"gnomad_af_asj_male": 123,
"gnomad_af_eas": 123,
"gnomad_af_eas_female": 123,
"gnomad_af_eas_male": 123,
"gnomad_af_female": 123,
"gnomad_af_fin": 123,
"gnomad_af_fin_female": 123,
"gnomad_af_fin_male": 123,
"gnomad_af_male": 123,
"gnomad_af_nfe": 123,
"gnomad_af_nfe_female": 123,
"gnomad_af_nfe_male": 123,
"gnomad_af_oth": 123,
"gnomad_af_oth_female": 123,
"gnomad_af_oth_male": 123,
"gnomad_af_sas": 123,
"gnomad_af_sas_male": 123,
"gnomad_af_sas_female": 123,
"gnomad_af_raw": 123,
"GENCODE_category": "<string>",
"funseq_description": "<string>"
},
"source": "<string>",
"source_url": "<string>",
"organism": "<string>",
"rsid": [
"<string>"
],
"spdi": "<string>",
"hgvs": "<string>",
"ca_id": "<string>",
"strain": [
"<string>"
],
"qual": "<string>",
"files_filesets": "<string>"
}
]{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Query Parameters
Available options:
coding, noncoding Available options:
129S1_SvImJ, A_J, CAST_EiJ, NOD_ShiLtJ, NZO_HlLtJ, PWK_PhJ, WSB_EiJ Available options:
Mus musculus, Homo sapiens Response
Successful response
Show child attributes
Show child attributes