# UniProt

> Look up proteins in UniProt, the reference database of protein sequences and function: search entries, read a protein's names, gene, function, diseases, sequence, features and GO terms, explore sequence clusters (UniRef), the sequence archive (UniParc), proteomes, taxonomy, keywords, diseases and literature, and map IDs between databases.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/uniprot

## Actions

### Get disease

Get a disease by its UniProt ID: definition, acronym, other names, keywords and cross-references.

**Inputs**

- Disease ID (`disease_id`, text, required): The disease, such as DI-01904 (Li-Fraumeni syndrome).

**Outputs**

- `acronym` (text): Its acronym.
- `alternative_names` (list): Other names for it.
- `cross_references` (list): It in other databases (MIM, MeSH...).
- `definition` (text): What it is.
- `id` (text): The disease's ID, e.g. 'DI-01904'.
- `keywords` (list): UniProt's keywords for it.
- `name` (text): Its name.
- `reviewed_protein_count` (number): Reviewed proteins linked to it.
- `url` (text): The disease on uniprot.org.

**Example output**

```json
{
  "acronym": "LFS",
  "alternative_names": [
    "LFL",
    "Sarcoma family syndrome of Li and Fraumeni"
  ],
  "cross_references": [
    {
      "database": "MIM",
      "id": "151623"
    }
  ],
  "definition": "An autosomal dominant familial cancer syndrome.",
  "id": "DI-01904",
  "keywords": [
    "Li-Fraumeni syndrome"
  ],
  "name": "Li-Fraumeni syndrome",
  "reviewed_protein_count": 2,
  "url": "https://www.uniprot.org/diseases/DI-01904"
}
```

### Get ID mapping results

Read a finished ID mapping job's results, a page at a time: each ID with what it maps to (an ID can map to several), plus the IDs that could not be mapped.

**Inputs**

- Job ID (`job_id`, text, required): The mapping job's ID, from 'Submit ID mapping'.
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `count` (number): Mappings on this page.
- `failed_ids` (list): IDs that could not be mapped.
- `job_id` (text): The mapping job's ID.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `obsolete_count` (number): Mapped entries that are now obsolete.
- `results` (list): The mappings on this page.
- `total` (number): Mappings in all.

**Example output**

```json
{
  "count": 2,
  "failed_ids": [],
  "job_id": "AoofAwrYHV",
  "next_cursor": "",
  "obsolete_count": 0,
  "results": [
    {
      "from": "P04637",
      "to": "ENSG00000141510.20"
    },
    {
      "from": "P31749",
      "to": "ENSG00000142208.20"
    }
  ],
  "total": 2
}
```

### Get ID mapping status

Check whether an ID mapping job has finished, optionally waiting up to a minute for it, with what it maps and any errors.

**Inputs**

- Job ID (`job_id`, text, required): The mapping job's ID, from 'Submit ID mapping'.
- Wait up to (seconds) (`wait_seconds`, number): How long to wait for the job to finish before answering, 0 to 60. Most small jobs finish within a few seconds. From 0 to 60.

**Outputs**

- `errors` (list): What went wrong, when the job failed.
- `finished` (true/false): True once the results can be read.
- `from_db` (text): The source database.
- `id_count` (number): How many IDs were sent.
- `job_id` (text): The mapping job's ID.
- `status` (text): NEW, RUNNING, FINISHED or ERROR.
- `to_db` (text): The target database.

**Example output**

```json
{
  "errors": [],
  "finished": true,
  "from_db": "UniProtKB_AC-ID",
  "id_count": 2,
  "job_id": "AoofAwrYHV",
  "status": "FINISHED",
  "to_db": "Ensembl"
}
```

### Get keyword

Get a keyword: its definition, category, synonyms, matching GO terms, the keywords above and below it, and protein counts.

**Inputs**

- Keyword ID (`keyword_id`, text, required): The keyword, such as KW-0053 (Apoptosis).

**Outputs**

- `category` (text): Its category.
- `children` (list): The keywords under it.
- `definition` (text): What it means.
- `go_terms` (list): The GO terms it matches.
- `id` (text): The keyword's ID, e.g. 'KW-0053'.
- `name` (text): Its name.
- `parents` (list): The keywords it sits under.
- `reviewed_protein_count` (number): Reviewed proteins tagged with it.
- `synonyms` (list): Other names for it.
- `unreviewed_protein_count` (number): Unreviewed proteins tagged with it.
- `url` (text): The keyword on uniprot.org.

**Example output**

