Biotools
users
Hint-KB 2
Human INTeractome Knowledge Base v 2.0
statistics
Statistics

HintKB Web API Services

HintKB tool provides some Representational State Transfer (REST) services to third party systems in order to integrate its functionalities.

List of API methods

HintKB web API provides ten services which can be invoked from third-party systems:

  1. Get Statistics
  2. Get all proteins
  3. Get PPIs by score
  4. Get PPIs with normalized features by score
  5. Get PPIs by a specific protein
  6. Get PPIs with normalized features by a specific protein
  7. Get a dataset of negative and positive PPIs
  8. Get a dataset of negative and positive PPIs where positives in HPRD
  9. Get a dataset of negative and positive PPIs with normalized features
  10. Get a dataset of negative and positive PPIs with normalized features where positives in HPRD
  11. Get list of EEMC Clusters for a specific protein
  12. Get list of all EEMC Clusters
  13. Get list of all EEMC Clusters with details
  14. Get list of EEMC Cluster's details by ID
  15. Get list of all functions
  16. Get function details by ID
  17. Get function details by GO Term
  18. Get protein's functions
  19. Get EEMC cluster's functions
Get Statistics
URL http://hintkb.ceid.upatras.gr/api/stats
Description Returns information regarding HintKB stored data.
Parameters
Return (text/html) JSON object with the statistics.
Object members
proteinsNumber of unique proteins.
ppiNumber of examined protein pairs.
verifiedNumber of experimentally verified protein interactions.
dateDate when Knowledge Base last updated.
clustersNumber of EEMC calculated clusters.
functionNumber of EEMC calculated functions.
protfuncNumber of EEMC function characterized proteins.
Example
{
    "proteins":"20845",
    "ppi":"614890",
    "verified":115405,
    "date":"01-12-2012",
    "clusters":"5345",
    "function":"39304",
    "protfunc":"12078",
}
                
Get all proteins
URL http://hintkb.ceid.upatras.gr/api/proteins
Description Returns the list of the proteins of HintKB.
Parameters
Return (text/html) Array of JSON objects defining each protein.
Object members
uniprot_idUNIPROT database ID.
gene_idGene Id.
entry_nameProtein's Name.
Example
[
    {
        "uniprot_id":"Q8TBF5",
        "gene_id":"54965",
        "entry_name":"PIGX_HUMAN"
    }
]
                
Get PPIs by score
URL http://hintkb.ceid.upatras.gr/api/ppi/byscore/{sign}/{th}
Description Returns the list of the PPIs according to the threshold (score) given.
Parameters
sign(String: pos|neg) "pos" for positives PPIs or "neg" for negatives PPIs.
th(Double) The threshold defining the return set.
Example
http://hintkb.ceid.upatras.gr/api/ppi/byscore/pos/0.075
                
Returns positives PPIs from threshold 0.075.
Return (application/octet-stream) Zipped CSV file (Tab delimetered) with the PPIs.
Get PPIs with normalized features by score
URL http://hintkb.ceid.upatras.gr/api/ppi/byscore/norm/{sign}/{th}
Description Returns the list of the PPIs with normalized features according to the threshold (score) given.
Parameters
sign(String: pos|neg) "pos" for positives PPIs or "neg" for negatives PPIs.
th(Double) The threshold defining the return set.
Example
http://hintkb.ceid.upatras.gr/api/ppi/byscore/norm/pos/0.075
                
Returns negatives PPIs with normalized features from threshold 0.075.
Return (application/octet-stream) Zipped CSV file (Tab delimetered) with the PPIs with normalized features.
Get PPIs by a specific protein
URL http://hintkb.ceid.upatras.gr/api/ppi/byprotein/{uniprot}
Description Returns the list of the PPIs where a specific protein is a member.
Parameters
uniprot(String) Protein's ID according to UNIPROT notation.
Example
http://hintkb.ceid.upatras.gr/api/ppi/byprotein/A0A575
                
