/uniprot/taxons

POST /api/uniprot/taxons

Price: 1 credit

Get an NCBI taxonomy node as UniProt holds it, with its lineage and protein counts

How to use it

Resolves an NCBI taxon id to the node UniProt holds for it. Any rank resolves, not only species, so 40674 (Mammalia) answers as readily as 9606 - which makes this the way to turn a clade name into the id that uniprot/proteins/search takes as `taxonomy_id`. `lineage` runs root-first, so lineage[0] is the least specific clade and the last entry is the immediate parent, the same node `parent` carries. The protein counts cover the whole clade beneath the taxon, not the taxon on its own.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• taxon integer required — NCBI taxonomy identifier (examples: 9606, 10090, 40674; min: 1)

Response

• @type string (default: "UniprotTaxon")
• taxon_id integer required
• scientific_name string (default: "")
• common_name string (default: "")
• mnemonic string (default: "")
• rank string (default: "")
• is_hidden boolean nullable
• is_active boolean nullable
• other_names array (default: [])
• synonyms array (default: [])
• strains array (default: [])
  • @type string (default: "UniprotTaxonStrain")
  • name string (default: "")
  • synonyms array (default: [])
• parent 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
• lineage array (default: [])
  • @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
• hosts array (default: [])
  • @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
• links array (default: [])
• reviewed_protein_count integer nullable
• unreviewed_protein_count integer nullable
• proteome_count integer nullable
• reference_proteome_count integer nullable
• 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 — Taxon 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.