REST API

The Open Targets Platform REST API allows language agnostic access to data available on the Open Targets Platform. The REST API can be accessed from the following URL

https://platform-api.opentargets.io/v3/platform

The current set of REST API endpoints can be divided in three groups:

  • Public - Methods that serve the core set of our data e.g. associations and evidence. These methods are stable and unlikely to change.

  • Private - Methods that serve other data in the Open Targets Platform, such as the target profile page and batch search. These methods may not be stable from one release to the next. You should use these at your own risk.

  • Utils - Methods to get statistics on our data and to check if the server is alive.

Head to our Swagger interface for a list of all available endpoints. You will also be able to test your queries in an interactive and easy manner.

To get the summary statistics of our latest release, for example, you will use the following URL:

https://platform-api.opentargets.io/v3/platform/public/utils/stats

This utils/stats endpoint will return the total number of targets and diseases, and the total numbers of associations and evidence strings per data source and data type.

The three methods listed above (Public, Private and Utils) are available via a GET request, and by default will return the outputs in JSON.

Alternative output formats, such xml, csv and tab, are also available for some of the methods e.g. /association/filter and /search.

For complex queries with large numbers of parameters, use a POST request instead of GET. POST methods require a body encoded as json.

You can use the following tools with the Open Targets Platform REST API endpoints:

  • Command line (e.g. CURL or HTTPie)

  • Your own application and/or workflow

  • Open Targets Python client

You can also access the Open Targets Platform REST-API with scripts in R.

Check our webinar Take a rest of manual searches with the Open Targets API for an overview of the REST API and examples on some of the API queries that serve the Open Targets Platform user interface.

Please note that at the time of the recording (Dec 5th 2017), the Open Targets REST API had a different URL, no longer in use. You should now use:

https://platform-api.opentargets.io/v3/platform

Check the API tutorials page for the most up-to-date use case examples or head to the Open Targets Blog for Open Targets API Tutorial: Getting Started and Get an association table for your list of genes tutorials.

Please note if you want to try out the tutorials available in the blog, you should amend the URL listed in there to the following:

https://platform-api.opentargets.io/v3/platform/

If you have questions on the Open Targets Platform REST API or need further help, please email us.