Interactions - API endpoints
This section provides a comprehensive list of all endpoints related to obtaining available information about passive and active interactions (details in What is stored in MolMeDB?) stored in MolMeDB.
How to read an endpoint definition?
| Method | Describes which HTTP method must be used while calling the given endpoint. |
| Pattern |
Specifies the suffix of the URL determining API endpoint. A final URL is created by combining the server address prefix https://molmedb.upol.cz/api with the corresponding pattern. For example, endpoint with a pattern /compounds/detail/<id><?get_parameters> is called at address https://molmedb.upol.cz/api/compounds/detail/<id><?get_parameters>. |
| Parameters | Describes possible parameters which can be used for query specification. All parameters can be inserted as GET_parameters, but some may be inserted as part of the URL (e.g. parameter id in the previous example). For both options, see the example in Compounds - detail endpoint definition below. |
| Output formats | Describes possible output formats of the data returned from the server. |
Passive interactions
Tip!
One can be interested in downloading all passive interactions. This dataset is regularly updated and is available here - https://molmedb.upol.cz/api/interactions/passive/all.
Search for interactions
This endpoint returns publicly accessible molecule passive interactions. A user can set a specific membrane, method, reference (publication), or combination to filter output results. At this moment, data can be returned as JSON formatted array or HTML table.
Warning, data may be incomplete.
The HTML table is limited to only 1,000 records (rows) due to the amount of data and web browser limits. Please, use JSON format to obtain a complete list.
| Method | GET |
| Pattern | /interactions/passive/<?id><?membrane><?method><?reference> |
| Parameters |
Sets the parameter to search by. id [string, array] (optional) - This parameter can have one of the following values: - MolMeDB identifier of a molecule., - Pubchem identifier, - Drugbank identifier, - ChEMBL identifier, - PDB identifier, - SMILES, - InChIKey, - Molecule name. Warning! This parameter can be ambiguous. membrane [int, string] - Unique database ID specifying required membrane interactions to return. For all options, see the endpoint Membranes - list. - Membrane name or category path (for more info, see Membranes - categories). method [int, string] - Unique database ID specifying required method interactions to return. For all options, see the endpoint Methods - list. - Method name or category path (for more info, see Methods - categories). reference [string] - DOI or Pubmed ID of an article. |
| Output formats |
JSON (default) HTML |
Get the total number of records
This endpoint is copy-paste record of the previous endpoint just with a small changes in Pattern and output formats.
| Method | GET |
| Pattern | /interactions/passive/total/<?id><?membrane><?method><?reference> |
| Parameters |
Sets the parameter to search by. id [string, array] (optional) - This parameter can have one of the following values: - MolMeDB identifier of a molecule., - Pubchem identifier, - Drugbank identifier, - ChEMBL identifier, - PDB identifier, - SMILES, - InChIKey, - Molecule name. Warning! This parameter can be ambiguous. membrane [int] - Unique database ID specifying required membrane interactions to return. For all options, see the endpoint Membranes - list. method [int] - Unique database ID specifying required method interactions to return. For all options, see the endpoint Methods - list. reference [string] - DOI or Pubmed ID of an article. |
| Output formats | JSON (default) |
Active (transporter) interactions
Tip!
One can be interested in downloading all active interactions. This dataset is regularly updated and is available here - https://molmedb.upol.cz/api/interactions/active/all.
Search for interactions
This endpoint returns publicly accessible active (transporter) molecule interactions. A user can specify a molecular target to filter the output results. At this moment, data can be returned as JSON formatted array or HTML table.
| Method | GET |
| Pattern | /interactions/active/<?id><?target><?reference> |
| Parameters |
Sets the parameter to search by. id [string, array] (optional) - This parameter can have one of the following values: - MolMeDB identifier of a molecule., - Pubchem identifier, - Drugbank identifier, - ChEMBL identifier, - PDB identifier, - SMILES, - InChIKey, - Molecule name. Warning! This parameter can be ambiguous. target [string] - Uniprot ID or name of the target. reference [string] - DOI or Pubmed ID of an article. |
| Return types |
JSON (default) HTML |
Get the total number of records
This endpoint is copy-paste record of the previous endpoint just with a small changes in Pattern and output formats.
| Method | GET |
| Pattern | /interactions/total/active/<?id><?target><?reference> |
| Parameters |
Sets the parameter to search by. id [string, array] (optional) - This parameter can have one of the following values: - MolMeDB identifier of a molecule., - Pubchem identifier, - Drugbank identifier, - ChEMBL identifier, - PDB identifier, - SMILES, - InChIKey, - Molecule name. Warning! This parameter can be ambiguous. target [string] - Uniprot ID or name of the target. reference [string] - DOI or Pubmed ID of an article. |
| Output formats | JSON (default) |