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)
- searching for 'aspirin' in molecules:
api/data/molecule/search.json?q=aspirin - searching for 'lipoxygenase' in targets:
api/data/target/search.json?q=lipoxygenase - searching for 'inhibitor' in assays:
api/data/assay/search?q=inhibitor
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.
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