Skills › Scientific Agent Skills › database-lookup › interpro.md

interpro.md

120 lines · skills/database-lookup/references/interpro.md at 5f2bc03

Open on GitHub

1# InterPro API Reference

InterPro API Reference

Raw lines 1 to 2

3## Base URL

4```

5https://www.ebi.ac.uk/interpro/api

6```

Base URL

https://www.ebi.ac.uk/interpro/api

Raw lines 3 to 7

8## Authentication

9None required. Fully public API.

Authentication

None required. Fully public API.

Raw lines 8 to 10

11## Rate Limits

12No published hard limits. EBI general guidance: be reasonable, use bulk downloads for large datasets.

Rate Limits

No published hard limits. EBI general guidance: be reasonable, use bulk downloads for large datasets.

Raw lines 11 to 13

14## Response Format

15JSON by default. Some endpoints support `?format=json` explicitly.

Response Format

JSON by default. Some endpoints support ?format=json explicitly.

Raw lines 14 to 16

17## Key Endpoints

Key Endpoints

Raw lines 17 to 18

19### 1. Entry Lookup (by accession)

20```

21GET https://www.ebi.ac.uk/interpro/api/entry/interpro/{accession}

22```

23Example:

24```

25GET https://www.ebi.ac.uk/interpro/api/entry/interpro/IPR000504

26```

27Returns JSON with entry name, type (family/domain/site/etc.), description, GO terms, literature references.

1. Entry Lookup (by accession)

GET https://www.ebi.ac.uk/interpro/api/entry/interpro/{accession}

Example:

GET https://www.ebi.ac.uk/interpro/api/entry/interpro/IPR000504

Returns JSON with entry name, type (family/domain/site/etc.), description, GO terms, literature references.

Raw lines 19 to 28

29### 2. Entry Lookup by Member Database

30```

31GET https://www.ebi.ac.uk/interpro/api/entry/pfam/{pfam_accession}

32GET https://www.ebi.ac.uk/interpro/api/entry/smart/{smart_accession}

33GET https://www.ebi.ac.uk/interpro/api/entry/prosite/{prosite_accession}

34```

35Example:

36```

37GET https://www.ebi.ac.uk/interpro/api/entry/pfam/PF00076

38```

2. Entry Lookup by Member Database

GET https://www.ebi.ac.uk/interpro/api/entry/pfam/{pfam_accession}
GET https://www.ebi.ac.uk/interpro/api/entry/smart/{smart_accession}
GET https://www.ebi.ac.uk/interpro/api/entry/prosite/{prosite_accession}

Example:

GET https://www.ebi.ac.uk/interpro/api/entry/pfam/PF00076

Raw lines 29 to 39

40### 3. Search / List Entries

41```

42GET https://www.ebi.ac.uk/interpro/api/entry/interpro?search={query}

43```

44Example:

45```

46GET https://www.ebi.ac.uk/interpro/api/entry/interpro?search=kinase

47```

48Returns paginated list of matching InterPro entries.

3. Search / List Entries

GET https://www.ebi.ac.uk/interpro/api/entry/interpro?search={query}

Example:

GET https://www.ebi.ac.uk/interpro/api/entry/interpro?search=kinase

Returns paginated list of matching InterPro entries.

Raw lines 40 to 49

50### 4. Protein Annotations — Get InterPro Entries for a Protein

51```

52GET https://www.ebi.ac.uk/interpro/api/entry/interpro/protein/uniprot/{uniprot_accession}

53```

54Example:

55```

56GET https://www.ebi.ac.uk/interpro/api/entry/interpro/protein/uniprot/P12345

57```

58Returns all InterPro entries annotating that protein.

4. Protein Annotations — Get InterPro Entries for a Protein

GET https://www.ebi.ac.uk/interpro/api/entry/interpro/protein/uniprot/{uniprot_accession}

Example:

GET https://www.ebi.ac.uk/interpro/api/entry/interpro/protein/uniprot/P12345

Returns all InterPro entries annotating that protein.

Raw lines 50 to 59

60### 5. Proteins with a Given Entry

61```

62GET https://www.ebi.ac.uk/interpro/api/protein/uniprot/entry/interpro/{accession}

63```

64Example:

65```

66GET https://www.ebi.ac.uk/interpro/api/protein/uniprot/entry/interpro/IPR000504

67```

68Returns paginated list of UniProt proteins annotated with that entry.

