Web Services

The web services are available to retrieve the data in JSON or HTML formats from a client based in a RESTful service

RESTful URLs

Retrieve all SNP data

1. Search SNP by ID, HTML format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snp/?name=rs7417106
2. Search SNP by ID, JSON format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snp/?name=rs7417106&format=json

Retrieve calculated data

1. Search SNP by ID, HTML format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?name=rs7417106
2. Search SNP by ID, JSON format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?name=rs7417106&format=json
3. Search SNP by Gene name, HTML format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?gene_name=DDX11L1
4. Search SNP by Gene name, JSON format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?gene_name=DDX11L1&format=json
5. Search SNPs by chromosome, HTML format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?chr=chr1
6. Search SNPs by chromosome, JSON format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?chr=chr1&format=json
7. Search SNPs by chromosome and region, HTML format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?chr=chr1&start=0&end=3369847
8. Search SNPs by chromosome and region, JSON format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?chr=chr1&start=0&end=3369847&format=json
9. Search SNPs by method: CAPE eQTL (use method's number as shown in Methods), HTML format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?method=1
10. Search SNPs by method: CAPE eQTL (use method's number as shown in Methods), JSON format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?method=1&format=json
11. Search SNPs by tissue: GM12878 Lymphoblastoid Cells (use tissue's number as shown in Tissues), HTML format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?tissue=33
12. Search SNPs by tissue: GM12878 Lymphoblastoid Cells (use tissue's number as shown in Tissues), JSON format: https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?tissue=33&format=json

Results in JSON format

The results in JSON format for the calculated data follows the next syntax:

{
    "count": 4059,
    "next": "https://www.ncbi.nlm.nih.gov/api/snpdata/?page=2",
    "previous": null,
    "results": [
        {
            "name": "rs7417106",
            "pos": 911595,
            "ref": "A",
            "alt": "G",
            "chr": "chr1",
            "method": "CAPE eQTL",
            "tissue": "GM12878 Lymphoblastoid Cells",
            "value": 0.00483957
    ]
}

Global Fields

• count: total number of SNPs retrieved
• next: URL to be used to retrieve the next set of results
• previous: URL to be used to retrieve the previous set of results
• results: List of results

SNP Fields

• name: SNP ID
• pos: SNP position
• ref: SNP reference
• alt: SNP alternative
• chr: Chromosome
• method: Method used to calculate the prediction
• tissue: Tissue used
• value: Prediction value

Combining options

All options can be used together to retrieve the specific data. For example, to retrieve the list of SNPs in the region: chr5:5689-758812640 calculated with the method CAPE eQTL

https://www.ncbi.nlm.nih.gov/research/snpdelscore/api/snpdata/?chr=chr5&start=5689&end=758812640&&method=1