```json
{
  "category": "Biological process",
  "children": [],
  "definition": "Protein involved in apoptotic programmed cell death.",
  "go_terms": [
    {
      "id": "GO:0006915",
      "name": "apoptotic process"
    }
  ],
  "id": "KW-0053",
  "name": "Apoptosis",
  "parents": [
    {
      "id": "KW-9999",
      "name": "Biological process"
    }
  ],
  "reviewed_protein_count": 2976,
  "synonyms": [
    "Type I programmed cell death"
  ],
  "unreviewed_protein_count": 273917,
  "url": "https://www.uniprot.org/keywords/KW-0053"
}
```

### Get protein

Get a protein's UniProtKB entry in readable fields: names, gene, organism, function, where in the cell it is, diseases, length, mass, sequence, keywords, GO terms, and its PDB, AlphaFold, Ensembl, RefSeq and family links.

**Inputs**

- Accession (`accession`, text, required): The protein's UniProtKB accession, such as P04637 (P04637-2 for an isoform), or its entry name, such as P53_HUMAN. 'Search proteins' shows it.

**Outputs**

- `accession` (text): The accession, e.g. 'P04637'.
- `alphafold_id` (text): Its AlphaFold model, by accession.
- `alternative_names` (list): Other names for the protein.
- `annotation_score` (number): UniProt's annotation score, 1 (least) to 5 (most).
- `catalytic_activity` (list): The reactions it catalyses.
- `common_name` (text): The organism's common name, e.g. 'Human'.
- `diseases` (list): Diseases it is involved in.
- `ec_numbers` (list): Its enzyme (EC) numbers.
- `ensembl_genes` (list): Its Ensembl gene IDs.
- `entry_name` (text): The entry name, e.g. 'P53_HUMAN'.
- `families` (list): Its protein families and domains.
- `first_public` (text): When the entry was first published.
- `function` (text): What the protein does.
- `gene` (text): The gene's name, e.g. 'TP53'.
- `gene_synonyms` (list): Other names for the gene.
- `go_terms` (list): Its Gene Ontology terms.
- `keywords` (list): UniProt's keywords for it.
- `last_updated` (text): When the entry's annotation last changed.
- `length` (number): The sequence length, in amino acids.
- `lineage` (list): The organism's lineage, broadest first.
- `mass` (number): The mass, in daltons.
- `ncbi_gene_ids` (list): Its NCBI Gene IDs.
- `organism` (text): The organism's scientific name.
- `pathway` (text): The pathways it is part of.
- `pdb_ids` (list): The PDB structures of it.
- `protein_existence` (text): The evidence the protein exists, e.g. '1: Evidence at protein level'.
- `protein_name` (text): The protein's recommended name.
- `refseq_ids` (list): Its RefSeq protein IDs.
- `requested` (text): The accession or entry name asked for; it differs from 'accession' when that one was merged into this entry, or was an entry name.
- `reviewed` (true/false): True for a reviewed (Swiss-Prot) entry.
- `sequence` (text): The amino-acid sequence.
- `subcellular_locations` (list): Where in the cell it is found.
- `subunit` (text): What it forms complexes with.
- `summary` (text): One line: gene, protein, organism, length, reviewed or not.
- `taxon_id` (number): The organism's taxon ID, e.g. 9606.
- `tissue_specificity` (text): Where it is expressed.
- `uniparc_id` (text): Its sequence's UniParc ID.
- `url` (text): The entry on uniprot.org.
- `version` (number): The entry's version.

**Example output**

