REST API
DOCUMENTATION

Versions

Version Date Author Description
1.0.0 13‑12‑2017 Gerardo Lagunes García Initial draft
1.1.0 09‑05‑2018 Gerardo Lagunes García Update the phenotypical layer
1.2.0 23‑09‑2020 David Fernández Lobón
Lucía Prieto Santamaría
Add new API endpoints for querying DISNET's biological layer
1.3.0 26‑04‑2021 Marina Díaz Uzquiano Change token authorization to optional
1.4.0 30‑01‑2021 Marina Díaz Uzquiano Add new API endpoints for querying the pharmacology layer
1.5.0 30‑11‑2021 Marina Díaz Uzquiano Update the phenotypical layer with new endpoints and remove old ones
1.6.0 21‑02‑2022 Marina Díaz Uzquiano Add mapping endpoints

Getting Started

Base URL

disnet.ctb.upm.es/api/disnet

Scheme

HTTPS

Requirements

The use of a token is not required to query this API. However, if a user wants to keep a history of their requests, they can send requests to the API using the token given upon signing up DISNET.

Quick Start
  1. Select a tool. There are two ways to visualize the responses to your API requests: 1) with a Web viewer, use the one of your preference (Opera, Chrome, Firefox, Safari, IE, among others) or 2) some program that allow to consume Web services, we recommend using Postman, available for Windows, Mac OS X, Linux, and Chrome users in its official Web page https://www.getpostman.com.
  2. Select your service of interest from the service list.
  3. Build your request after setting the path variables or request parameters according to each service.
  4. Send the request.
  5. Visualize the response.

Introduction

We have divided the DISNET API into four sections: three corresponding to each layer in our database (phenotypical, biological, and pharmacological), plus one to map identifiers between layers.

In the following Service List, you can find each endpoint by layer with a short description of their function.

You can also import the following Collection to Postman and get examples for querying all the API endpoints.

download icon Download Postman Collection

Services

Phenotype layer
Query path Short description
1 /pheno/sources Retrieve source list
2 /pheno/snapshots Retrieve all snapshots for a given source
3 /pheno/disnet‑diseases Retrieve the list of diseases defined by a disnet id
4 /pheno/disnet‑diseases?name={name} Search disnet diseases by name
5 /pheno/disnet‑diseases/{disnet‑id}/url Retrieve the urls associated to a disease belonging to a certain source and snapshot
6 /pheno/disnet‑diseases/
{disnet‑id}/symptoms
Retrieve diseases with more DISNET Concepts for a given source and snapshot
7 /pheno/symptoms Retrieve all symptoms in the phenotypic layer
8 /pheno/symptoms?name={name} Search symptoms by name
9 /pheno/symptoms/{cui}/disnet‑diseases Get the list of disnet diseases presenting a certain symptom in their clinical picture
10 /pheno/metadata Retrieve metadata for a given source and snapshot
Biology layer
Query path Short description
12 /bio/diseases Retrieve all diseases from the biology layer
13 /bio/diseases?name={name} Retrieve the disease id of a given disease name
14 /bio/diseases/{disease‑id}/genes Retrieve genes associated to a given disease
15 /bio/diseases/{disease‑id}/variants Retrieve variants associated to a given disease
16 /bio/genes Retrieve all genes in the biology layer
17 /bio/genes/{gene‑id} Retrieve information about a given gene
18 /bio/genes/{gene‑id}/diseases Retrieve diseases associated to a given gene
19 /bio/genes/{gene‑id}/proteins Retrieve proteins associated to a gene
20 /bio/genes/{gene‑id}/pathways Retrieve pathways associated to a given gene
21 /bio/genes/{gene‑id}/variants Retrieve variants associated to a given gene
22 /bio/variants Retrieve all variants in DISNET's biological layer
23 /bio/variants/{variant‑id} Retrieve information of a given variant
24 /bio/variants/{variant‑id}/diseases Retrieve diseases associated to a given variant
25 /bio/variants/{variant‑id}/genes Retrieve genes associated to a given variant
26 /bio/pathways Retrieve all pathways in the biology layer
27 /bio/pathways/{pathway‑id} Retrieve pathway information
28 /bio/pathways/{pathway‑id}/genes Retrieve genes involved in the given pathway
29 /bio/proteins Retrieve all proteins in the biology layer
30 /bio/proteins/{protein‑id}/genes Retrieve genes associated to a given protein
31 /bio/ppis Retrieve all PPIs in the biology layer
Pharmacology layer
Query path Short description
32 /pharma/diseases Retrieve all diseases in the pharmacology layer
33 /pharma/diseases?name={name} Search by name and retrieve information about a disease in the pharmacology layer
34 /pharma/diseases?id={id} Search by id and retrieve information about a disease in the pharmacology layer
35 /pharma/diseases/{disease‑id}/drugs Retrieve all drugs associated to a disease in the pharmacology layer
36 /pharma/phenotypes Retrieve all phenotype effects
37 /pharma/phenotypes?name={name} Search by name and retrieve information about a phenotype effect
38 /pharma/phenotypes?id={id} Search by id and retrieve information about a phenotype effect
39 /pharma/phenotypes/
{phenotype‑id}/drugs
Retrieve all drugs associated to a phenotype effect
40 /pharma/drugs Retrieve all drugs
41 /pharma/drugs?name={name} Search by name and retrieve information about a drug
42 /pharma/drugs?id={id} Search by name and retrieve information about a drug
43 /pharma/drugs/{drug‑id}/diseases Retrieve all diseases in the pharmacology layer associated to a drug
44 /pharma/drugs/{drug‑id}/phenotypes Retrieve all phenotype effects associated to a drug
45 /pharma/drugs/{drug‑id}/targets Retrieve all targets to a specific drug
46 /pharma/drugs/{drug‑id}/interactions Find drugs that interact with the query drug
47 /pharma/drugs/{drug1‑id}/interactions/
{drug2‑id}/phenotypes
Find phenotype effects produced by drug-drug interactions
48 /pharma/targets Retrieve all targets
49 /pharma/targets?name={name} Search by name and retrieve information about a target
50 /pharma/targets?id={id} Search by id and retrieve information about a target
51 /pharma/targets/{target‑id}/drugs Retrieve all drugs associated to a target
Layer Mappings
Query path Short description
52 /maps/{disnet‑id}/cui‑maps Map a disnetId to its equivalent cui(s) with their mapping source and vocabulary
53 /maps/{cui}/disnet‑id‑maps Map a cui to its equivalent disnetId(s) with their mapping source and vocabulary