InterPro clan metadata and members
interpro_get_clanRetrieve a Pfam, CDD, or PIRSF clan/set and a cursor page of member entries; optionally include its relationship graph, returned in slices that fit the response budget and paged with relationshipOffset.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Positive integer member page size; values above 100 are clamped to 100 with a notice; defaults to 20. | |
| cursor | No | Opaque nextCursor with unchanged accession, sourceDatabase, and includeRelationships; limit, relationshipOffset, and includeThumbnail may change. | |
| accession | Yes | Set accession, such as CL0016 (Pfam), cl21453 (CDD), or PIRSF000047; no URL syntax. | |
| sourceDatabase | No | Inferred from uppercase CL (Pfam), lowercase cl (CDD), or PIRSF; supply explicitly for mixed-case CL prefixes. | |
| includeThumbnail | No | Include each Wikipedia thumbnail image, base64 data often tens of KB; defaults to false. | |
| relationshipOffset | No | Position of the first relationship item to return, counting nodes, then links; defaults to 0. A value above 0 requires includeRelationships: true; pass relationshipsPage.nextOffset to continue. | |
| includeRelationships | No | Include the relationship graph, one slice per call that fits the response budget; defaults to false. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | Effective member page size after clamping. | |
| url | No | Canonical InterPro clan website URL. | |
| clan | No | Complete metadata, with relationships and Wikipedia thumbnails omitted unless requested; requested relationships hold the slice relationshipsPage locates. | |
| page | No | Member continuation and total. | |
| error | No | Present when the call failed. Absent on success. | |
| shown | No | Members returned in this page. | |
| notice | No | Next relationship slice call, omitted relationships or thumbnails, or empty-page guidance. | |
| members | No | Complete upstream member records. | |
| accession | No | Canonical requested clan accession. | |
| sourceUrl | No | Official clan metadata API source URL. | |
| truncated | No | More members remain. | |
| totalCount | No | Total matching members. | |
| effectiveQuery | No | Applied canonical target, relationship, and thumbnail selection. | |
| sourceDatabase | No | Set database. | |
| relationshipsPage | No | Position and totals of the relationship slice; present only when includeRelationships is true. | |
| relationshipsIncluded | No | Whether relationship projection was requested. |