-
Notifications
You must be signed in to change notification settings - Fork 0
Private API ‐ Retrieve InterPro entries
Pieter Verschaffelt edited this page Mar 6, 2025
·
3 revisions
Description
This endpoint retrieves descriptive information for a list of InterPro entries. Each InterPro entry is mapped to its name and category, which describe protein families, domains, or functional sites.
Endpoint URL
/private_api/interpros
Request Method
POST
Request Parameters
Parameter | Type | Required | Description | Example Value |
---|---|---|---|---|
interpros | array |
Yes | List of InterPro entry identifiers | ["IPR005843", "IPR013578"] |
Response
The response is a JSON array where each element contains the following fields:
Field | Type | Description |
---|---|---|
code | string | The InterPro entry identifier |
name | string | The descriptive name of the InterPro entry |
category | string | The category of the InterPro entry (e.g., Domain, Family, Motif, etc.) |
Possible values for the category
field include:
- Domain
- Family
- Motif
- Repeat
- Region
- Structure
- Site
Example Response:
[
{
"code": "IPR005843",
"name": "Alpha-D-phosphohexomutase, C-terminal",
"category": "Domain"
},
{
"code": "IPR013578",
"name": "Peptidase M16C associated",
"category": "Domain"
}
]
Request:
curl -X POST https://unipept.ugent.be/private_api/interpros \
-H "Content-Type: application/json" \
-d '{
"interpros": ["IPR005843", "IPR013578", "IPR017215"]
}'
Response:
[
{
"code": "IPR005843",
"name": "Alpha-D-phosphohexomutase, C-terminal",
"category": "Domain"
},
{
"code": "IPR013578",
"name": "Peptidase M16C associated",
"category": "Domain"
}
]