```json
{
  "accession": "P04637",
  "alphafold_id": "P04637",
  "alternative_names": [
    "Antigen NY-CO-13",
    "Phosphoprotein p53",
    "Tumor suppressor p53"
  ],
  "annotation_score": 5.0,
  "catalytic_activity": [],
  "common_name": "Human",
  "diseases": [
    {
      "acronym": "LFS",
      "description": "An autosomal dominant familial cancer syndrome.",
      "id": "DI-01904",
      "mim_id": "151623",
      "name": "Li-Fraumeni syndrome",
      "note": "The disease is caused by variants affecting the gene represented in this entry"
    }
  ],
  "ec_numbers": [],
  "ensembl_genes": [
    "ENSG00000141510.20"
  ],
  "entry_name": "P53_HUMAN",
  "families": [
    {
      "database": "Pfam",
      "id": "PF00870",
      "name": "P53"
    }
  ],
  "first_public": "1987-08-13",
  "function": "Multifunctional transcription factor that induces cell cycle arrest, DNA repair or apoptosis upon binding to its target DNA sequence.",
  "gene": "TP53",
  "gene_synonyms": [
    "P53"
  ],
  "go_terms": [
    {
      "aspect": "Biological process",
      "evidence": "IDA:UniProtKB",
      "id": "GO:0006915",
      "term": "apoptotic process"
    }
  ],
  "keywords": [
    {
      "category": "Biological process",
      "id": "KW-0053",
      "name": "Apoptosis"
    }
  ],
  "last_updated": "2026-09-02",
  "length": 393,
  "lineage": [
    "Eukaryota",
    "Metazoa",
    "Chordata",
    "Mammalia",
    "Primates",
    "Homo"
  ],
  "mass": 43653,
  "ncbi_gene_ids": [
    "7157"
  ],
  "organism": "Homo sapiens",
  "pathway": null,
  "pdb_ids": [
    "1A1U",
    "1AIE"
  ],
  "protein_existence": "1: Evidence at protein level",
  "protein_name": "Cellular tumor antigen p53",
  "refseq_ids": [
    "NP_000537.3"
  ],
  "requested": "P04637",
  "reviewed": true,
  "sequence": "MEEPQSDPSVEPPLSQETFSDLWKLLPENNVLSPLPSQAMDDLMLSPDDIEQWFTEDPGPDEAPRMPEAAPPVA",
  "subcellular_locations": [
    "Cytoplasm",
    "Nucleus",
    "Nucleus, PML body"
  ],
  "subunit": "Forms homodimers and homotetramers.",
  "summary": "TP53 \u00b7 Cellular tumor antigen p53 \u00b7 Homo sapiens \u00b7 393 aa \u00b7 reviewed",
  "taxon_id": 9606,
  "tissue_specificity": "Ubiquitous.",
  "uniparc_id": "UPI000002ED67",
  "url": "https://www.uniprot.org/uniprotkb/P04637/entry",
  "version": 315
}
```

### Get protein sequence (FASTA)

Get a protein's amino-acid sequence in FASTA format, ready to save or send to an alignment tool, with the header and the bare sequence split out. Works for isoforms (P04637-2) too.

**Inputs**

- Accession (`accession`, text, required): The protein's UniProtKB accession, such as P04637 (P04637-2 for an isoform), or its entry name, such as P53_HUMAN. 'Search proteins' shows it.

**Outputs**

- `accession` (text): The accession read.
- `fasta` (text): The whole FASTA record.
- `header` (text): The FASTA header line, without '>'.
- `length` (number): The sequence length.
- `sequence` (text): The sequence alone.
- `url` (text): The entry on uniprot.org.

**Example output**

```json
{
  "accession": "P04637",
  "fasta": ">sp|P04637|P53_HUMAN Cellular tumor antigen p53\nMEEPQSDPSVEPPLSQETFSDLWKLLPENNVLSPLPSQAMDDLMLSPDDIEQWFTEDPGPDEAPRMPEAAPPVA\n",
  "header": "sp|P04637|P53_HUMAN Cellular tumor antigen p53 OS=Homo sapiens OX=9606 GN=TP53 PE=1 SV=4",
  "length": 74,
  "sequence": "MEEPQSDPSVEPPLSQETFSDLWKLLPENNVLSPLPSQAMDDLMLSPDDIEQWFTEDPGPDEAPRMPEAAPPVA",
  "url": "https://www.uniprot.org/uniprotkb/P04637/entry"
}
```

### Get proteome

Get a proteome: its organism, protein and gene counts (reviewed and unreviewed), completeness, genome assembly, and the chromosomes or other components it is made of.

**Inputs**

- Proteome ID (`proteome_id`, text, required): The proteome, such as UP000005640 (human).

**Outputs**

- `annotation_source` (text): Who annotated the genome.
- `assembly_id` (text): The genome assembly it comes from.
- `assembly_level` (text): How complete that assembly is.
- `busco_score` (number): Its BUSCO completeness, as a percentage.
- `common_name` (text): The organism's common name.
- `components` (list): Its chromosomes and other parts.
- `cpd_status` (text): Its Complete Proteome Detector verdict.
- `description` (text): About the organism.
- `gene_count` (number): How many genes they come from.
- `id` (text): The proteome's ID, e.g. 'UP000005640'.
- `isoform_count` (number): Its isoforms.
- `lineage` (list): The organism's lineage.
- `modified` (text): When it last changed.
- `organism` (text): The organism.
- `protein_count` (number): How many proteins it has.
- `reviewed_protein_count` (number): Its reviewed proteins.
- `taxon_id` (number): The organism's taxon ID.
- `type` (text): e.g. 'Reference proteome'.
- `unreviewed_protein_count` (number): Its unreviewed proteins.
- `url` (text): The proteome on uniprot.org.

