/chembl/assays

POST /api/chembl/assays

Price: 1 credit

Get a ChEMBL assay by its identifier

How to use it

This is the experiment a measurement was made in, not the measurement itself, so the numbers live on the activity endpoints and this route explains what was being measured and how. `confidence_score` grades how firmly the assay was mapped to its target, 9 meaning a direct single-protein assignment and a low score meaning the target is a homologous protein or a whole organism. Identifiers share one CHEMBL<number> namespace, and this route rejects non-assay ids.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• assay string required — ChEMBL assay identifier, or a ChEMBL page URL containing one (examples: "CHEMBL702885", "https://www.ebi.ac.uk/chembl/explore/assay/CHEMBL702885"; minLength: 1)

Response

• @type string (default: "ChemblAssay")
• id string (default: "")
• description string (default: "")
• assay_type string (default: "")
• assay_type_description string (default: "")
• assay_category string (default: "")
• assay_group string (default: "")
• assay_test_type string (default: "")
• assay_organism string (default: "")
• assay_tax_id string (default: "")
• assay_strain string (default: "")
• assay_tissue string (default: "")
• assay_cell_type string (default: "")
• assay_subcellular_fraction string (default: "")
• target_id string (default: "")
• document_id string (default: "")
• cell_id string (default: "")
• tissue_id string (default: "")
• confidence_score integer nullable
• confidence_description string (default: "")
• relationship_type string (default: "")
• relationship_description string (default: "")
• bao_format string (default: "")
• bao_label string (default: "")
• source_id integer nullable
• source_assay_id string (default: "")
• assay_index string (default: "")
• variant_sequence_accession string (default: "")
• variant_mutation string (default: "")
• parameters array (default: [])
  • @type string (default: "ChemblAssayParameter")
  • type string (default: "")
  • relation string (default: "")
  • value string (default: "")
  • units string (default: "")
  • text_value string (default: "")
  • standard_type string (default: "")
  • standard_relation string (default: "")
  • standard_value string (default: "")
  • standard_units string (default: "")
  • standard_text_value string (default: "")
  • comments string (default: "")
• classifications array (default: [])
  • @type string (default: "ChemblAssayClassification")
  • id string (default: "")
  • source string (default: "")
  • class_level_1 string (default: "")
  • class_level_2 string (default: "")
  • class_level_3 string (default: "")
  • assay_class_type 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 — Assay 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.