API Documentation

Dynamic API Endpoints

Query the live database. All endpoints support a ?format= parameter (json, yaml, toon). Default is json.

Response Example

Every response carries the API name, version, format, and the requested payload. This is the shape of GET /api/dataset/sql-join-types:

Copy{
  "api": "YAML JSON TOON Database",
  "version": "1.0.0",
  "format": "json",
  "dataset": {
    "slug": "sql-join-types",
    "title": "SQL Join Types",
    "category": "Database Types",
    "category_slug": "database-types"
  },
  "data": {
    "joins": [
      { "name": "INNER JOIN", "description": "Returns rows where keys match in both tables" }
    ]
  }
}

Static File Endpoints

Pre-generated files for direct access without database queries — ideal for static hosting or CDN caching.

CopyGET /static-data/categories.json
GET /static-data/catalog-index.json
GET /static-data/catalog-index.toon
GET /static-data/category/{slug}.json
GET /static-data/dataset/{slug}.json
GET /static-data/dataset/{slug}.yaml
GET /static-data/dataset/{slug}.toon

Human-Readable Catalog

The same data, rendered as HTML tables for people and for crawlers. One page per dataset, one per category, plus an index. Every page links to its own JSON, YAML, and TOON downloads and carries Dataset structured data.

CopyGET /catalog/
GET /catalog/{category}/
GET /catalog/{category}/{dataset}/

Want to see the encoding difference on your own payload? Paste JSON into TOON Studio — it runs the same encoder as /api/ in the browser, and reports exact byte counts.

Response Format

All API responses include standard headers and follow a consistent structure.

CopyX-RateLimit-Limit: 120
X-RateLimit-Window: 60
Access-Control-Allow-Origin: *

About TOON Format

TOON (Token-Oriented Object Notation) is a compact, token-efficient format optimized for LLM prompts. It reduces token usage by 30–60% compared to JSON by eliminating redundant keys and using positional notation for structured arrays.

JSON is the standard format. YAML is human-readable for configuration files. All three formats contain identical data.

Rate Limits

API requests are rate limited to 120 requests per minute per IP. Exceeding the limit returns HTTP 429 with a Retry-After header.