POST /api/v1/pept2interpro
Returns the functional InterPro entries associated with a given tryptic peptide.
This method returns the functional InterPro entries associated with a given tryptic peptide.
Request
The pept2interpro method can be used by doing a HTTP POST-request (preferred) or GET-request to http://api.unipept.ugent.be/api/v1/pept2interpro
. Parameters can be included in the request body (POST) or in the query string (GET). The only required parameter is input[]
, which takes one or more tryptic peptides.
input
input[]
is a required parameter that takes one or more tryptic peptides. Unipept will return the functional InterPro entries associated with each of the input[]
peptides based on their occurrence in UniProt entries. To pass multiple peptides at once, simply add multiple input[]
parameters (see example).
Input size
Unipept puts no restrictions on the number of peptides passed to the input[]
parameter. Keep in mind that searching for lots of peptides at once may cause the request to timeout or, in the case of a GET-request, exceed the maximum URL length. When performing bulk searches, we suggest splitting the input set over requests of 100 peptides each.
equate_il
equate_il
is an optional parameter and can either be true
or false
. When not set explicitly, the parameter defaults to false
. When the parameter is set to true
, isoleucine (I) and leucine (L) are equated when matching tryptic peptides to UniProt entries. This setting is similar to checking the Equate I and L? checkbox when performing a search with the Tryptic Peptide Analysis in the web interface.
extra
extra
is an optional parameter and can either be true
or false
. When not set explicitly, the parameter defaults to false
. When the parameter is set to true
, Unipept will also return the name and type associated with each InterPro entry. See the response section for an overview of the information fields returned.
domains
domains
is an optional parameter that can be used to separate the InterPro entries in groups according to their type (domain, family, homologous superfamily, repeat, conserved site, active site, binding site, PTM).
Performance penalty
Setting extra
to true
has a performance penalty inferred from additional database queries. Do not use this parameter unless the extra information fields are needed.
Response
A list of JSON objects is returned. By default, each object contains the following information fields:
peptide
: The peptide that was searched for.total_protein_count
: Total amount of proteins matched with the given peptide.ipr
: A list of JSON objects that each represent an InterPro entry associated with the current tryptic peptide.code
: InterPro entry code associated with the current tryptic peptide.protein_count
: amount of proteins matched with the given tryptic peptide that are labeled with the current InterPro code.name
: Optional, name of the InterPro entry. Included when theextra
parameter is set totrue
.type
: Optional, type of the InterPro entry. Included when theextra
parameter is set totrue
.
Parameters
Name | Description |
---|---|
input[] required |
Tryptic peptide to search for. Add multiple parameters to search for multiple peptides. Value: String |
equate_il optional |
Equate isoleucine (I) and leucine (L). Value: Must betrue or false (default)
|
extra optional |
Return additional information fields if true or false (default)
|
domains optional |
Separates InterPro entries in groups according to their type true or false (default)
|
Examples
Example Retrieve the functional InterPro entries associated with a given tryptic peptide
This example retrieves all functional InterPro entries associated with the tryptic peptide AAAAA. POST
$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2interpro \ -d 'input[]=AAAAA'GET
http://api.unipept.ugent.be/api/v1/pept2interpro.json?input[]=AAAAA
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ipr': [
{
'code': 'IPR020867',
'protein_count': 14
},
{
'code': 'IPR036291',
'protein_count': 14
},
{
'code': 'IPR020630',
'protein_count': 14
}
{
'code': 'IPR020631',
'protein_count': 14
}
{
'code': 'IPR000672',
'protein_count': 14
}
{
'code': 'IPR007634',
'protein_count': 1
}
{
'code': 'IPR038709',
'protein_count': 1
}
{
'code': 'IPR001296',
'protein_count': 1
}
{
'code': 'IPR000394',
'protein_count': 1
}
{
'code': 'IPR003181',
'protein_count': 1
}
{
'code': 'IPR013534',
'protein_count': 1
}
{
'code': 'IPR029053',
'protein_count': 1
}
{
'code': 'IPR007046',
'protein_count': 1
}
{
'code': 'IPR011835',
'protein_count': 1
}
{
'code': 'IPR003182',
'protein_count': 1
}
]
}
]
Example Retrieve the functional InterPro entries associated with each of multiple tryptic peptides
This example retrieves the functional InterPro entries for both the tryptic peptides AAAAA and AAAYGMR. POST
$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2interpro \ -d 'input[]=AAAAA' \ -d 'input[]=AAAYGMR'GET
http://api.unipept.ugent.be/api/v1/pept2interpro.json?input[]=AAAAA&input[]=AAAYGMR
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ipr': [
{
'code': 'IPR020867',
'protein_count': 14
},
{
'code': 'IPR036291',
'protein_count': 14
},
{
'code': 'IPR020630',
'protein_count': 14
}
{
'code': 'IPR020631',
'protein_count': 14
}
{
'code': 'IPR000672',
'protein_count': 14
}
{
'code': 'IPR007634',
'protein_count': 1
}
{
'code': 'IPR038709',
'protein_count': 1
}
{
'code': 'IPR001296',
'protein_count': 1
}
{
'code': 'IPR000394',
'protein_count': 1
}
{
'code': 'IPR003181',
'protein_count': 1
}
{
'code': 'IPR013534',
'protein_count': 1
}
{
'code': 'IPR029053',
'protein_count': 1
}
{
'code': 'IPR007046',
'protein_count': 1
}
{
'code': 'IPR011835',
'protein_count': 1
}
{
'code': 'IPR003182',
'protein_count': 1
}
]
},
{
'peptide': 'AAAYGMR',
'total_protein_count': 2,
'ipr': [
{
'code': 'IPR027417',
'protein_count': 1
}
{
'code': 'IPR000185',
'protein_count': 1
}
{
'code': 'IPR011130',
'protein_count': 1
}
{
'code': 'IPR036670',
'protein_count': 1
}
{
'code': 'IPR036463',
'protein_count': 1
}
{
'code': 'IPR036461',
'protein_count': 1
}
{
'code': 'IPR011115',
'protein_count': 1
}
{
'code': 'IPR008223',
'protein_count': 1
}
{
'code': 'IPR002019',
'protein_count': 1
}
{
'code': 'IPR002026',
'protein_count': 1
}
{
'code': 'IPR014018',
'protein_count': 1
}
{
'code': 'IPR020937',
'protein_count': 1
}
]
}
]
Example Retrieve the functional InterPro entries associated with a single tryptic peptide, while equating I and L
This example retrieves the functional InterPro entries associated with the tryptic peptide AAAAA. In searching, isoleucine (I) and leucinge (L) are considered equal. POST
$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2interpro \ -d 'input[]=AAAAA' \ -d 'equate_il=true'GET
http://api.unipept.ugent.be/api/v1/pept2interpro.json?input[]=AAAAA&equate_il=true
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ipr': [
{
'code': 'IPR020867',
'protein_count': 14
},
{
'code': 'IPR036291',
'protein_count': 14
},
{
'code': 'IPR020630',
'protein_count': 14
}
{
'code': 'IPR020631',
'protein_count': 14
}
{
'code': 'IPR000672',
'protein_count': 14
}
{
'code': 'IPR007634',
'protein_count': 1
}
{
'code': 'IPR038709',
'protein_count': 1
}
{
'code': 'IPR001296',
'protein_count': 1
}
{
'code': 'IPR000394',
'protein_count': 1
}
{
'code': 'IPR003181',
'protein_count': 1
}
{
'code': 'IPR013534',
'protein_count': 1
}
{
'code': 'IPR029053',
'protein_count': 1
}
{
'code': 'IPR007046',
'protein_count': 1
}
{
'code': 'IPR011835',
'protein_count': 1
}
{
'code': 'IPR003182',
'protein_count': 1
}
]
}
]
Example Retrieve the functional InterPro entries associated with a single tryptic peptide, with extra information enabled
This example retrieves the functional InterPro entries associated with the tryptic peptide AAAAA including the name and type of each InterPro entry. POST
$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2interpro \ -d 'input[]=AAAAA' \ -d 'extra=true'GET
http://api.unipept.ugent.be/api/v1/pept2interpro.json?input[]=AAAAA&extra=true
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ipr': [
{
'code': 'IPR020867',
'protein_count': 14,
'name': 'Tetrahydrofolate dehydrogenase/cyclohydrolase, conserved site',
'type': 'Conserved_site'
},
{
'code': 'IPR036291',
'protein_count': 14,
'name': 'NAD(P)-binding domain superfamily',
'type': 'Homologous_superfamily'
},
{
'code': 'IPR020630',
'protein_count': 14,
'name': 'Tetrahydrofolate dehydrogenase/cyclohydrolase, conserved site',
'type': 'Conserved_site'
}
{
'code': 'IPR020631',
'protein_count': 14,
'name': 'Tetrahydrofolate dehydrogenase/cyclohydrolase, NAD(P)-binding domain',
'type': 'Domain'
}
{
'code': 'IPR000672',
'protein_count': 14,
'name': 'Tetrahydrofolate dehydrogenase/cyclohydrolase',
'type': 'Family'
}
{
'code': 'IPR007634',
'protein_count': 1,
'name': 'RNA polymerase sigma factor 54, DNA-binding',
'type': 'Domain'
}
{
'code': 'IPR038709',
'protein_count': 1,
'name': 'RNA polymerase sigma-54 factor, core-binding domain superfamily',
'type': 'Homologous_superfamily'
}
{
'code': 'IPR001296',
'protein_count': 1,
'name': 'Glycosyl transferase, family 1',
'type': 'Domain'
}
{
'code': 'IPR000394',
'protein_count': 1,
'name': 'RNA polymerase sigma factor 54',
'type': 'Family'
}
{
'code': 'IPR003181',
'protein_count': 1,
'name': 'Large coat protein',
'type': 'Family'
}
{
'code': 'IPR013534',
'protein_count': 1,
'name': 'Starch synthase, catalytic domain',
'type': 'Domain'
}
{
'code': 'IPR029053',
'protein_count': 1,
'name': 'Viral coat protein subunit',
'type': 'Homologous_superfamily'
}
{
'code': 'IPR007046',
'protein_count': 1,
'name': 'RNA polymerase sigma factor 54, core-binding domain',
'type': 'Domain'
}
{
'code': 'IPR011835',
'protein_count': 1,
'name': 'Bacterial/plant glycogen synthase',
'type': 'Family'
}
{
'code': 'IPR003182',
'protein_count': 1,
'name': 'RNA2 polyprotein',
'type': 'Family'
}
]
}
]
Example Retrieve the functional InterPro entries associated with a single tryptic peptide, making a distinction between different types
This example retrieves the functional InterPro entries associated with the tryptic peptide AAAAA distributed over the distinct InterPro types. POST
$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2interpro \ -d 'input[]=AAAAA' \ -d 'domains=true'GET
http://api.unipept.ugent.be/api/v1/pept2interpro.json?input[]=AAAAA&domains=true
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ipr': [
{
'conserved_site': [
{
'code': 'IPR020867',
'protein_count': 14
}
]
},
{
'Homologous_superfamily': [
{
'code': 'IPR036291',
'protein_count': 14
},
{
'code': 'IPR038709',
'protein_count': 1
},
{
'code': 'IPR029053',
'protein_count': 1
}
]
},
{
'Domain': [
{
'code': 'IPR020630',
'protein_count': 14
},
{
'code': 'IPR020631',
'protein_count': 14
},
{
'code': 'IPR007634',
'protein_count': 1
},
{
'code': 'IPR001296',
'protein_count': 1
},
{
'code': 'IPR013534',
'protein_count': 1
},
{
'code': 'IPR007046',
'protein_count': 1
}
]
},
{
'Family': [
{
'code': 'IPR000672',
'protein_count': 14
},
{
'code': 'IPR000394',
'protein_count': 14
},
{
'code': 'IPR003181',
'protein_count': 1
},
{
'code': 'IPR011835',
'protein_count': 1
},
{
'code': 'IPR003182',
'protein_count': 1
}
]
}
]
}
]
Try it
Use the API explorer form below to call the pept2interpro method on live data and see the response.
Request
Response