Returns all PPIs where protein A0A575 is a member.
Return (application/octet-stream) Zipped CSV file (Tab delimetered) with the PPIs.
Get PPIs with normalized features by a specific protein
URL http://hintkb.ceid.upatras.gr/api/ppi/byprotein/norm/{uniprot}
Description Returns the list of the PPIs with normalized features where a specific protein is a member.
Parameters
uniprot(String) Protein's ID according to UNIPROT notation.
Example
http://hintkb.ceid.upatras.gr/api/ppi/byprotein/A0A575
                
Returns all PPIs where protein A0A575 is a member.
Return (application/octet-stream) Zipped CSV file (Tab delimetered) with the PPIs with normalized features.
Get a dataset of negative and positive PPIs
URL http://hintkb.ceid.upatras.gr/api/ppi/dataset/{pos}/{neg}
Description Returns the list of the PPIs included in the dataset created by the defined number of positives and negatives PPIs.
Parameters
pos(Integer) Number of positive PPis included in the dataset.
neg(Integer) Number of negative PPis included in the dataset.
Example
http://hintkb.ceid.upatras.gr/api/ppi/dataset/300/600
                
Returns a PPIs dataset with 300 positives and 600 negatives.
Return (application/octet-stream) Zipped CSV file (Tab delimetered) with the PPIs.
Get a dataset of negative and positive PPIs where positives in HPRD
URL http://hintkb.ceid.upatras.gr/api/ppi/dataset/hprd/{pos}/{neg}
Description Returns the list of the PPIs included in the dataset created by the defined number of positives and negatives PPIs. All positive PPIs will be in HPRD.
Parameters
pos(Integer) Number of positive PPis included in the dataset.
neg(Integer) Number of negative PPis included in the dataset.
Example
http://hintkb.ceid.upatras.gr/api/ppi/dataset/hprd/400/300
                
Returns a PPIs dataset with 400 positives and 300 negatives. All positive PPIs will be in HPRD.
Return (application/octet-stream) Zipped CSV file (Tab delimetered) with the PPIs.
Get a dataset of negative and positive PPIs with normalized features
URL http://hintkb.ceid.upatras.gr/api/ppi/dataset/norm/{pos}/{neg}
Description Returns the list of the PPIs with normalized features included in the dataset created by the defined number of positives and negatives PPIs.
Parameters
pos(Integer) Number of positive PPis included in the dataset.
neg(Integer) Number of negative PPis included in the dataset.
Example
http://hintkb.ceid.upatras.gr/api/ppi/dataset/norm/300/600
                
Returns a PPIs dataset with normalized features with 300 positives and 600 negatives.
Return (application/octet-stream) Zipped CSV file (Tab delimetered) with the PPIs with normalized features.
Get a dataset of negative and positive PPIs with normalized features where positives in HPRD
URL http://hintkb.ceid.upatras.gr/api/ppi/dataset/norm/hprd/{pos}/{neg}
Description Returns the list of the PPIs with normalized features included in the dataset created by the defined number of positives and negatives PPIs. All positive PPIs will be in HPRD.
Parameters
pos(Integer) Number of positive PPis included in the dataset.
neg(Integer) Number of negative PPis included in the dataset.
Example
http://hintkb.ceid.upatras.gr/api/ppi/dataset/norm/hprd/400/300
                
Returns a PPIs dataset with normalized features with 400 positives and 300 negatives. All positive PPIs will be in HPRD.
Return (application/octet-stream) Zipped CSV file (Tab delimetered) with the PPIs.
Get list of EEMC Clusters for a specific protein
URL http://hintkb.ceid.upatras.gr/api/clusters/byprotein/{uniprot}
Description Returns the list of the EEMC clusters where a specific protein is a member.
Parameters
uniprot(String) Protein's ID according to UNIPROT notation.
Example
http://hintkb.ceid.upatras.gr/api/clusters/byprotein/Q5T5X7
                
