Quickstart
This guide will get you all set up and ready to use the FAVOR API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Choosing an API client
We will use cURL in this guide.
We plan to provide first-party SDKs for the most popular programming languages. If you want to help us out, please get in touch
# cURL is most likely already installed on your machine
curl --version
Making your first API request
Below, you can see how to send a GET request to the variants endpoint to get a variant by its variant_vcf.
GET
/v1/variants/19-44908822-C-Tcurl -G https://api.genohub.org/v1/variants/19-44908822-C-T
Output
/v1/variants/19-44908822-C-T{
"variant_vcf": "19-44908822-C-T",
"chromosome": "19",
"position": "44908822",
"bravo_an": 264690,
"bravo_ac": 20678,
"bravo_af": 0.0781216,
"filter_status": "PASS",
"rsid": "rs7412",
"genecode_comprehensive_category": "exonic",
"genecode_comprehensive_info": "APOE",
"genecode_comprehensive_exonic_category": "nonsynonymous SNV",
"genecode_comprehensive_exonic_info":
"APOE:ENST00000446996.5:exon4:c.C526T:p.R176C,APOE:ENST00000434152.5:exon4:c.C604T:p.R202C,APOE:ENST00000252486.9:exon4:c.C526T:p.R176C,APOE:ENST00000425718.1:exon3:c.C526T:p.R176C,",
"ucsc_info": "ENST00000252486.8,ENST00000425718.1,ENST00000434152.5,ENST00000446996.5",
"ucsc_exonic_info":
"ENST00000446996.5:ENST00000446996.5:exon4:c.C526T:p.R176C,ENST00000434152.5:ENST00000434152.5:exon4:c.C604T:p.R202C,ENST00000425718.1:ENST00000425718.1:exon3:c.C526T:p.R176C,ENST00000252486.8:ENST00000252486.8:exon4:c.C526T:p.R176C,",
"polyphen2_hdiv_score": 1,
// ...
}
What's next?
Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the FAVOR API: