# searchProteins

**Identifier:** `uniprot_searchProteins`

**Provider:** [UniProt](https://kirha.com/providers/uniprot.md)

Search UniProtKB proteins by gene symbol, protein name or free text. Defaults to human, reviewed (Swiss-Prot) entries. Use the returned accessions with getProteinEntry for function, disease, variants, drugs and cross-references, or with mapIds to convert identifiers.

## Run it with the CLI

```bash
kirha tools run uniprot_searchProteins \
  --input '{}'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "uniprot_searchProteins",
  "input": {}
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "geneName": {
      "description": "Exact gene symbol or synonym, e.g. EGFR, HER2",
      "minLength": 1,
      "type": "string"
    },
    "limit": {
      "default": 10,
      "maximum": 50,
      "minimum": 1,
      "type": "number"
    },
    "organism": {
      "default": "9606",
      "description": "NCBI taxon ID or scientific name, e.g. 9606, 10090, 'Mus musculus'. 'all' for every organism",
      "type": "string"
    },
    "proteinName": {
      "description": "e.g. 'epidermal growth factor receptor'",
      "minLength": 1,
      "type": "string"
    },
    "query": {
      "description": "Free text or UniProt query syntax, e.g. 'kinase AND keyword:KW-0675'",
      "minLength": 1,
      "type": "string"
    },
    "reviewedOnly": {
      "default": true,
      "type": "boolean"
    }
  },
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "accessions": {
      "description": "UniProt accessions for getProteinEntry or mapIds",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "context": {
      "type": "string"
    },
    "proteins": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "accession": {
            "type": "string"
          },
          "entryName": {
            "type": "string"
          },
          "geneSymbol": {
            "type": "string"
          },
          "length": {
            "type": "number"
          },
          "organism": {
            "type": "string"
          },
          "proteinName": {
            "type": "string"
          },
          "reviewed": {
            "type": "boolean"
          },
          "taxonId": {
            "type": "number"
          }
        },
        "required": [
          "accession",
          "reviewed"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "totalResults": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "totalResults",
    "proteins",
    "accessions"
  ],
  "type": "object"
}
```

## Related tools

Other UniProt tools that this tool refers to, or that refer to it.

- [`getProteinEntry`](https://kirha.com/providers/uniprot/getProteinEntry.md)
- [`mapIds`](https://kirha.com/providers/uniprot/mapIds.md)

-----

[All UniProt tools](https://kirha.com/providers/uniprot.md) · [< Back to tools list](https://kirha.com/tools.md)