Professional by default
Clear navigation, accessible typography, and mobile-first layout. No clutter.
cBioPortal-compatible • REST • reproducible workflows
Programmatic access, delivered with a clean, professional interface.
cbioapi.pharmacodb.ca is a landing page for a cBioPortal-compatible REST API. Use it to integrate analytics, build dashboards, or run reproducible pipelines. (cBioPortal provides a REST API and OpenAPI-based tooling for client generation.)
Tip: replace the placeholders below with your real base path and OpenAPI URL once available.
Overview
A concise entry point for developers and researchers: what the API is, how to use it, and where to find docs/spec. Keep it simple, fast to scan, and trustworthy.
Built for reproducibility
Copy-paste cURL snippets and stable endpoints for scripts and pipelines.
Interoperable
Compatible approach inspired by cBioPortal REST conventions and tooling.
Have an OpenAPI spec?
Link it here so users can generate clients (Python/R/JS) and explore the API via Swagger UI.
Quickstart
These examples are safe defaults for an API landing page. Replace BASE with your actual base path.
# Set your base URL
BASE="https://cbioapi.pharmacodb.ca"
# Health check (recommended endpoint)
curl -s "$BASE/health" | jq .
# List studies (example cBioPortal-style resource)
curl -s "$BASE/api/studies" | jq .
# Query a single study (example)
curl -s "$BASE/api/studies/{studyId}" | jq .
Note: If your deployment uses a different base path (e.g. /api/v1), update the snippets accordingly.
Endpoints (suggested structure)
Keep endpoint lists short on the landing page—link to the full reference in OpenAPI/Docs.
Core
GET /healthGET /versionGET /status
Studies
GET /api/studiesGET /api/studies/{id}
Samples & Molecular
GET /api/samplesGET /api/mutationsGET /api/cna
# If you expose OpenAPI: # - Provide: /openapi.json (or /api-docs) # - Optional: Swagger UI at /docs # Users can generate clients (Python/R/JS) from the OpenAPI spec.
FAQ
Short answers. No ambiguity.
Is this an official cBioPortal API?
This landing page describes a cBioPortal-compatible REST interface. For official cBioPortal API references and clients, consult the cBioPortal documentation.
Where is the OpenAPI / Swagger spec?
If you publish one (recommended), link it from this page (e.g. /openapi.json or /api-docs) and optionally host Swagger UI at /docs.
Do you require authentication or have rate limits?
Add a short policy section here: authentication method (none/API key/OAuth), rate limits, and contact for access.
Contact
Add a single, professional contact channel for API issues, access requests, and support.
Support
Email: support@pharmacodb.ca (replace as needed)
Status: /status
Disclaimer: This page is informational and does not provide medical advice.