Download

ID	Type	Descriptions	File	Size	Release

RESTful API in TCMIO

The following lists the TCMIO RESTful API. The returned results are in the JSON format.

1) Prescriptions

Request Type: GET
Example: http://tcmio.xielab.net/prescriptions/1/json
Output: Details of a prescription, including the Chinese name, Pinyin name, indications, effects.

2) TCM

Request Type: GET
Example: http://tcmio.xielab.net/tcms/1/json
Output: Details of a TCM, including Chinese name, Pinyin name, use part, property, flavor, channel tropism, indications, and effects.

3) Ingredients

Request Type: GET
Example: http://tcmio.xielab.net/ingredients/1/json
Output: Details of a ingredient, including name, synonyms, mol, smiles, inchi, and inchikey.

4) Ligands

Request Type: GET
Example: http://tcmio.xielab.net/ligands/1/json
Output: Details of a ligand, including ChEMBL ID, name, molecular weight, formula, mol, smiles, inchi, inchikey, HBA, HBD, RTB, and AlogP.

5) Targets

Request Type: GET
Example: http://tcmio.xielab.net/targets/1/json
Output: Details of a target, including name, gene name, protein family, mass, length, UniProt ID, ChEMBL ID, drugs, KEGG, PDB, functions, and sequence.

6) StructureSearchLigands

Request Type: GET
Parameter: method—structure search methods. Similarity, Substructure, and Fullstructure supported. length—number of results to return. start—offset value for query results. threshold—similarity threshold, only used for similarity search. query—query molecule, mol or smiles
Example: tcmio.xielab.net/structure/ligands?method=Similarity&length=10&start=0&threshold=0.8&query=CC(C)C[C@H](NC(=O)[C@H](Cc1ccc(OP(=O)(O)O)cc1)NC(=O)c2ccc(cc2)C#N)C(=O)O
Output: Details of structure search results against ligands library.

7) StructureSearchIngredients

Request Type: GET
Parameter: method—structure search methods. Similarity, Substructure, and Fullstructure supported. length—number of results to return. start—offset value for query results. threshold—similarity threshold, only used for similarity search. query—query molecule, mol or smiles
Example: tcmio.xielab.net/structure/ingredients?method=Similarity&length=10&start=0&threshold=0.6&query=CC(C)C[C@H](NC(=O)[C@H](Cc1ccc(OP(=O)(O)O)cc1)NC(=O)c2ccc(cc2)C#N)C(=O)O
Output: Details of structure search results against ingredients library.

8) TCMPathway

Request Type: GET
Parameter: kw—key words for query, name of TCM type—name type of TCM, pinyin_name, chinese_name, and english_name supported.
Example: http://tcmio.xielab.net/pathway/tcms?kw=Yi%20Zhi%20Huang%20Hua&type=pinyin_name
Output: Enriched pathways of a TCM.

9) PrescriptionPathway

Request Type: GET
Parameter: kw—key words for query, name of prescription type—name type of prescription, pinyin_name and chinese_name supported.
Example: http://tcmio.xielab.net/pathway/prescriptions?kw=Yi%20Nian%20Jin&type=pinyin_name
Output: Enriched pathways of a Prescription.