/uniprot/clusters

POST /api/uniprot/clusters

Price: 10 credits

Get a UniRef sequence-similarity cluster by its identifier

How to use it

Resolves a UniRef cluster, which groups sequences at 100%, 90% or 50% identity around a seed entry. The identity threshold is part of the id, so UniRef50_P05067 and UniRef90_P05067 are different clusters with the same seed and widely different sizes. A cluster is named after its seed, so prefixing a UniProt accession resolves only when that accession is itself the seed: that holds for UniRef100 and for reviewed Swiss-Prot accessions, and usually fails at UniRef90 and UniRef50 for unreviewed TrEMBL ones. To reach all three thresholds from an arbitrary accession, resolve UniRef100_<accession> first and read `representative_member.uniref90_id` and `representative_member.uniref50_id` off the answer. Members are UniProtKB or UniParc entries rather than clusters, and `representative_member` carries the sequence the cluster is named for.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• cluster string required — UniRef cluster identifier (examples: "UniRef90_P05067", "UniRef50_P05067", "UniRef100_P05067"; minLength: 1)
• include_members boolean — Return the member list. `member_count` is reported either way, and a UniRef50 cluster can hold thousands of members (default: true)

Response

• @type string (default: "UniprotCluster")
• id string required
• name string (default: "")
• cluster_type string (default: "")
• member_count integer nullable
• seed_id string (default: "")
• common_taxon object nullable
  • @type string (default: "UniprotTaxonNode")
  • taxon_id integer nullable
  • scientific_name string (default: "")
  • common_name string (default: "")
  • mnemonic string (default: "")
  • rank string (default: "")
  • synonyms array (default: [])
  • is_hidden boolean nullable
• go_terms array (default: [])
  • @type string (default: "UniprotClusterGoTerm")
  • go_id string (default: "")
  • aspect string (default: "")
• representative_member object nullable
  • @type string (default: "UniprotClusterMember")
  • member_id string (default: "")
  • member_id_type string (default: "")
  • accessions array (default: [])
  • protein_name string (default: "")
  • organism_name string (default: "")
  • organism_taxon_id integer nullable
  • sequence_length integer nullable
  • uniref50_id string (default: "")
  • uniref90_id string (default: "")
  • uniref100_id string (default: "")
  • uniparc_id string (default: "")
  • is_seed boolean nullable
  • sequence object nullable
    • @type string (default: "UniprotSequence")
    • value string (default: "")
    • length integer nullable
    • mass integer nullable
    • crc64 string (default: "")
    • md5 string (default: "")
• members array (default: [])
  • @type string (default: "UniprotClusterMember")
  • member_id string (default: "")
  • member_id_type string (default: "")
  • accessions array (default: [])
  • protein_name string (default: "")
  • organism_name string (default: "")
  • organism_taxon_id integer nullable
  • sequence_length integer nullable
  • uniref50_id string (default: "")
  • uniref90_id string (default: "")
  • uniref100_id string (default: "")
  • uniparc_id string (default: "")
  • is_seed boolean nullable
  • sequence object nullable
    • @type string (default: "UniprotSequence")
    • value string (default: "")
    • length integer nullable
    • mass integer nullable
    • crc64 string (default: "")
    • md5 string (default: "")
• updated_date string (default: "")
• url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Cluster not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.