POST /api/v1/pept2ec
Returns the functional EC-numbers associated with a given tryptic peptide.
This method returns the functional EC-numbers associated with a given tryptic peptide. This is the same information as provided when performing a search with the Tryptic Peptide Analysis in the web interface.
Request
The pept2ec method can be used by doing a HTTP POST-request (preferred) or GET-request to http://api.unipept.ugent.be/api/v1/pept2ec
. 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 EC-numbers 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 associated with an EC-number. See the response section for an overview of the information fields returned.
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.ec
: A list of JSON objects that each represent an EC-number associated with the current tryptic peptide.ec_number
: EC-number associated with the current tryptic peptide.protein_count
: amount of proteins matched with the given tryptic peptide that are labeled with the current EC-number.name
: Optional, name of the EC-number. 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)
|
Examples
Example Retrieve the functional ec-numbers associated with a given tryptic peptide
This example retrieves all functional ec-numbers associated with the tryptic peptide AAAAA. The result is the same as this search with the Tryptic Peptide Analysis in the web interface.
POST$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2ec \ -d 'input[]=AAAAA'GET
http://api.unipept.ugent.be/api/v1/pept2ec.json?input[]=AAAAA
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ec': [
{
'ec_number': '1.5.1.5',
'protein_count': 14
},
{
'ec_number': '3.5.4.9',
'protein_count': 14
},
{
'ec_number': '2.4.1.21',
'protein_count': 1
}
]
}
]
Example Retrieve the functional ec-numbers associated with each of multiple tryptic peptides
This example retrieves the functional ec-numbers for both the tryptic peptides AAAAA and AAAYGMR. The result is the same as the combination of this search and this search with the Tryptic Peptide Analysis in the web interface.
POST$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2ec \ -d 'input[]=AAAAA' \ -d 'input[]=AAAYGMR'GET
http://api.unipept.ugent.be/api/v1/pept2ec.json?input[]=AAAAA&input[]=AAAYGMR
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ec': [
{
'ec_number': '1.5.1.5',
'protein_count': 14
},
{
'ec_number': '3.5.4.9',
'protein_count': 14
},
{
'ec_number': '2.4.1.21',
'protein_count': 1
}
]
},
{
'peptide': 'AAAYGMR',
'total_protein_count': 2,
'ec': [
{
'ec_number': '3.5.1.5',
'protein_count': 1
}
]
}
]
Example Retrieve the functional ec-numbers associated with a single tryptic peptide, while equating I and L
This example retrieves the functional ec-numbers associated with the tryptic peptide AAAAA. In searching, isoleucine (I) and leucinge (L) are considered equal. The result is the same as this search with the Tryptic Peptide Analysis in the web interface.
POST$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2ec \ -d 'input[]=AAAAA' \ -d 'equate_il=true'GET
http://api.unipept.ugent.be/api/v1/pept2ec.json?input[]=AAAAA&equate_il=true
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ec': [
{
'ec_number': '1.5.1.5',
'protein_count': 14
},
{
'ec_number': '3.5.4.9',
'protein_count': 14
},
{
'ec_number': '2.4.1.21',
'protein_count': 1
}
]
}
]
Example Retrieve the functional ec-numbers associated with a single tryptic peptide, with extra information enabled
This example retrieves the functional ec-numbers associated with the tryptic peptide AAAAA including the name of each ec-number. The result is the same as this search with the Tryptic Peptide Analysis in the web interface.
POST$ curl -X POST -H 'Accept: application/json' api.unipept.ugent.be/api/v1/pept2ec \ -d 'input[]=AAAAA' \ -d 'extra=true'GET
http://api.unipept.ugent.be/api/v1/pept2ec.json?input[]=AAAAA&extra=true
Response
[
{
'peptide': 'AAAAA',
'total_protein_count': 17,
'ec': [
{
'ec_number': '1.5.1.5',
'protein_count': 14,
'name': 'Methylenetetrahydrofolate dehydrogenase (NADP(+))'
},
{
'ec_number': '3.5.4.9',
'protein_count': 14,
'name': 'Methenyltetrahydrofolate cyclohydrolase'
},
{
'ec_number': '2.4.1.21',
'protein_count': 1,
'name': 'Starch synthase'
}
]
}
]
Try it
Use the API explorer form below to call the pept2ec method on live data and see the response.
Request
Response