5. Proteins with a Given Entry

GET https://www.ebi.ac.uk/interpro/api/protein/uniprot/entry/interpro/{accession}

Example:

GET https://www.ebi.ac.uk/interpro/api/protein/uniprot/entry/interpro/IPR000504

Returns paginated list of UniProt proteins annotated with that entry.

Raw lines 60 to 69

70### 6. Structure Mappings

71```

72GET https://www.ebi.ac.uk/interpro/api/structure/pdb/entry/interpro/{accession}

73```

74Example:

75```

76GET https://www.ebi.ac.uk/interpro/api/structure/pdb/entry/interpro/IPR000504

77```

6. Structure Mappings

GET https://www.ebi.ac.uk/interpro/api/structure/pdb/entry/interpro/{accession}

Example:

GET https://www.ebi.ac.uk/interpro/api/structure/pdb/entry/interpro/IPR000504

Raw lines 70 to 78

79### 7. Entry by Type Filter

80```

81GET https://www.ebi.ac.uk/interpro/api/entry/interpro?type=domain

82GET https://www.ebi.ac.uk/interpro/api/entry/interpro?type=family

83GET https://www.ebi.ac.uk/interpro/api/entry/interpro?type=homologous_superfamily

84```

7. Entry by Type Filter

GET https://www.ebi.ac.uk/interpro/api/entry/interpro?type=domain
GET https://www.ebi.ac.uk/interpro/api/entry/interpro?type=family
GET https://www.ebi.ac.uk/interpro/api/entry/interpro?type=homologous_superfamily

Raw lines 79 to 85

86### 8. Taxonomy Cross-Reference

87```

88GET https://www.ebi.ac.uk/interpro/api/taxonomy/uniprot/entry/interpro/{accession}

89```

8. Taxonomy Cross-Reference

GET https://www.ebi.ac.uk/interpro/api/taxonomy/uniprot/entry/interpro/{accession}

Raw lines 86 to 90

91## Pagination

92Responses include `next` and `previous` URLs:

93```json

94{

95 "count": 1234,

96 "next": "https://www.ebi.ac.uk/interpro/api/entry/interpro?cursor=...&page_size=20",

97 "previous": null,

98 "results": [...]

99}

100```

101Use `?page_size=N` to control page size (default 20).

102

Pagination

Responses include next and previous URLs:

{
  "count": 1234,
  "next": "https://www.ebi.ac.uk/interpro/api/entry/interpro?cursor=...&page_size=20",
  "previous": null,
  "results": [...]
}

Use ?page_size=N to control page size (default 20).

Raw lines 91 to 102

103## Entry Response Key Fields

104```json

105{

106 "metadata": {

107 "accession": "IPR000504",

108 "name": "RNA recognition motif domain",

109 "type": "domain",

110 "source_database": "interpro",

111 "member_databases": {"pfam": {"PF00076": "RRM_1"}},

112 "go_terms": [{"identifier": "GO:0003723", "name": "RNA binding"}],

113 "description": ["<p>The RNA recognition motif...</p>"]

114 }

115}

116```

117

Entry Response Key Fields

{
  "metadata": {
    "accession": "IPR000504",
    "name": "RNA recognition motif domain",
    "type": "domain",
    "source_database": "interpro",
    "member_databases": {"pfam": {"PF00076": "RRM_1"}},
    "go_terms": [{"identifier": "GO:0003723", "name": "RNA binding"}],
    "description": ["<p>The RNA recognition motif...</p>"]
  }
}

Raw lines 103 to 117

118## Notes

119- The API follows a composable URL pattern: combine entity types (entry, protein, structure, taxonomy) to create cross-reference queries.

120- Member databases include `pfam`, `smart`, `prosite` (patterns), `profile` (PROSITE profiles), `prints`, `panther`, `cdd`, `hamap`, `pirsf`, `sfld`, `cathgene3d`, `ssf`, and `ncbifam`. `tigrfams` was replaced by `ncbifam`; discover current sources from the API root.

Notes

The API follows a composable URL pattern: combine entity types (entry, protein, structure, taxonomy) to create cross-reference queries.
Member databases include pfam, smart, prosite (patterns), profile (PROSITE profiles), prints, panther, cdd, hamap, pirsf, sfld, cathgene3d, ssf, and ncbifam. tigrfams was replaced by ncbifam; discover current sources from the API root.

Raw lines 118 to 120