Developer Documentation

Comprehensive board game reference for tabletop enthusiasts, game designers, and collectors. Covers board games with mechanics, categories, designers, artists, publishers, awards, progression paths, game night themes, playbooks with strategy tips, interactive tools, glossary, and in-depth guides. 15 languages supported.

Quick Start

curl -s "https://boardgamefyi.com/api/v1/games/"

API Endpoints

Method Endpoint Description
GET /api/v1/games/ All board games
GET /api/v1/games/{slug}/ Game detail
GET /api/v1/mechanics/ Game mechanics
GET /api/v1/categories/ Game categories
GET /api/v1/designers/ Game designers
GET /api/v1/artists/ Game artists
GET /api/v1/publishers/ Game publishers
GET /api/v1/awards/ Board game awards
GET /api/v1/progression-paths/ Progression paths
GET /api/v1/game-night-themes/ Game night themes
GET /api/v1/glossary/ Glossary terms
GET /api/v1/guide-series/ Guide series
GET /api/v1/guides/ Guide articles
GET /api/v1/tools/ Interactive tools
GET /api/v1/faqs/ FAQs
GET /api/v1/stats/ Site statistics

URL Patterns

Use these patterns to construct URLs programmatically:

/games/ Browse all board games (e.g. /games/)
/game/{slug}/ Game detail (e.g. /game/catan/)
/mechanics/ Game mechanics (e.g. /mechanics/)
/mechanic/{slug}/ Mechanic detail (e.g. /mechanic/worker-placement/)
/categories/ Game categories (e.g. /categories/)
/category/{slug}/ Category detail (e.g. /category/strategy/)
/designers/ Game designers (e.g. /designers/)
/designer/{slug}/ Designer detail (e.g. /designer/uwe-rosenberg/)
/artists/ Game artists (e.g. /artists/)
/artist/{slug}/ Artist detail (e.g. /artist/vincent-dutrait/)
/publishers/ Game publishers (e.g. /publishers/)
/publisher/{slug}/ Publisher detail (e.g. /publisher/stonemaier-games/)
/awards/ Board game awards (e.g. /awards/)
/award/{slug}/ Award detail (e.g. /award/spiel-des-jahres/)
/compare/ Game comparisons (e.g. /compare/)
/compare/{slug1}-vs-{slug2}/ Side-by-side comparison (e.g. /compare/catan-vs-ticket-to-ride/)
/paths/ Progression paths (e.g. /paths/)
/paths/{slug}/ Progression path detail (e.g. /paths/euro-games/)
/nights/ Game night themes (e.g. /nights/)
/nights/{slug}/ Game night detail (e.g. /nights/family-game-night/)
/playbook/{slug}/ Game playbook (e.g. /playbook/catan/)
/terms/ Board game glossary (e.g. /terms/)
/terms/{slug}/ Glossary term detail (e.g. /terms/meeple/)
/guides/ In-depth guides (e.g. /guides/)
/guides/{slug}/ Guide detail (e.g. /guides/beginners-guide/)
/tools/ Interactive tools (e.g. /tools/)
/tools/game-finder/ Game finder (e.g. /tools/game-finder/)
/tools/board-game-quiz/ Board game quiz (e.g. /tools/board-game-quiz/)
/search/ Search games, mechanics, terms (e.g. /search/?q=catan)

Response Format

All endpoints return JSON with pagination:

Example JSON response
{
  "count": 636,
  "next": "https://example.com/api/v1/items/?page=2",
  "previous": null,
  "results": [
    {"slug": "example", "name": "Example Item", "...": "..."}
  ]
}

OpenAPI Specification

Full API schema available as OpenAPI 3.1.0 JSON. Import into Swagger UI, Postman, or any OpenAPI-compatible tool.

SDK Packages

PyPI
pip install boardgamefyi

Board games, rules and reviews API client

Embed Widget

Embed data cards on your site: https://widget.boardgamefyi.com
npm install boardgamefyi-embed

Format Support

  • Markdown endpoints: Append .md to any page URL for LLM-friendly markdown output.
  • Internationalization: Content available in 14 languages: ko, ja, zh-hans, es, fr, de, pt, ru, vi, tr, ar, hi, th, id.