API Documentation

Access guidelines programmatically. All endpoints return JSON and are publicly accessible.

Overview

Base URL: https://erold.guide/api/v1
Format: JSON (UTF-8)
Authentication: None required (public API)
Rate Limiting: None (please be reasonable)

Quick Start

# Fetch all frameworks
curl https://erold.guide/api/v1/frameworks/index.json

# Fetch Next.js guidelines
curl https://erold.guide/api/v1/frameworks/nextjs/index.json

# Fetch a specific guideline
curl https://erold.guide/api/v1/guidelines/nextjs/app-router/server-components-default.json

Endpoints

GET /api/v1/manifest.json

Complete manifest of all guidelines, frameworks, and metadata

Example response

{
  "version": "1.0.0",
  "generatedAt": "2025-01-01T00:00:00Z",
  "frameworks": [...],
  "technologies": [...],
  "tags": [...],
  "stats": { "totalGuidelines": 150, ... }
}

GET /api/v1/frameworks/index.json

List of all frameworks with metadata

Example response

[
  {
    "id": "nextjs",
    "name": "Next.js",
    "slug": "nextjs",
    "description": "...",
    "guidelinesCount": 24
  }
]

GET /api/v1/frameworks/{slug}/index.json

All guidelines for a specific framework

Example response

{
  "framework": { "id": "nextjs", "name": "Next.js", ... },
  "guidelines": [
    { "title": "...", "slug": "...", "category": "..." }
  ]
}

GET /api/v1/guidelines/{framework}/{category}/{slug}.json

Full guideline content including markdown

Example response

{
  "title": "Default to Server Components",
  "framework": "nextjs",
  "category": "app-router",
  "content": "# Markdown content...",
  "tags": ["performance", "ssr"]
}

GET /api/v1/tags/index.json

List of all tags with usage counts

Example response

[
  { "name": "performance", "count": 45 },
  { "name": "security", "count": 38 }
]

GET /api/v1/technologies/index.json

List of all technologies

Example response

[
  {
    "id": "typescript",
    "name": "TypeScript",
    "slug": "typescript"
  }
]

Use Cases

AI Agents

Fetch guidelines to inform code generation and review. Pre-indexed URLs enable zero-latency lookups.

IDE Extensions

Build extensions that show relevant guidelines while developers code.

CI/CD Pipelines

Validate code against guidelines in automated pipelines.

Documentation Sites

Embed guidelines in your own documentation or wikis.