CoCDB

RESTful API serving Clash of Clans game data, built with Go and chi.

Prerequisites

• Go 1.25 or higher
• Git

Quick Start

# Clone the repository
git clone https://github.com/flapjacck/CoCDB.git
cd CoCDB

# Install dependencies
go mod download

# Run the server
go run .

The API starts on http://localhost:3000

API Endpoints

General

Method	Path	Description
GET	/	API information and available routes
GET	/health	Health check with uptime info
GET	/favicon.ico	Favicon (place file in static/)

Buildings — /api/{base}/buildings

Method	Path	Description
GET	/api/{base}/buildings	List all building categories
GET	/api/{base}/buildings/{category}	List buildings in a category
GET	/api/{base}/buildings/{category}/{name}	Get a specific building's data

Bases: home_village, builder_base

Categories: army, defensive, resource, traps

Examples:

curl http://localhost:3000/api/home_village/buildings
curl http://localhost:3000/api/home_village/buildings/defensive
curl http://localhost:3000/api/home_village/buildings/defensive/cannon
curl http://localhost:3000/api/builder_base/buildings

Troops — /api/{base}/troops

Method	Path	Description
GET	/api/{base}/troops	List all troop categories
GET	/api/{base}/troops/{category}	List troops in a category
GET	/api/{base}/troops/{category}/{name}	Get a specific troop's data

Bases: home_village, builder_base

Categories: elixir, dark_elixir, super

Examples:

curl http://localhost:3000/api/home_village/troops
curl http://localhost:3000/api/home_village/troops/elixir
curl http://localhost:3000/api/builder_base/troops

Configuration

All settings are controlled via environment variables. Copy .env.example to .env for reference.

Variable	Default	Description
PORT	3000	Server listen port
ENVIRONMENT	development	development or production
LOG_LEVEL	info	debug, info, warn, error
DATA_DIR	data	Path to the JSON data directory
CACHE_TTL	5m	Cache time-to-live (Go duration)
CORS_ORIGINS	*	Comma-separated allowed CORS origins
READ_TIMEOUT	10s	HTTP read timeout
WRITE_TIMEOUT	10s	HTTP write timeout
IDLE_TIMEOUT	120s	HTTP idle timeout

Attribution & Licensing

We use material from the Clash of Clans Wiki at Fandom to make this database. Please see their licensing terms below:

Community content on Fandom is available under the Creative Commons Attribution-ShareAlike license (CC BY‑SA) unless otherwise noted. See: https://clashofclans.fandom.com/wiki/Clash_of_Clans_Wiki

Some images or other media may have separate licenses; always check the media page on Fandom before reuse.

All JSON files include a source, source_url, and source_license field pointing to the original wiki article and license.