togoid_convertId
Read-only
Convert biological identifiers across databases like NCBI Gene, UniProt, and PDB. Map IDs between source and target datasets, including multi-hop routes, with optional pagination.
Instructions
Convert identifiers from one database to another.
Maps IDs between biological databases — e.g., NCBI Gene IDs to UniProt accessions, or UniProt accessions to PDB structure IDs.
RETURNS a JSON string of a bare array of [source_id, target_id] pairs, e.g. '[["672", "P38398"], ["675", "O15129"]]'. An empty array means none of the input IDs converted along the route.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | Source IDs. Accepts either a list of strings (e.g., ["672", "675", "7157"]) or a comma-separated string ("672,675,7157"). Examples: "672,675,7157" (NCBI Gene IDs), "P38398,P04637" (UniProt) | |
| limit | No | Maximum number of results (default 10000) | |
| route | Yes | Comma-separated pair of dataset keys: 'source,target'. NOTE: this is a single joined string, NOT separate `source`/`target` args (as in countId/getRelation) — because a route may be multi-hop (3+ datasets). Examples: - 'ncbigene,uniprot' (Gene → Protein) - 'uniprot,pdb' (Protein → 3D Structure) - 'ncbigene,ensembl_gene' (NCBI Gene → Ensembl Gene) - 'chembl_target,uniprot' (Drug Target → Protein) - 'uniprot,chembl_target' (Protein → Drug Target) - 'ncbigene,hgnc' (Gene → HGNC symbol) Multi-hop routes are also supported: - 'ncbigene,uniprot,pdb' (Gene → Protein → Structure) | |
| offset | No | Pagination offset for large result sets |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |