/drugbank/categories

POST /api/drugbank/categories

Price: 10 credits

Get one DrugBank therapeutic category by its accession number. Returns the category name, its description, its type, its parent categories, its synonyms, its ATC classification codes, the total and approved number of drugs filed under it, the counts of distinct targets, marketed products, routes of administration and subcategories where DrugBank shows them, and the first 25 drugs with accession number and name.

How to use it

`drug_count` is the total number of drugs DrugBank files under the category, while `drugs` carries only the first 25 of them, so a category with more members returns a partial list. Member rows carry only an id and a name — the rest of each drug needs drugbank/drugs. A retired accession number resolves to the category that absorbed it and the response carries the current one in `id`. `distinct_target_count` is a different number from `target_count` in drugbank/categories/search (10 against 164 on DBCAT001068), and the count fields are null where the page shows no count. Category ids come from drugbank/categories/search or from the `categories` field of drugbank/drugs. `atc_classes` gives the WHO ATC codes from the broadest level down to the most specific, where DrugBank has mapped the category at all.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_id string required — DrugBank category accession number. Case-insensitive, and a go.drugbank.com category URL is accepted in place of the id (examples: "DBCAT000002", "https://go.drugbank.com/categories/DBCAT000049"; minLength: 1)

Response

• @type string (default: "DrugbankCategory")
• id string required
• name string (default: "")
• web_url string (default: "")
• description string (default: "")
• category_type string (default: "")
• parent_categories array (default: [])
  • @type string (default: "DrugbankDrugCategory")
  • id string (default: "")
  • name string (default: "")
  • web_url string (default: "")
• synonyms array (default: [])
• atc_classes array (default: [])
  • @type string (default: "DrugbankAtcClass")
  • code string (default: "")
  • name string (default: "")
• drug_count integer nullable
• approved_drug_count integer nullable
• distinct_target_count integer nullable
• product_count integer nullable
• route_count integer nullable
• subcategory_count integer nullable
• drugs array (default: [])
  • @type string (default: "DrugbankDrugSummary")
  • id string required
  • name string (default: "")
  • web_url string (default: "")
  • description string (default: "")
  • molecular_formula string (default: "")
  • molecular_weight number nullable
  • categories array (default: [])
  • category_ids array (default: [])

Errors

• 422 — category_id was not a DrugBank category accession number — DBCAT followed by exactly six digits 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 category with that accession number. Ids look like DBCAT000002 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.