**Example output**

```json
{
  "annotation_source": "Ensembl",
  "assembly_id": "GCA_000001405.29",
  "assembly_level": "full",
  "busco_score": 99.0,
  "common_name": "Human",
  "components": [
    {
      "genome_accession": "CM000663",
      "name": "Chromosome 1",
      "protein_count": 13931
    }
  ],
  "cpd_status": "Unknown",
  "description": "Homo sapiens (Homo sapiens sapiens) or modern humans...",
  "gene_count": 20652,
  "id": "UP000005640",
  "isoform_count": 22131,
  "lineage": [
    "cellular organisms",
    "Eukaryota",
    "Opisthokonta"
  ],
  "modified": "2026-04-22",
  "organism": "Homo sapiens",
  "protein_count": 147520,
  "reviewed_protein_count": 20416,
  "taxon_id": 9606,
  "type": "Reference proteome",
  "unreviewed_protein_count": 127104,
  "url": "https://www.uniprot.org/proteomes/UP000005640"
}
```

### Get taxon

Get a taxon by its ID: scientific and common names, rank, parent, lineage, other names, links and how many proteins and proteomes it has.

**Inputs**

- Taxon (`taxon_id`, text, required): Pick an organism, or type a taxon ID such as 9606.

**Outputs**

- `active` (true/false): False when the taxon was retired.
- `common_name` (text): Its common name.
- `lineage` (list): Its lineage, broadest first.
- `links` (list): Pages about it elsewhere.
- `mnemonic` (text): UniProt's code for it, e.g. 'HUMAN'.
- `other_names` (list): Other names, including misspellings.
- `parent_id` (number): Its parent taxon's ID.
- `parent_name` (text): Its parent taxon's name.
- `proteome_count` (number): Its proteomes.
- `rank` (text): Its rank, e.g. 'species'.
- `reviewed_protein_count` (number): Its reviewed (Swiss-Prot) proteins.
- `scientific_name` (text): Its scientific name.
- `synonyms` (list): Synonyms.
- `taxon_id` (number): The taxon's ID, e.g. 9606.
- `unreviewed_protein_count` (number): Its unreviewed (TrEMBL) proteins.
- `url` (text): The taxon on uniprot.org.

**Example output**

```json
{
  "active": true,
  "common_name": "Human",
  "lineage": [
    "Eukaryota",
    "Metazoa",
    "Chordata",
    "Mammalia",
    "Primates",
    "Homo"
  ],
  "links": [
    "https://en.wikipedia.org/wiki/Human"
  ],
  "mnemonic": "HUMAN",
  "other_names": [
    "Homo sapiens Linnaeus, 1758",
    "human"
  ],
  "parent_id": 9605,
  "parent_name": "Homo",
  "proteome_count": 2,
  "rank": "species",
  "reviewed_protein_count": 20432,
  "scientific_name": "Homo sapiens",
  "synonyms": [],
  "taxon_id": 9606,
  "unreviewed_protein_count": 190356,
  "url": "https://www.uniprot.org/taxonomy/9606"
}
```

### Get UniParc sequence

Get a UniParc sequence with its checksums, InterPro domains and UniProtKB accessions, and a page of the database records that hold it (UniProtKB, RefSeq, Ensembl, EMBL and more).

**Inputs**

- UniParc ID (`upi`, text, required): The sequence's UniParc ID, such as UPI000002ED67.
- Current records only (`active_only`, true/false): Leave out database records that have since been retired.
- Records per page (`page_size`, number): How many database records to list, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `count` (number): Records on this page.
- `crc64` (text): Its CRC64 checksum.
- `cross_reference_count` (number): Database records holding it, in all.
- `cross_references` (list): A page of the records holding it.
- `domains` (list): Its InterPro domains.
- `first_seen` (text): When a database first held it.
- `last_seen` (text): When a database last updated it.
- `length` (number): The sequence length.
- `md5` (text): Its MD5 checksum.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `sequence` (text): The sequence.
- `total` (number): Records matching (current only, if asked).
- `uniprot_accessions` (list): UniProtKB accessions with this sequence.
- `upi` (text): The UniParc ID.
- `url` (text): The entry on uniprot.org.

**Example output**

