Uniprot Database

{
  "description": "\"Direct REST API access to UniProt. Protein searches, FASTA retrieval, ID mapping, Swiss-Prot/TrEMBL. For Python workflows with multiple databases, prefer bioservices (unified interface to 40+ services). Use this for direct HTTP/REST work or UniProt-specific control.\"",
  "references": {
    "files": [
      "references/api_examples.md",
      "references/api_fields.md",
      "references/id_mapping_databases.md",
      "references/query_syntax.md"
    ]
  },
  "content": "### 1. Searching for Proteins\r\n\r\nSearch UniProt using natural language queries or structured search syntax.\r\n\r\n**Common search patterns:**\r\n```python\r\nquery = \"insulin AND organism_name:\\\"Homo sapiens\\\"\"\r\n\r\nquery = \"gene:BRCA1 AND reviewed:true\"\r\n\r\nquery = \"accession:P12345\"\r\n\r\nquery = \"length:[100 TO 500]\"\r\n\r\nquery = \"taxonomy_id:9606\"  # Human proteins",
  "name": "uniprot-database",
  "id": "scientific-db-uniprot-database",
  "sections": {
    "Best Practices": "1. **Use reviewed entries when possible**: Filter with `reviewed:true` for Swiss-Prot (manually curated) entries\r\n2. **Specify format explicitly**: Choose the most appropriate format (FASTA for sequences, TSV for tabular data, JSON for programmatic parsing)\r\n3. **Use field selection**: Only request fields you need to reduce bandwidth and processing time\r\n4. **Handle pagination**: For large result sets, implement proper pagination or use the stream endpoint\r\n5. **Cache results**: Store frequently accessed data locally to minimize API calls\r\n6. **Rate limiting**: Be respectful of API resources; implement delays for large batch operations\r\n7. **Check data quality**: TrEMBL entries are computational predictions; Swiss-Prot entries are manually reviewed",
    "Additional Resources": "- **API Documentation**: https://www.uniprot.org/help/api\r\n- **Interactive API Explorer**: https://www.uniprot.org/api-documentation\r\n- **REST Tutorial**: https://www.uniprot.org/help/uniprot_rest_tutorial\r\n- **Query Syntax Help**: https://www.uniprot.org/help/query-fields\r\n- **SPARQL Endpoint**: https://sparql.uniprot.org/ (for advanced graph queries)",
    "Overview": "UniProt is the world's leading comprehensive protein sequence and functional information resource. Search proteins by name, gene, or accession, retrieve sequences in FASTA format, perform ID mapping across databases, access Swiss-Prot/TrEMBL annotations via REST API for protein analysis.",
    "Query Syntax Examples": "**Boolean operators:**\r\n```\r\nkinase AND organism_name:human\r\n(diabetes OR insulin) AND reviewed:true\r\ncancer NOT lung\r\n```\r\n\r\n**Field-specific searches:**\r\n```\r\ngene:BRCA1\r\naccession:P12345\r\norganism_id:9606\r\ntaxonomy_name:\"Homo sapiens\"\r\nannotation:(type:signal)\r\n```\r\n\r\n**Range queries:**\r\n```\r\nlength:[100 TO 500]\r\nmass:[50000 TO 100000]\r\n```\r\n\r\n**Wildcards:**\r\n```\r\ngene:BRCA*\r\nprotein_name:kinase*\r\n```\r\n\r\nSee `/references/query_syntax.md` for comprehensive syntax documentation.",
    "When to Use This Skill": "This skill should be used when:\r\n- Searching for protein entries by name, gene symbol, accession, or organism\r\n- Retrieving protein sequences in FASTA or other formats\r\n- Mapping identifiers between UniProt and external databases (Ensembl, RefSeq, PDB, etc.)\r\n- Accessing protein annotations including GO terms, domains, and functional descriptions\r\n- Batch retrieving multiple protein entries efficiently\r\n- Querying reviewed (Swiss-Prot) vs. unreviewed (TrEMBL) protein data\r\n- Streaming large protein datasets\r\n- Building custom queries with field-specific search syntax",
    "Python Implementation": "For programmatic access, use the provided helper script `scripts/uniprot_client.py` which implements:\r\n\r\n- `search_proteins(query, format)` - Search UniProt with any query\r\n- `get_protein(accession, format)` - Retrieve single protein entry\r\n- `map_ids(ids, from_db, to_db)` - Map between identifier types\r\n- `batch_retrieve(accessions, format)` - Retrieve multiple entries\r\n- `stream_results(query, format)` - Stream large result sets\r\n\r\n**Alternative Python packages:**\r\n- **Unipressed**: Modern, typed Python client for UniProt REST API\r\n- **bioservices**: Comprehensive bioinformatics web services client",
    "Core Capabilities": "query = \"go:0005515\"  # Protein binding\r\n```\r\n\r\nUse the API search endpoint: `https://rest.uniprot.org/uniprotkb/search?query={query}&format={format}`\r\n\r\n**Supported formats:** JSON, TSV, Excel, XML, FASTA, RDF, TXT\r\n\r\n### 2. Retrieving Individual Protein Entries\r\n\r\nRetrieve specific protein entries by accession number.\r\n\r\n**Accession number formats:**\r\n- Classic: P12345, Q1AAA9, O15530 (6 characters: letter + 5 alphanumeric)\r\n- Extended: A0A022YWF9 (10 characters for newer entries)\r\n\r\n**Retrieve endpoint:** `https://rest.uniprot.org/uniprotkb/{accession}.{format}`\r\n\r\nExample: `https://rest.uniprot.org/uniprotkb/P12345.fasta`\r\n\r\n### 3. Batch Retrieval and ID Mapping\r\n\r\nMap protein identifiers between different database systems and retrieve multiple entries efficiently.\r\n\r\n**ID Mapping workflow:**\r\n1. Submit mapping job to: `https://rest.uniprot.org/idmapping/run`\r\n2. Check job status: `https://rest.uniprot.org/idmapping/status/{jobId}`\r\n3. Retrieve results: `https://rest.uniprot.org/idmapping/results/{jobId}`\r\n\r\n**Supported databases for mapping:**\r\n- UniProtKB AC/ID\r\n- Gene names\r\n- Ensembl, RefSeq, EMBL\r\n- PDB, AlphaFoldDB\r\n- KEGG, GO terms\r\n- And many more (see `/references/id_mapping_databases.md`)\r\n\r\n**Limitations:**\r\n- Maximum 100,000 IDs per job\r\n- Results stored for 7 days\r\n\r\n### 4. Streaming Large Result Sets\r\n\r\nFor large queries that exceed pagination limits, use the stream endpoint:\r\n\r\n`https://rest.uniprot.org/uniprotkb/stream?query={query}&format={format}`\r\n\r\nThe stream endpoint returns all results without pagination, suitable for downloading complete datasets.\r\n\r\n### 5. Customizing Retrieved Fields\r\n\r\nSpecify exactly which fields to retrieve for efficient data transfer.\r\n\r\n**Common fields:**\r\n- `accession` - UniProt accession number\r\n- `id` - Entry name\r\n- `gene_names` - Gene name(s)\r\n- `organism_name` - Organism\r\n- `protein_name` - Protein names\r\n- `sequence` - Amino acid sequence\r\n- `length` - Sequence length\r\n- `go_*` - Gene Ontology annotations\r\n- `cc_*` - Comment fields (function, interaction, etc.)\r\n- `ft_*` - Feature annotations (domains, sites, etc.)\r\n\r\n**Example:** `https://rest.uniprot.org/uniprotkb/search?query=insulin&fields=accession,gene_names,organism_name,length,sequence&format=tsv`\r\n\r\nSee `/references/api_fields.md` for complete field list.",
    "Resources": "### scripts/\r\n`uniprot_client.py` - Python client with helper functions for common UniProt operations including search, retrieval, ID mapping, and streaming.\r\n\r\n### references/\r\n- `api_fields.md` - Complete list of available fields for customizing queries\r\n- `id_mapping_databases.md` - Supported databases for ID mapping operations\r\n- `query_syntax.md` - Comprehensive query syntax with advanced examples\r\n- `api_examples.md` - Code examples in multiple languages (Python, curl, R)"
  }
}

---
name: uniprot-database
description: "Direct REST API access to UniProt. Protein searches, FASTA retrieval, ID mapping, Swiss-Prot/TrEMBL. For Python workflows with multiple databases, prefer bioservices (unified interface to 40+ services). Use this for direct HTTP/REST work or UniProt-specific control."
---

# UniProt Database

## Overview

UniProt is the world's leading comprehensive protein sequence and functional information resource. Search proteins by name, gene, or accession, retrieve sequences in FASTA format, perform ID mapping across databases, access Swiss-Prot/TrEMBL annotations via REST API for protein analysis.

## When to Use This Skill

This skill should be used when:
- Searching for protein entries by name, gene symbol, accession, or organism
- Retrieving protein sequences in FASTA or other formats
- Mapping identifiers between UniProt and external databases (Ensembl, RefSeq, PDB, etc.)
- Accessing protein annotations including GO terms, domains, and functional descriptions
- Batch retrieving multiple protein entries efficiently
- Querying reviewed (Swiss-Prot) vs. unreviewed (TrEMBL) protein data
- Streaming large protein datasets
- Building custom queries with field-specific search syntax

## Core Capabilities

### 1. Searching for Proteins

Search UniProt using natural language queries or structured search syntax.

**Common search patterns:**
```python
# Search by protein name
query = "insulin AND organism_name:\"Homo sapiens\""

# Search by gene name
query = "gene:BRCA1 AND reviewed:true"

# Search by accession
query = "accession:P12345"

# Search by sequence length
query = "length:[100 TO 500]"

# Search by taxonomy
query = "taxonomy_id:9606"  # Human proteins

# Search by GO term
query = "go:0005515"  # Protein binding
```

Use the API search endpoint: `https://rest.uniprot.org/uniprotkb/search?query={query}&format={format}`