Returns all EEMC clusters where protein Q5T5X7 is a member.
Return (text/html) Array of JSON objects defining each cluster.
Object members
cluster_idCluster's ID.
Example
[
    {
        "cluster_id":"2307"
    },
    {
        "cluster_id":"5302"
    }
]
                
Get list of all EEMC Clusters
URL http://hintkb.ceid.upatras.gr/api/clusters
Description Returns the list of all the clusters and the corresponding number of proteins .
Parameters  
Return (text/html) Array of JSON objects defining each cluster.
Object members
cluster_idCluster's ID.
num_proteinsCluster's number of proteins.
Example
[
    {
        "cluster_id":"1",
        "num_proteins":"2"
    },
    {
        "cluster_id":"2",
        "num_proteins":"2"
    },

    ...
]
                
Get list of all EEMC Clusters with details
URL http://hintkb.ceid.upatras.gr/api/clusters/details
Description Returns the list of all the clusters with details regarding included proteins and corresponding functions.
Parameters  
Return (text/html) Array of JSON objects defining each cluster.
Object members
cluster_idCluster's ID.
gotermsCluster's functions (GO Terms) seperated by space.
proteinsCluster's proteins (UNIPROT ID) seperated by space.
Example
[
    {
        "cluster_id":"1",
        "goterms":"0005254",
        "proteins":"A0AV96 Q9C0H2"
    },
    {
        "cluster_id":"2",
        "goterms":"0001047 0003714",
        "proteins":"Q8NFC6 A0AVK6"
    },

    ...
]
                
Get list of EEMC Cluster's details by ID
URL http://hintkb.ceid.upatras.gr/api/clusters/details/bycluster/{cluster_id}
Description Returns the list of the EEMC clusters where a specific protein is a member.
Parameters
cluster_id(Integer) Cluster's ID.
Example
http://hintkb.ceid.upatras.gr//api/clusters/details/bycluster/2
                
Returns details about EEMC cluster with ID 2.
Return (text/html) Array of JSON objects defining cluster.
Object members
cluster_idCluster's ID.
gotermsCluster's functions (GO Terms) seperated by space.
proteinsCluster's proteins (UNIPROT ID) seperated by space.
Example
[
    {
        "cluster_id":"2",
        "goterms":"0001047 0003714",
        "proteins":"Q8NFC6 A0AVK6"
    }
]
                
Get list of all functions
URL http://hintkb.ceid.upatras.gr/api/functions
Description Returns the list of all functions.
Parameters  
Return (text/html) Array of JSON objects defining each function.
Object members
function_idFunctions's ID.
go_termFunctions's Gene Ontology Term.
function_nameFunctions's name.
function_namespaceFunctions's Name Space.
Example
[
    {
        "function_id":"1",
        "go_term":"0000001",
        "function_name":"mitochondrion inheritance",
        "function_namespace":"biological_process"
    },
    {
        "function_id":"2",
        "go_term":"0000002",
        "function_name":"mitochondrial genome maintenance",
        "function_namespace":"biological_process"
    },

    ...
]
                
Get function details by ID
URL http://hintkb.ceid.upatras.gr/api/functions/details/byfunction/{func_id}
Description Returns a function's details by function ID.
Parameters
func_id(Integer) Function's ID.
Example
http://hintkb.ceid.upatras.gr/api/functions/details/byfunction/667
                
Returns proteins and clusters related with function with ID 667.
Return (text/html)JSON object defining function.
Object members
function_idFunctions's ID.
clustersArray of cluster IDs.
proteinsArray of proteins IDs.
go_termFunctions's Gene Ontology Term.
function_nameFunctions's name.
function_namespaceFunctions's Name Space.
Example
{
    "function_id":"667",
    "clusters":["468","775","1116","1531","1543","1546","1637",
                "1749","2149","2761","2853","3396","4648","4730","5071"],
    "proteins":["F8W7V7","O14813","O43889","O95936","P15036","P15173",
                "P15407","P15408","P15531","P15976","P17275","P25791","P43694",
                "Q02078","Q06413","Q10586","Q13761","Q14814","Q16649","Q99593",
                "Q9HBD4","Q9UJU2","Q9UJU5","Q9UMR3"],
    "go_term":"0000977",
    "function_name":"RNA polymerase II regulatory region sequence-specific DNA binding",
    "function_namespace":"molecular_function"
}
                
