Web API manual

All API requests to KampoDB begin with /api/. All responses are in the JSON format. The second field specifies the category, which is either formula for kampo formula, crude for crude drug, compound, or protein. If a request has only two fields, IDs and names of all records in the category are returned.

Most API formats have four fields. The third field is for the ID of a record in the category. The fourth field specifies the output type, which is either info for basic information, formula for related kampo formulas, crude for related crude drugs, compound for related compounds, protein for related proteins, process for enriched/annotated GO biological processes, function for enriched/annotated GO molecular functions, pathway for enriched/annotated KEGG pathways, disease for enriched/annotated KEGG diseases. In addition, lbp for ligand-based prediction and sbp for structure-based prediction can be used for compound and protein categories.

Please see the formats and example requests shown below.

IDs and names

Basic information

    /api/formula/<formula_id>/info test
    /api/crude/<crude_id>/info test
    /api/compound/<compound_id>/info test
    /api/protein/<protein_id>/info test

Relations

    /api/formula/<formula_id>/crude test
    /api/formula/<formula_id>/compound test
    /api/formula/<formula_id>/protein test

    /api/crude/<crude_id>/formula test
    /api/crude/<crude_id>/compound test
    /api/crude/<crude_id>/protein test

    /api/compound/<compound_id>/formula test
    /api/compound/<compound_id>/crude test
    /api/compound/<compound_id>/protein test

    /api/protein/<protein_id>/formula test
    /api/protein/<protein_id>/crude test
    /api/protein/<protein_id>/compound test

Enrichment analysis / annotations

    /api/formula/<formula_id>/process test
    /api/formula/<formula_id>/function test
    /api/formula/<formula_id>/pathway test
    /api/formula/<formula_id>/disease test

    /api/crude/<crude_id>/process test
    /api/crude/<crude_id>/function test
    /api/crude/<crude_id>/pathway test
    /api/crude/<crude_id>/disease test

    /api/compound/<compound_id>/process test
    /api/compound/<compound_id>/function test
    /api/compound/<compound_id>/pathway test
    /api/compound/<compound_id>/disease test

    /api/protein/<protein_id>/process test
    /api/protein/<protein_id>/function test
    /api/protein/<protein_id>/pathway test
    /api/protein/<protein_id>/disease test

Ligand/structure-based predictions

    /api/compound/<compound_id>/lbp test
    /api/compound/<compound_id>/sbp up to 1000 results test
    /api/protein/<protein_id>/lbp test
    /api/protein/<protein_id>/sbp up to 1000 results test

Docking simulation

    /api/docking/compound/<compound_id>/protein/<protein_id> test