API Documentation

TTEdb API Documentation - Access TTE studies, Bayesian meta-analysis results, and research data programmatically through our comprehensive REST API.

TTEdb API

Comprehensive REST API for accessing TTE studies, Bayesian meta-analysis results, and research data

API Overview

Base URL
https://ttedb.xeradb.com/api/
Response Format

All API responses are in JSON format with appropriate HTTP status codes.

Authentication

Currently, all endpoints are public and require no authentication.

Rate Limiting

No rate limiting currently applied, but please be respectful with your requests.

CORS

Cross-origin requests are supported for web applications.

Versioning

Current API version: v1 (no versioning prefix required)

Core Data Endpoints

Endpoint Method Description Parameters Try It
/api/studies/ GET List all TTE studies with filtering and search year, disease_category, data_type, search Try
/api/studies/{slug}/ GET Get detailed information about a specific study - Browse
/api/pico-comparisons/ GET List all PICO comparisons with filtering effect_measure, outcome_type, search Try
/api/learning-resources/ GET List all learning resources resource_type, difficulty_level Try
/api/statistics/overview/ GET Get database statistics and overview - Try
/api/search/ GET Global search across all data types q (query string) Try

Bayesian Meta-Analysis Endpoints NEW

These endpoints provide access to comprehensive Bayesian hierarchical meta-analysis results, including pooled estimates, credible intervals, and heterogeneity measures.
Endpoint Method Description Parameters Try It
/api/analysis/overview/ GET Overview of all available Bayesian analysis results - Try
/api/analysis/export-summary/ GET Summary of the latest analysis export - Try
/api/analysis/meta-analysis/ GET Bayesian meta-analysis results for all effect measures - Try
/api/analysis/descriptive/ GET Comprehensive descriptive statistics of the dataset - Try
/api/analysis/subgroup/ GET Subgroup analysis results by disease and data source - Try
/api/analysis/forest-plot-data/ GET Individual study data points for forest plots effect_measure (optional filter) Try

Example Usage

JavaScript (Fetch API)
// Get all studies from 2023
fetch('/api/studies/?year=2023')
  .then(response => response.json())
  .then(data => console.log(data));

// Get Bayesian meta-analysis results
fetch('/api/analysis/meta-analysis/')
  .then(response => response.json())
  .then(data => {
    console.log('HR pooled estimate:', 
      data.HR.pooled_estimate);
  });
Python (requests)
import requests

# Get database statistics
response = requests.get(
  'https://ttedb.xeradb.com/api/statistics/overview/'
)
stats = response.json()

# Get forest plot data for HR
response = requests.get(
  'https://ttedb.xeradb.com/api/analysis/forest-plot-data/?effect_measure=HR'
)
forest_data = response.json()

Response Schemas

Meta-Analysis Result Schema
{
  "MD": {
    "n_studies": 15,
    "pooled_estimate": 0.004,
    "ci_lower": -0.666,
    "ci_upper": 0.533,
    "tau_squared": 0.562,
    "tau": 0.75,
    "method": "Bayesian hierarchical model",
    "estimation": "CmdStanR"
  },
  "HR": { ... },
  "RR": { ... }
}
Study Schema
{
  "id": 1,
  "slug": "study-name-2023",
  "first_author": "Author Name",
  "year": 2023,
  "disease": "Disease Name",
  "disease_category": "Category",
  "data_type": "Claims",
  "institution_type": "Academic",
  "target_trial_name": "Trial Name",
  "created_at": "2024-01-01T00:00:00Z"
}

API Status

Live All endpoints operational
Last updated: Loading...

Support

For API support or feature requests: