OralHealth API Documentation

RESTful API for accessing oral health recommendations and evidence.

OralHealth API

RESTful API for accessing oral health recommendations and evidence-based data

v1.0 JSON Rate Limited

Quick Start

All API endpoints return JSON responses. No authentication required for public endpoints.

curl -X GET "oralhealth.xeradb.com/api/recommendations/?q=fluoride&limit=5"

Recommendations

Endpoint: /api/recommendations/

Search and filter oral health recommendations.

Parameters:
  • q - Search query
  • country - Country code (๐Ÿ‡ฌ๐Ÿ‡ง UK, ๐Ÿ‡บ๐Ÿ‡ธ US, ๐Ÿ‡จ๐Ÿ‡ฆ CA, ๐Ÿ‡ฆ๐Ÿ‡บ AU, ๐Ÿ‡ณ๐Ÿ‡ฟ NZ)
  • topic - Topic ID
  • strength - Recommendation strength ID
  • evidence_quality - Evidence quality ID
  • page - Page number (default: 1)
  • limit - Results per page (max: 100)

Guidelines

Endpoint: /api/guidelines/

Access clinical practice guidelines.

Parameters:
  • q - Search query
  • country - Country code (๐Ÿ‡ฌ๐Ÿ‡ง UK, ๐Ÿ‡บ๐Ÿ‡ธ US, ๐Ÿ‡จ๐Ÿ‡ฆ CA, ๐Ÿ‡ฆ๐Ÿ‡บ AU, ๐Ÿ‡ณ๐Ÿ‡ฟ NZ)
  • page - Page number (default: 1)
  • limit - Results per page (max: 100)

Cochrane Reviews

Endpoint: /api/cochrane/

Access Cochrane systematic reviews data.

Parameters:
  • q - Search query
  • page - Page number (default: 1)
  • limit - Results per page (max: 100)

Statistics

Endpoint: /api/stats/

Get database statistics and counts.

Returns:
  • Total recommendations by country ๐ŸŒ
  • Guidelines by country ๐ŸŒ
  • Cochrane review counts
  • Topic distributions

Response Format

All API responses follow this consistent format:

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_pages": 5,
    "total_results": 95,
    "has_next": true,
    "has_previous": false
  },
  "filters_applied": {
    "query": "fluoride",
    "country": "๐Ÿ‡ฌ๐Ÿ‡ง UK"
  }
}

Rate Limits

  • No authentication required for public endpoints
  • Caching: Responses cached for 15-30 minutes
  • Pagination: Maximum 100 results per request
  • Fair use: Please don't abuse the API

Examples

Search fluoride recommendations:
/api/recommendations/?q=fluoride&country=UK ๐Ÿ‡ฌ๐Ÿ‡ง
Get UK guidelines:
/api/guidelines/?country=UK ๐Ÿ‡ฌ๐Ÿ‡ง
Paginated results:
/api/recommendations/?page=2&limit=50
Get database stats:
/api/stats/

API Tester

oralhealth.xeradb.com