```json
{
  "count": 1,
  "crc64": "AD5C149FD8106131",
  "cross_reference_count": 617,
  "cross_references": [
    {
      "active": true,
      "created": "2009-11-24",
      "database": "UniProtKB/Swiss-Prot",
      "gene": "TP53",
      "id": "P04637",
      "last_updated": "2026-09-02",
      "organism": "Homo sapiens",
      "protein_name": "Cellular tumor antigen p53",
      "taxon_id": 9606,
      "version": 4
    }
  ],
  "domains": [
    {
      "id": "IPR011615",
      "name": "p53, DNA-binding domain"
    }
  ],
  "first_seen": "1989-07-01",
  "last_seen": "2026-09-02",
  "length": 393,
  "md5": "C133DFCE69F606F20865E9008199F852",
  "next_cursor": "jjyuoihck",
  "sequence": "MEEPQSDPSVEPPLSQETFSDLWKLLPENNVLSPLPSQAMDDLMLSPDDIEQWFTEDPGPDEAPRMPEAAPPVA",
  "total": 8,
  "uniprot_accessions": [
    "P04637"
  ],
  "upi": "UPI000002ED67",
  "url": "https://www.uniprot.org/uniparc/UPI000002ED67/entry"
}
```

### Get UniRef cluster

Get a UniRef cluster: its size, the organisms it spans, its representative protein and sequence, and a page of its members.

**Inputs**

- Cluster ID (`cluster_id`, text, required): The UniRef cluster, such as UniRef90_P04637. 'Search UniRef clusters' shows it.
- Members per page (`page_size`, number): How many members to list, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `common_taxon` (text): The narrowest taxon covering every member.
- `common_taxon_id` (number): That taxon's ID.
- `id` (text): The cluster's ID, e.g. 'UniRef90_P04637'.
- `identity` (text): UniRef100, UniRef90 or UniRef50: how alike its members are.
- `member_count` (number): How many sequences it holds.
- `members` (list): A page of the cluster's members.
- `members_count` (number): Members on this page.
- `name` (text): The cluster's name.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `organism_count` (number): How many organisms they come from.
- `representative` (object): The member chosen to represent the cluster.
- `sequence` (text): The representative's sequence.
- `updated` (text): When the cluster last changed.
- `url` (text): The cluster on uniprot.org.

**Example output**

```json
{
  "common_taxon": "Euarchontoglires",
  "common_taxon_id": 314146,
  "id": "UniRef90_P04637",
  "identity": "UniRef90",
  "member_count": 104,
  "members": [
    {
      "accessions": [
        "P04637"
      ],
      "id": "P53_HUMAN",
      "length": 393,
      "organism": "Homo sapiens (Human)",
      "protein_name": "Cellular tumor antigen p53",
      "taxon_id": 9606,
      "type": "UniProtKB ID",
      "uniparc_id": "UPI000002ED67"
    }
  ],
  "members_count": 1,
  "name": "Cellular tumor antigen p53",
  "next_cursor": "jjyuoihck",
  "organism_count": 28,
  "representative": {
    "accessions": [
      "P04637"
    ],
    "id": "P53_HUMAN",
    "length": 393,
    "organism": "Homo sapiens (Human)",
    "protein_name": "Cellular tumor antigen p53",
    "taxon_id": 9606,
    "type": "UniProtKB ID",
    "uniparc_id": "UPI000002ED67"
  },
  "sequence": "MEEPQSDPSVEPPLSQETFSDLWKLLPENNVLSPLPSQAMDDLMLSPDDIEQWFTEDPGPDEAPRMPEAAPPVA",
  "updated": "2026-09-02",
  "url": "https://www.uniprot.org/uniref/UniRef90_P04637"
}
```

### List protein features

List the features marked along a protein's sequence, with their positions: domains, regions, binding and active sites, modifications, signal peptides, transmembrane parts and, when asked, natural variants and mutagenesis results.

**Inputs**

- Accession (`accession`, text, required): The protein's UniProtKB accession, such as P04637 (P04637-2 for an isoform), or its entry name, such as P53_HUMAN. 'Search proteins' shows it.
- Kinds of feature (`types`, list): Only these kinds. Leave empty for the protein's parts and sites: everything but variants, mutagenesis, alternative sequences, conflicts and secondary structure. One or more of: `Chain`, `Signal` (Signal peptide), `Transit peptide`, `Propeptide`, `Peptide`, `Initiator methionine`, `Domain`, `Region`, `Repeat`, `Motif`, and 22 more.

**Outputs**

