POST /api/kegg/entries/search
Price: 10 credits
Search one KEGG database, or one organism's genes, by keyword or chemical property
Pick the database you mean - the same word lands in different ones, so `glucose` in `compound` gives molecules and in `genes` gives gene annotations. Set `organism` instead of `database` to search one species' genes; `genes` searches every species at once and stops at 10,000 rows, so narrow by organism when a query is broad. Words are ANDed, never ORed or matched as a phrase. With `option` set the query is a formula or a mass rather than text, and the match comes back in `matched_value` while `names` is empty. A query with no hits is an empty result, not an error.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)query string required — Search terms; several words are ANDed together (examples: "glucose", "shiga toxin", "C6H12O6", "300-310"; minLength: 1)database string nullable — KEGG database to search (one of: "pathway", "brite", "module", "ko", "orthology", "genes", "genome", "vg", "vp", "ag", "ligand", "compound", "glycan", "reaction", "rclass", "rmodule", "enzyme", "network", "variant", "disease", "drug", "dgroup"; examples: "compound", "genes", "disease")organism string nullable — Three to five letter KEGG organism code, searched instead of `database` (examples: "hsa", "eco", "mmu"; minLength: 3; maxLength: 5)option string nullable — Match the query against a chemical property instead of names; `mol_weight` and `exact_mass` also take a range written as 300-310 (one of: "formula", "exact_mass", "mol_weight"; examples: "formula", "exact_mass", "mol_weight")count integer required — Max number of results (min: 1; max: 10000)@type string (default: "KeggEntryHit")id string requireddatabase string (default: "")names array (default: [])matched_value string (default: "")url string (default: "")422 — Unknown database, or neither database nor organism given 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 — The entity was not found, or a precondition failed 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.