API Documentation - TumorHope

API Support & Documentation

Welcome to the documentation for TumorHope's REST API feature. This page guides you through how to use the API interface available on the website to fetch tumor homing peptide data.

1. Overview

The TumorHope API allows users to query the database based on Target Cell Type or Source. Users can generate URLs, CURL, or Wget commands to access data directly from the backend.

API Main Page Screenshot

2. Interface Walkthrough

A. Select Field

Select either Target Cell or Source as your search field using the dropdown menu.

API Main Page Screenshot

B. Select Value

Based on the selected field, a list of values will be populated. Choose one to proceed. For eg. if the selected field is Source, then the following values will be listed:

API Main Page Screenshot

C. Fetch Data

Click on the Fetch button to generate the API URL and view CURL or Wget commands.

3. API Response

After fetching, data will be retrieved in JSON format. You can toggle the visibility of the JSON output using the "Show JSON" switch.

Example JSON


            {
                "status": "success",
                "message": "Data retrieved successfully",
                "count": 1,
                "results": [
                    {
                    "id": 2867,
                    "title": "A brain tumor-homing tetra-peptide delivers a nano-therapeutic for more effective treatment of a mouse model of glioblastoma",
                    "pmid": "32510090",
                    "year": "2020",
                    "source": "A33H",
                    "name_source": "NA",
                    "sequence": "SIWV",
                    "n_term": "Fluorescein isothiocyanate (FITC)",
                    "c_term": "Biotin",
                    "motif": "NA",
                    "target_tumor": "Brain tumor",
                    "target_cell": "NA",
                    "receptors_biomarker": "NA",
                    "phage_display": "NA",
                    "invitro": "Human-derived brain carcinoma cells (U87MG cells), lung carcinoma cells (A549 cells), liver carcinoma cells (Huh7 cells)",
                    "invivo": "5- or 6-week-old female BALB/c nu/nu mice, 7-week-old ICR mice",
                    "homing": "Homing, Penetrating",
                    "conjugate": "Fluorescein isothiocyanate (FITC)",
                    "patent": "Patent pending",
                    "refrence": "Kang R H et al. Nanoscale Horiz.2020 Jul 27;5(8):1213-1225",
                    "comments": "Cell penetrating peptide"
                    }
                ]
            }
            

4. API URL Formats

Once you've selected a field and value, the interface generates three types of links. For eg. if the Field is Source and the Value is A33H, then the following links will be generated:

  • Direct URL: https://webs.iiitd.edu.in/raghava/tumorhope2/restapi/api.php?source=A33H
  • CURL Command: curl -X GET "https://webs.iiitd.edu.in/raghava/tumorhope2/restapi/api.php?source=A33H"
  • Wget Command: wget -O output.json "https://webs.iiitd.edu.in/raghava/tumorhope2/restapi/api.php?source=A33H"