- `accession` (text): The accession read.
- `by_type` (list): How many of each kind.
- `count` (number): How many features there are.
- `features` (list): The features, in sequence order by kind.
- `types` (list): The kinds of feature asked for.

**Example output**

```json
{
  "accession": "P04637",
  "by_type": [
    {
      "count": 1,
      "type": "DNA binding"
    }
  ],
  "count": 1,
  "features": [
    {
      "description": null,
      "end": 292,
      "evidence_count": 3,
      "feature_id": null,
      "ligand": null,
      "original": null,
      "start": 102,
      "type": "DNA binding",
      "variation": []
    }
  ],
  "types": [
    "DNA binding",
    "Modified residue"
  ]
}
```

### Search diseases

Search the human diseases UniProt links to proteins, with each one's definition, other names and OMIM and MeSH references.

**Inputs**

- Search (`query`, text, required): A disease's name, acronym or words, such as cystic fibrosis.
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `count` (number): Results on this page.
- `diseases` (list): The diseases on this page.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `query` (text): The query sent to UniProt.
- `total` (number): Results matching in all.

**Example output**

```json
{
  "count": 1,
  "diseases": [
    {
      "acronym": "LFS",
      "alternative_names": [
        "LFL",
        "Sarcoma family syndrome of Li and Fraumeni"
      ],
      "cross_references": [
        {
          "database": "MIM",
          "id": "151623"
        }
      ],
      "definition": "An autosomal dominant familial cancer syndrome.",
      "id": "DI-01904",
      "keywords": [
        "Li-Fraumeni syndrome"
      ],
      "name": "Li-Fraumeni syndrome",
      "reviewed_protein_count": 2,
      "url": "https://www.uniprot.org/diseases/DI-01904"
    }
  ],
  "next_cursor": "",
  "query": "Li-Fraumeni",
  "total": 1
}
```

### Search keywords

Search UniProt's keywords, the controlled terms that tag entries by function, location, disease and more, with each one's definition and protein counts.

**Inputs**

- Search (`query`, text, required): Words to look for in keywords, such as kinase.
- Category (`category`, text): Only keywords in this category. Leave blank for all. One of: `biological_process` (Biological process), `cellular_component` (Cellular component), `coding_sequence_diversity` (Coding sequence diversity), `developmental_stage` (Developmental stage), `disease`, `domain`, `ligand`, `molecular_function` (Molecular function), `ptm` (Post-translational modification), `technical_term` (Technical term).
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `count` (number): Results on this page.
- `keywords` (list): The keywords on this page.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `query` (text): The query sent to UniProt.
- `total` (number): Results matching in all.

**Example output**

```json
{
  "count": 1,
  "keywords": [
    {
      "category": "Biological process",
      "definition": "Protein involved in apoptotic programmed cell death.",
      "go_terms": [
        {
          "id": "GO:0006915",
          "name": "apoptotic process"
        }
      ],
      "id": "KW-0053",
      "name": "Apoptosis",
      "reviewed_protein_count": 2976,
      "synonyms": [
        "Type I programmed cell death"
      ],
      "unreviewed_protein_count": 273917,
      "url": "https://www.uniprot.org/keywords/KW-0053"
    }
  ],
  "next_cursor": "",
  "query": "(apoptosis) AND category:biological_process",
  "total": 1
}
```

### Search literature

Search the papers UniProt cites by title words, author or journal, with how many protein entries cite each one and a link to it on PubMed.

**Inputs**

- Search (`query`, text, required): Words in the title or abstract, or fields such as author:Vogelstein or journal:Nature.
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `citations` (list): The papers on this page.
- `count` (number): Results on this page.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `query` (text): The query sent to UniProt.
- `total` (number): Results matching in all.

**Example output**

```json
{
  "citations": [
    {
      "authors": [
        "Ohnishi K.",
        "Inaba H."
      ],
      "doi": "10.1023/b:appt.0000038044.40337.35",
      "id": "15314287",
      "journal": "Apoptosis",
      "pages": "591-597",
      "published": "2004",
      "pubmed_id": "15314287",
      "reviewed_protein_count": 0,
      "title": "C-terminal peptides of p53 molecules enhance radiation-induced apoptosis in human mutant p53 cancer cells.",
      "type": "UniProt indexed literatures",
      "unreviewed_protein_count": 0,
      "url": "https://pubmed.ncbi.nlm.nih.gov/15314287/",
      "volume": "9"
    }
  ],
  "count": 1,
  "next_cursor": "",
  "query": "p53 apoptosis",
  "total": 1
}
```

