/kegg/entries

POST /api/kegg/entries

Price: 20 credits

Get KEGG entries by identifier, across genes, pathways, compounds, drugs, diseases and enzymes

How to use it

The identifier carries its own database, so `C00031` is a compound and `hsa:7157` is a human gene - pass the id as KEGG writes it. A database prefix such as `cpd:`, `dr:`, `path:` or `ec:` is optional and returns the same record as the bare id, while an organism gene keeps its organism code. Ask for several entries in one call rather than looping: they are fetched together. Which fields come back depends entirely on the database, so read `fields` for anything the typed fields do not carry - a compound has no `symbols` and a gene has no `formula`, and neither case is missing data. An id KEGG does not know is dropped from the answer rather than failing the call, so compare what you asked for against `id`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• entries array required — KEGG entry identifiers, database-prefixed where the database is not part of the id itself (examples: ["hsa:7157"], ["C00031","D00009"], ["hsa05210","map05210","ec:2.7.11.1"]; minItems: 1; maxItems: 100)
• count integer required — Max number of results (min: 1; max: 100)

Response

• @type string (default: "KeggEntry")
• id string required
• database string (default: "")
• entry_code string (default: "")
• entry_kind string (default: "")
• names array (default: [])
• definition string (default: "")
• description string (default: "")
• formula string (default: "")
• exact_mass number nullable
• mol_weight number nullable
• organism string (default: "")
• organism_name string (default: "")
• symbols array (default: [])
• classes array (default: [])
• position string (default: "")
• pathways array (default: [])
  • @type string (default: "KeggRef")
  • id string required
  • name string (default: "")
• modules array (default: [])
  • @type string (default: "KeggRef")
  • id string required
  • name string (default: "")
• diseases array (default: [])
  • @type string (default: "KeggRef")
  • id string required
  • name string (default: "")
• drugs array (default: [])
  • @type string (default: "KeggRef")
  • id string required
  • name string (default: "")
• networks array (default: [])
  • @type string (default: "KeggRef")
  • id string required
  • name string (default: "")
• orthology array (default: [])
  • @type string (default: "KeggRef")
  • id string required
  • name string (default: "")
• db_links array (default: [])
  • @type string (default: "KeggDbLink")
  • database string required
  • ids array (default: [])
• literature_references array (default: [])
  • @type string (default: "KeggLiteratureReference")
  • reference string (default: "")
  • authors string (default: "")
  • article_title string (default: "")
  • journal string (default: "")
• fields array (default: [])
  • @type string (default: "KeggField")
  • name string required
  • lines array (default: [])
  • subfields array (default: [])
    • @type string (default: "KeggSubField")
    • name string required
    • lines array (default: [])
• url string (default: "")

Errors

• 422 — Malformed identifier 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 — No entry 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.