Skip to main content

ChEMBL 21 web services update

By





Traditionally, along with the release of the new ChEMBL version, we have made a few updates to our RESTful API. Below you can find a short description of the most important changes:

 

Data API (https://www.ebi.ac.uk/chembl/api/data/docs):

1. New resources: Since ChEMBL 21 introduced a few new tables, we have made them available via the API. The new resources are:

Moreover, the target_component endpoint has been enhanced to provide a list of related GO terms.

2. Solr-based search: a very popular feature request was the ability to search resources by a keyword. A form of searching was already possible before, using filtering terms, such as [i]contains,[i]startswith and [i]endswtith filters. For example, in order to search molecules for 'metazide' in their preferred name, this filter can be used:


However, this approach has many drawbacks:
  • it's executed on the database level and can be very slow
  • in order to search in several attributes, you have to add the filter separately to each of them, which can result with a very long tail of filters
  • you can't search in one-to-many/many-to-many attributes (for example you cannot search molecule by its synonym because a molecule can have many synonyms)
The good news is that in order to solve this problem, we implemented a solr-based solution using django-haystack. Let's just jump straight into examples:

What if we want to search for some term in molecules, targets and assays at once? No problem, the chembl_id_lookup endpoint can be used for this, for example searching for 'morphine' will look like:


Looking at the results of the last request, it's very easy to tell (by examining the 'entity_type' attribute) that a large number of compounds and assays were returned.

Another important thing to note is that every result of search query has a 'score' attribute, indicating the relevancy of the given result. The results are sorted by the score descending (i.e. the most relevant are always first) and although you can add additional filters, for example:

you cannot change ordering by appending 'order_by=...' attribute.

You may ask, why do we only offer searching for 3 resources (well, 4 including the chembl_id_lookup)? This is because these resources are most popular and most important but we are planning to add more (such as searching in document abstracts, cell descriptions, activities) in the near future. If you have any suggestions about which resources should offer search functionality in the first place, please let us know in comments or write your suggestions to chembl-help@ebi.ac.uk. You can easily check which resources offer searching by looking at our live documentation, where all the searching methods are listed.

Furthermore, we would also appreciate your feedback about the quality of search results. If you believe that some results should have higher relevancy score than others and currently that's not the case, let us know so we can properly adjust boosts.

3. Compound images have transparent background by default. So now you can use them regardless of the color scheme used in your website:





 It's also possible to explicitly specify background color, by appending the 'bgColor=color_name' attribute for example in order to get a nice and warm orange background you have do:

The colour names are the standard names defined for HTML, you can check the full list here.

4. Datatables support: Datatables is one of the most popular jQuery plugins for rendering tabular data. In order for you to use it in a generic way (i.e. write the code in such a way it can use datatables to render data from any API endpoint), we have to be able to provide definitions of columns (e.g. how many columns we have for a given endpoint, are they searchable, sortable, what type of data they contain). This is possible using the schema API method (for example: https://www.ebi.ac.uk/chembl/api/data/molecule/schema.json), that describes every resource in a vary detailed way; however, the data provided by the schema has to be transformed to the format compatible with datatables. This is why we decided to provide another method, which is directly compatible with datatables: https://www.ebi.ac.uk/chembl/api/data/molecule/datatables.json.

Below is an example code snippet that renders a datatable from the target resource. Click on the 'Result' tab to see the table - you can sort by columns, change pages and set the number of rows displayed per page. Notice that if you change the name of the resource in the first line of code (from 'target' to 'source' or 'assay' for example), the columns and data will change as well.



Utils API (https://www.ebi.ac.uk/chembl/api/utils/docs):

There is a small update to the utilities (Beaker) part of the API. There is a new method called ctab2xyz, which converts a molfile to the xyz file format. You will notice the new method is now available in the live docs. Also the compound rendering code has been improved so it's now compatible with the latest versions of Pillow library.

Python client (https://github.com/chembl/chembl_webresource_client):

Our official Python client library has been updated as well in order to reflect recent changes. Just to remind you, in order to get the latest version of the client, you should install it via pip:

pip install -U chembl_webresource_client

Some examples of using recently added resources (drug indications, GO slim, drug metabolism):



Searching is exposed as well, examples below:



Another important change to the client is the integration with UniChem API. The latter deserves a separate blog post, so stay tuned.

Comments

Post a Comment

Popular posts from this blog

PKIS data in ChEMBL

By Anonymous
The Protein Kinase Inhibitor Set (PKIS) made available by GSK was recently mentioned on  In the Pipeline .  In collaboration with GSK, we are making the data being generated on these compounds available via  the ChEMBL database.  We are also creating a portal for the compound set, where the structures can be browsed and downloaded, direct links to the data are provided and useful information can be posted. A preliminary version is available  here : feedback would be appreciated. The data generated on the PKIS set and deposited in ChEMBL may be downloaded in CSV format here  (note that the Luciferase dataset described in the recent PLoS paper will be in the next release of ChEMBL). Alternatively, to view the data in the ChEMBL web interface, follow these steps: On the home page, enter 'GSK_PKIS' in the search box and click on the 'Assays' button... On the 'Please select...' menu on the right, choose 'Display Bioactivities'...
Post a Comment
Read more

A python client for accessing ChEMBL web services

By
Motivation The CheMBL Web Services provide simple reliable programmatic access to the data stored in ChEMBL database. RESTful API approaches are quite easy to master in most languages but still require writing a few lines of code. Additionally, it can be a challenging task to write a nontrivial application using REST without any examples. These factors were the motivation for us to write a small client library for accessing web services from Python. Why Python? We choose this language because Python has become extremely popular (and still growing in use) in scientific applications; there are several Open Source chemical toolkits available in this language, and so the wealth of ChEMBL resources and functionality of those toolkits can be easily combined. Moreover, Python is a very web-friendly language and we wanted to show how easy complex resource acquisition can be expressed in Python. Reinventing the wheel? There are already some libraries providing access to ChEMBL d
1 comment
Read more

Release of ChEMBL 33

By
We are pleased to announce the release of ChEMBL 33! This fresh release comes with a few new data soures and also some new features: we added bioactivity data for understudied SLC targets from the RESOLUTE project and included a flag for Natural Products and for Chemical Probes. An annotation for the ACTION_TYPE of a measurement was included for approx. 270 K bioactivities. We also time-stamped every document in ChEMBL with their CREATION_DATE! Have fun playing around with ChEMBL 33 over the summer and please send feedback via chembl-help@ebi.ac.uk .   ChEMBL database version ChEMBL 33 release notes ___________________________________________ # This version of the database, prepared on 31/05/2023 contains:      2,399,743 compounds (of which 2,372,674 have mol files)      3,051,613 compound records (non-unique compounds)        20,334,684 activities         1,610,596 assays      15,398 targets      88,630 documents BioAssay Data Sources:    Number Assays:    Number
Post a Comment
Read more

Chemistry and Nature

By
  As the Great Big Green Week (UK) draws to a close, so does EMBL-EBI’s own Sustainability week. The Wellcome Genome Campus held events in the areas of recycling, energy use, and biodiversity. The ChEMBL team was keen to get involved and we developed our own Nature Trail event highlighting some of the bioactive compounds from the flora and fauna found on-site, and elsewhere. Our favourite examples include the sensation of mint and chilli and the glorious smell of rain! The full Nature Trail can be made available for external Public Engagement events upon request . Databases, such as ChEMBL , are large stores of structured data, including genetic, biological, and chemistry data for life sciences research. Data on the natural world is often held by wildlife organisations; this can be used to research biodiversity and species decline. Various Citizen Science initiatives mean that everyone can get involved in submitting nature records. So why not join in with the Butterfly Conservation’s B
Post a Comment
Read more

Accessing SureChEMBL data in bulk

By
It is the peak of the summer (at least in this hemisphere) and many of our readers/users will be on holiday, perhaps on an island enjoying the sea. Luckily, for the rest of us there is still the 'sea' of SureChEMBL data that awaits to be enjoyed and explored for hidden 'treasures' (let me know if I pushed this analogy too far). See here and  here for a reminder of SureChEMBL is and what it does.  This wealth of (big) data can be accessed via the SureChEMBL interface , where users can submit quite sophisticated and granular queries by combining: i) Lucene fields against full-text and bibliographic metadata and ii) advanced structure query features against the annotated compound corpus. Examples of such queries will be the topic of a future post. Once the search results are back, users can browse through and export the chemistry from the patent(s) of interest. In addition to this functionality, we've been receiving user requests for  local (behind the
Post a Comment
Read more