### Search proteins

Search UniProtKB's protein entries by words, gene, function or UniProt's query syntax, optionally only reviewed (Swiss-Prot) entries from one organism. Returns one page with each protein's name, gene, organism and length; to see more, run it again with the next page it gives.

**Inputs**

- Search (`query`, text): Words to search for, or UniProt's query syntax such as gene:TP53 or keyword:Apoptosis. Can be left empty when an organism is picked.
- Reviewed (Swiss-Prot) only (`reviewed_only`, true/false): Only entries curators have reviewed, leaving out the far larger unreviewed (TrEMBL) set.
- Organism (`organism`, text): Only proteins from this organism. Pick one, or type a taxon ID or name.
- Order (`sort`, text): How to order the results. Defaults to best match first. One of: `score` (Best match first), `annotation_score desc` (Best annotated first), `accession asc` (Accession, A to Z), `protein_name asc` (Protein name, A to Z), `gene asc` (Gene name, A to Z), `organism_name asc` (Organism, A to Z), `length desc` (Longest first), `length asc` (Shortest first).
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `count` (number): Results on this page.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `proteins` (list): The proteins on this page.
- `query` (text): The query sent to UniProt.
- `total` (number): Results matching in all.

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "proteins": [
    {
      "accession": "P04637",
      "annotation_score": 5.0,
      "entry_name": "P53_HUMAN",
      "gene": "TP53",
      "length": 393,
      "organism": "Homo sapiens",
      "protein_existence": "1: Evidence at protein level",
      "protein_name": "Cellular tumor antigen p53",
      "reviewed": true,
      "summary": "TP53 \u00b7 Cellular tumor antigen p53 \u00b7 Homo sapiens \u00b7 393 aa \u00b7 reviewed",
      "taxon_id": 9606,
      "url": "https://www.uniprot.org/uniprotkb/P04637/entry"
    }
  ],
  "query": "(gene:TP53) AND reviewed:true AND organism_id:9606",
  "total": 1
}
```

### Search proteomes

Search the proteomes (the full protein sets of sequenced organisms) by organism, with each one's size, BUSCO completeness and genome assembly.

**Inputs**

- Search (`query`, text, required): An organism's name, or words such as Escherichia coli K-12.
- Type (`proteome_type`, text): Only this kind of proteome. Reference proteomes are the best-annotated ones. Leave blank for all. One of: `REFERENCE` (Reference proteomes), `NON_REFERENCE` (Other proteomes), `EXCLUDED` (Excluded proteomes).
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `count` (number): Results on this page.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `proteomes` (list): The proteomes on this page.
- `query` (text): The query sent to UniProt.
- `total` (number): Results matching in all.

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "proteomes": [
    {
      "annotation_source": "Ensembl",
      "assembly_id": "GCA_000001405.29",
      "assembly_level": "full",
      "busco_score": 99.0,
      "common_name": "Human",
      "cpd_status": "Unknown",
      "gene_count": 20652,
      "id": "UP000005640",
      "modified": "2026-04-22",
      "organism": "Homo sapiens",
      "protein_count": 147520,
      "taxon_id": 9606,
      "type": "Reference proteome",
      "url": "https://www.uniprot.org/proteomes/UP000005640"
    }
  ],
  "query": "(Homo sapiens) AND proteome_type:REFERENCE",
  "total": 1
}
```

### Search taxonomy

Search UniProt's taxonomy for organisms and groups by name, optionally of one rank, with each one's taxon ID, lineage and protein counts.

**Inputs**