Get function details by GO Term
URL http://hintkb.ceid.upatras.gr/api/functions/details/bygoterm/{goterm}
Description Returns a function's details by Gene Ontology Term.
Parameters
goterm(String) Function's GO Term.
Example
http://hintkb.ceid.upatras.gr/api/functions/details/bygoterm/0000977
                
Returns proteins and clusters related with function with GO Term 0000977.
Return (text/html)JSON object defining function.
Object members
function_idFunctions's ID.
clustersArray of cluster IDs.
proteinsArray of proteins IDs.
go_termFunctions's Gene Ontology Term.
function_nameFunctions's name.
function_namespaceFunctions's Name Space.
Example
{
    "function_id":"667",
    "clusters":["468","775","1116","1531","1543","1546","1637",
                "1749","2149","2761","2853","3396","4648","4730","5071"],
    "proteins":["F8W7V7","O14813","O43889","O95936","P15036","P15173",
                "P15407","P15408","P15531","P15976","P17275","P25791","P43694",
                "Q02078","Q06413","Q10586","Q13761","Q14814","Q16649","Q99593",
                "Q9HBD4","Q9UJU2","Q9UJU5","Q9UMR3"],
    "go_term":"0000977",
    "function_name":"RNA polymerase II regulatory region sequence-specific DNA binding",
    "function_namespace":"molecular_function"
}
                
Get protein's functions
URL http://hintkb.ceid.upatras.gr/api/functions/byprotein/{uniprot}
Description Returns a protein's functions.
Parameters
uniprot(String) Protein's ID according to UNIPROT notation.
Example
http://hintkb.ceid.upatras.gr/api/functions/byprotein/Q9H1E3
                
Returns functions of protein with UNIPROT ID Q9H1E3.
Return (text/html) Array of JSON objects defining each function.
Object members
function_idFunctions's ID.
go_termFunctions's Gene Ontology Term.
function_nameFunctions's name.
function_namespaceFunctions's Name Space.
Example
[
    {
        "function_id":"4426",
        "go_term":"0005634",
        "function_name":"nucleus",
        "function_namespace":"cellular_component"
    },
    {
        "function_id":"4518",
        "go_term":"0005737",
        "function_name":"cytoplasm",
        "function_namespace":"cellular_component"
    }
]
                
Get EEMC cluster's functions
URL http://hintkb.ceid.upatras.gr/api/functions/bycluster/{cluster_id}
Description Returns a EEMC cluster's functions.
Parameters
cluster_id(Integer) Cluster's ID.
Example
http://hintkb.ceid.upatras.gr/api/functions/bycluster/2
                
Returns functions of cluster with ID 2.
Return (text/html) Array of JSON objects defining each function.
Object members
function_idFunctions's ID.
go_termFunctions's Gene Ontology Term.
function_nameFunctions's name.
function_namespaceFunctions's Name Space.
Example
[
    {
        "function_id":"736",
        "go_term":"0001047",
        "function_name":"core promoter binding",
        "function_namespace":"molecular_function"
    },
    {
        "function_id":"2824",
        "go_term":"0003714",
        "function_name":"transcription corepressor activity",
        "function_namespace":"molecular_function"
    }
]
                

Developed under the support of Computational Biology and Bioinformatics Group and Pattern Recognition Laboratory of Department of Computer Engineering & Informatics of University of Patras

Human INTeractome Knowledge Base v2.0 2013 - 2017 © Pattern Recognition Laboratory

Creative Commons Licence
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.

Sign In
Fields with * are required.
If you haven't sign in to our tool, we encourage you to complete our registration form.
Create Account