**Supported formats:** JSON, TSV, Excel, XML, FASTA, RDF, TXT

### 2. Retrieving Individual Protein Entries

Retrieve specific protein entries by accession number.

**Accession number formats:**
- Classic: P12345, Q1AAA9, O15530 (6 characters: letter + 5 alphanumeric)
- Extended: A0A022YWF9 (10 characters for newer entries)

**Retrieve endpoint:** `https://rest.uniprot.org/uniprotkb/{accession}.{format}`

Example: `https://rest.uniprot.org/uniprotkb/P12345.fasta`

### 3. Batch Retrieval and ID Mapping

Map protein identifiers between different database systems and retrieve multiple entries efficiently.

**ID Mapping workflow:**
1. Submit mapping job to: `https://rest.uniprot.org/idmapping/run`
2. Check job status: `https://rest.uniprot.org/idmapping/status/{jobId}`
3. Retrieve results: `https://rest.uniprot.org/idmapping/results/{jobId}`

**Supported databases for mapping:**
- UniProtKB AC/ID
- Gene names
- Ensembl, RefSeq, EMBL
- PDB, AlphaFoldDB
- KEGG, GO terms
- And many more (see `/references/id_mapping_databases.md`)

**Limitations:**
- Maximum 100,000 IDs per job
- Results stored for 7 days

### 4. Streaming Large Result Sets

For large queries that exceed pagination limits, use the stream endpoint:

`https://rest.uniprot.org/uniprotkb/stream?query={query}&format={format}`

The stream endpoint returns all results without pagination, suitable for downloading complete datasets.

### 5. Customizing Retrieved Fields

Specify exactly which fields to retrieve for efficient data transfer.

**Common fields:**
- `accession` - UniProt accession number
- `id` - Entry name
- `gene_names` - Gene name(s)
- `organism_name` - Organism
- `protein_name` - Protein names
- `sequence` - Amino acid sequence
- `length` - Sequence length
- `go_*` - Gene Ontology annotations
- `cc_*` - Comment fields (function, interaction, etc.)
- `ft_*` - Feature annotations (domains, sites, etc.)

**Example:** `https://rest.uniprot.org/uniprotkb/search?query=insulin&fields=accession,gene_names,organism_name,length,sequence&format=tsv`

See `/references/api_fields.md` for complete field list.

## Python Implementation

For programmatic access, use the provided helper script `scripts/uniprot_client.py` which implements:

- `search_proteins(query, format)` - Search UniProt with any query
- `get_protein(accession, format)` - Retrieve single protein entry
- `map_ids(ids, from_db, to_db)` - Map between identifier types
- `batch_retrieve(accessions, format)` - Retrieve multiple entries
- `stream_results(query, format)` - Stream large result sets

**Alternative Python packages:**
- **Unipressed**: Modern, typed Python client for UniProt REST API
- **bioservices**: Comprehensive bioinformatics web services client

## Query Syntax Examples

**Boolean operators:**
```
kinase AND organism_name:human
(diabetes OR insulin) AND reviewed:true
cancer NOT lung
```

**Field-specific searches:**
```
gene:BRCA1
accession:P12345
organism_id:9606
taxonomy_name:"Homo sapiens"
annotation:(type:signal)
```

**Range queries:**
```
length:[100 TO 500]
mass:[50000 TO 100000]
```

**Wildcards:**
```
gene:BRCA*
protein_name:kinase*
```

See `/references/query_syntax.md` for comprehensive syntax documentation.

## Best Practices

1. **Use reviewed entries when possible**: Filter with `reviewed:true` for Swiss-Prot (manually curated) entries
2. **Specify format explicitly**: Choose the most appropriate format (FASTA for sequences, TSV for tabular data, JSON for programmatic parsing)
3. **Use field selection**: Only request fields you need to reduce bandwidth and processing time
4. **Handle pagination**: For large result sets, implement proper pagination or use the stream endpoint
5. **Cache results**: Store frequently accessed data locally to minimize API calls
6. **Rate limiting**: Be respectful of API resources; implement delays for large batch operations
7. **Check data quality**: TrEMBL entries are computational predictions; Swiss-Prot entries are manually reviewed

## Resources

### scripts/
`uniprot_client.py` - Python client with helper functions for common UniProt operations including search, retrieval, ID mapping, and streaming.

### references/
- `api_fields.md` - Complete list of available fields for customizing queries
- `id_mapping_databases.md` - Supported databases for ID mapping operations
- `query_syntax.md` - Comprehensive query syntax with advanced examples
- `api_examples.md` - Code examples in multiple languages (Python, curl, R)

## Additional Resources

- **API Documentation**: https://www.uniprot.org/help/api
- **Interactive API Explorer**: https://www.uniprot.org/api-documentation
- **REST Tutorial**: https://www.uniprot.org/help/uniprot_rest_tutorial
- **Query Syntax Help**: https://www.uniprot.org/help/query-fields
- **SPARQL Endpoint**: https://sparql.uniprot.org/ (for advanced graph queries)