Query Syntax

The API processor is located at : https://api.crediblemeds.org/index.php/tools/json . All queries are to be executed via a secure SSL connection.

Queries to the CredibleMeds API are made up of parameters joined by an ampersand &. Each parameter is followed by an equal sign = and an argument.

Searches have a special syntax: search=field:term. Note that there is only one equal sign = and there is a colon : between the field to search, and the term to search for.

Spaces
Queries use the plus sign + in place of the space character. Wherever you would use a space character, use a plus sign instead.

Exact matches
For exact matches, use double quotation marks " " around the words. For example, "multiple+myeloma".

Grouping
To group several terms together, use parentheses ( ). For example, (drug.generic_name:Ritonavir+Escitalopram). Terms separated by plus signs + are treated as in a boolean OR.

To join terms as in a boolean AND, use the +[AND]+. For example, (drug.risk_category:P+C)+AND+drug.class:SSRI results are drugs from TdP risk categories "Possible Risk" or "Conditional Risk" that match drug class keyword – SSRI (for exact match use drug.class:"SSRI" )

Dates and ranges
The CredibleMeds API supports searching by range in date or numeric.

Specify an inclusive range by using (field.term:min+[TO]+max). These include the values in the range. For instance, 2004-01-01+TO+2005-01-01 will search for records between Jan 1, 2004 and Jan 1, 2005.

Query Parameters

Searchable Endpoints

The search functionality for the drugs database information is organised on a two levels structure and for practical uses, the search functionality is limited to the following endpoints:

Search Endpoints: Level 1

Search Endpoints: Level 2

* Depending on your contract, you may not have access to this data-point.

Filter Data Fields

In order to limit result information, the filter query parameter can be used for any of the following data fields:

* Depending on your contract, you may not have access to this data-point.

Result Format

The API returns results as JSON by default.

Example Result

{ 
	"Meta": 
{ 
	"Disclaimer": "The absence of drugs from these lists should not be considered an indication that they are free of risk of QT prolongation or torsades de pointes. Many medicines have not been tested for this risk in patients, especially those with congenital long QT syndrome. All brand names may not be listed.", 
	"Last List Update": "June 15, 2016"
 }
, 
	"Results": [ 

{ 
	"generic_name": "Ritonavir", 
	"link": "http://www.ncbi.nlm.nih.gov/pubmed/?term=ritonavir+AND+(%22QT%22+OR+Torsad*)", 
	"class": "Antiviral", 
	"tdp_risk_category": "C", 
	"brand": "Norvir®", 
	"date_modified": "2014-11-11", 
	"administration_route": "oral", 
	"therapeutic_use": "Viral infection (HIV/AIDS)", 
	"atc_code": "J05AX66"
 }
 ]

 }

https://api.crediblemeds.org/index.php/tools/json?api_key={your_api_key}&search=list:dta&skip=10&limit=20&filter=generic_name+brand

https://api.crediblemeds.org/index.php/tools/json?api_key={your_api_key}&search=drug.risk_category:A+[AND]+drug.therapeutic_use:obesity

https://api.crediblemeds.org/index.php/tools/json?api_key={your_api_key}&search=drug.risk_category:A+drug.therapeutic_use:obesity

If you need further help with the implementation, please connect with us to schedule a meeting.