- Search (`query`, text, required): A scientific or common name, such as Drosophila or zebrafish.
- Rank (`rank`, text): Only taxa of this rank. Leave blank for any rank. One of: `SPECIES`, `SUBSPECIES`, `STRAIN`, `GENUS`, `FAMILY`, `ORDER`, `CLASS`, `PHYLUM`, `KINGDOM`, `DOMAIN`.
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `count` (number): Results on this page.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `query` (text): The query sent to UniProt.
- `taxa` (list): The taxa on this page.
- `total` (number): Results matching in all.

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "query": "(homo) AND rank:SPECIES",
  "taxa": [
    {
      "common_name": "Human",
      "lineage": [
        "Eukaryota",
        "Metazoa",
        "Chordata",
        "Mammalia",
        "Primates",
        "Homo"
      ],
      "mnemonic": "HUMAN",
      "parent_id": 9605,
      "parent_name": "Homo",
      "proteome_count": 2,
      "rank": "species",
      "reviewed_protein_count": 20432,
      "scientific_name": "Homo sapiens",
      "taxon_id": 9606,
      "unreviewed_protein_count": 190356,
      "url": "https://www.uniprot.org/taxonomy/9606"
    }
  ],
  "total": 1
}
```

### Search UniParc sequences

Search UniParc, the archive of every distinct protein sequence in the public databases, by accession, database ID, checksum, gene or organism.

**Inputs**

- Search (`query`, text, required): An accession, a database ID, a checksum, or UniProt's query syntax such as gene:TP53 AND organism_id:9606.
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `count` (number): Results on this page.
- `entries` (list): The sequences on this page.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `query` (text): The query sent to UniProt.
- `total` (number): Results matching in all.

**Example output**

```json
{
  "count": 1,
  "entries": [
    {
      "crc64": "AD5C149FD8106131",
      "first_seen": "1989-07-01",
      "last_seen": "2026-09-02",
      "length": 393,
      "organisms": [
        "Homo sapiens",
        "Pan troglodytes"
      ],
      "uniprot_accessions": [
        "P04637",
        "K7PPA8"
      ],
      "upi": "UPI000002ED67",
      "url": "https://www.uniprot.org/uniparc/UPI000002ED67/entry"
    }
  ],
  "next_cursor": "",
  "query": "P04637",
  "total": 1
}
```

### Search UniRef clusters

Search UniRef, which groups similar sequences into clusters at 100%, 90% and 50% identity, for example to find a protein's close relatives. Each cluster comes with its size and representative protein.

**Inputs**

- Search (`query`, text, required): Words, a protein name or an accession whose clusters to find, such as P04637.
- Identity (`identity`, text): Only clusters at this level of sequence identity. Leave blank for all three. One of: `1.0` (100% identical (UniRef100)), `0.9` (90% identical (UniRef90)), `0.5` (50% identical (UniRef50)).
- Page size (`page_size`, number): How many to return, 1 to 500. Defaults to 25. From 1 to 500.
- Next page cursor (`cursor`, text): The 'next_cursor' from the previous page, to get the page after it. Keep the other fields the same.

**Outputs**

- `clusters` (list): The clusters on this page.
- `count` (number): Results on this page.
- `next_cursor` (text): Pass as 'cursor' for the next page; blank on the last.
- `query` (text): The query sent to UniProt.
- `total` (number): Results matching in all.

**Example output**

```json
{
  "clusters": [
    {
      "common_taxon": "Euarchontoglires",
      "common_taxon_id": 314146,
      "id": "UniRef90_P04637",
      "identity": "UniRef90",
      "member_count": 104,
      "name": "Cellular tumor antigen p53",
      "organism_count": 28,
      "representative": {
        "accessions": [
          "P04637"
        ],
        "id": "P53_HUMAN",
        "length": 393,
        "organism": "Homo sapiens (Human)",
        "protein_name": "Cellular tumor antigen p53",
        "taxon_id": 9606,
        "type": "UniProtKB ID",
        "uniparc_id": "UPI000002ED67"
      },
      "updated": "2026-09-02",
      "url": "https://www.uniprot.org/uniref/UniRef90_P04637"
    }
  ],
  "count": 1,
  "next_cursor": "",
  "query": "(P04637) AND identity:0.9",
  "total": 1
}
```

### Submit ID mapping

Start a job that maps IDs from one database to another, such as UniProt accessions to Ensembl genes or gene names to UniProt entries. Returns a job ID for 'Get ID mapping status' and 'Get ID mapping results'.

**Inputs**

- From (`from_db`, text, required): The database the IDs are from, such as UniProtKB AC/ID or Gene Name.
- To (`to_db`, text, required): The database to map them to. Only those the chosen source can map to are listed.
- IDs (`ids`, list, required): The IDs to map, up to 100,000.
- Organism (`taxon_id`, text): Only for mapping gene names: the organism they belong to. Pick one, or type a taxon ID.

**Outputs**

- `from_db` (text): The source database.
- `id_count` (number): How many IDs were sent.
- `job_id` (text): The mapping job's ID.
- `summary` (text): The job in one line.
- `to_db` (text): The target database.

**Example output**

```json
{
  "from_db": "UniProtKB_AC-ID",
  "id_count": 2,
  "job_id": "AoofAwrYHV",
  "summary": "Mapping 2 IDs from UniProtKB_AC-ID to Ensembl: job AoofAwrYHV",
  "to_db": "Ensembl"
}
```
