Developer Documentation

Comprehensive color reference for developers and designers. 16.7M hex colors computed on-the-fly, 809 named colors (CSS, X11, Crayola, Pantone, RAL, NCS), 544 brand color palettes, 103 color theory glossary terms, 215 blog articles, and 6 interactive tools (WCAG contrast, converter, palette generator, shade generator, color blindness simulator, gradient generator).

Quick Start

curl -s "https://colorfyi.com/api/color/FF6B35/"

API Endpoints

Method Endpoint Description
GET /api/color/{hex}/ Full color info (RGB, HSL, HSV, CMYK, OKLCH, harmonies, shades)
GET /api/contrast/?fg={hex}&bg={hex} WCAG contrast ratio + AA/AAA compliance
GET /api/search/?q={query} Search named colors and brands
GET /api/harmonies/{hex}/ Color harmonies (complementary, triadic, etc.)
GET /api/shades/{hex}/ Tailwind-style shade scale (50-950)
GET /api/blindness/{hex}/ Color blindness simulation
GET /api/compare/?colors={hex1},{hex2} Compare multiple colors
GET /api/mix/?colors={hex1},{hex2} Mix colors
GET /api/gradient/?from={hex}&to={hex} Generate gradient steps
GET /api/palette/{hex}/ Palette suggestions for a color
GET /api/named-colors/ List all named colors
GET /api/graph/ Knowledge graph nodes and edges
GET /api/v1/colors/ Named colors (DRF, paginated)
GET /api/v1/brands/ Brands (DRF, paginated)
GET /api/v1/posts/ Blog posts (DRF, paginated)
GET /api/v1/glossary/ Glossary terms (DRF, paginated)
GET /api/v1/collections/ Collections (DRF, paginated)
GET /api/v1/tools/ Interactive tools (DRF, paginated)
GET /api/v1/faqs/ FAQs (DRF, paginated)
GET /api/v1/search/?q={query} Unified search (DRF)
GET /api/v1/stats/ Site statistics

URL Patterns

Use these patterns to construct URLs programmatically:

/color/{hex}/ Color detail page for any 6-digit hex (e.g. /color/FF6B35/)
/color/{slug}/ Named color by slug (e.g. /color/tiffany-blue/)
/color/named/ Browse all 809 named colors with source filter (e.g. /color/named/)
/color/rgb-{R}-{G}-{B}/ RGB redirect to hex detail (e.g. /color/rgb-14-165-233/)
/color/hsl-{H}-{S}-{L}/ HSL redirect to hex detail (e.g. /color/hsl-199-89-48/)
/family/ Color families (red, blue, green, ...) (e.g. /family/)
/family/{slug}/ Color family detail (e.g. /family/red/)
/tone/ Color tones (pastel, neon, earth, ...) (e.g. /tone/)
/tone/{slug}/ Color tone detail (e.g. /tone/pastel/)
/design-system/ Design system color palettes (e.g. /design-system/)
/design-system/{slug}/ Design system detail (e.g. /design-system/tailwind-css/)
/meaning/ Color meanings and symbolism (e.g. /meaning/)
/meaning/{slug}/ Color meaning detail (e.g. /meaning/passion/)
/brands/ Brand color palettes grouped by category (e.g. /brands/)
/brands/{slug}/ Brand color palette detail (e.g. /brands/google/)
/brands/category/{cat}/ Brand category page (e.g. /brands/category/tech/)
/collections/ Themed color collections (e.g. /collections/)
/collections/{slug}/ Collection detail (e.g. /collections/korean-obangsaek/)
/collections/category/{cat}/ Collection category page (e.g. /collections/category/cultural/)
/glossary/ Color name glossary index (e.g. /glossary/)
/glossary/{slug}/ Color name: etymology, history, usage (e.g. /glossary/cerulean/)
/glossary/terms/{slug}/ Color theory term definition (e.g. /glossary/terms/hue/)
/palettes/ Curated color palettes (e.g. /palettes/)
/palettes/{slug}/ Palette detail (e.g. /palettes/sunset-warmth/)
/blog/ Color articles and guides (e.g. /blog/)
/blog/{slug}/ Blog article (e.g. /blog/korean-obangsaek/)
/blog/category/{slug}/ Blog category (e.g. /blog/category/color-theory/)
/tools/ Interactive color tools index (e.g. /tools/)
/tools/{slug}/ Tool page (e.g. /tools/contrast-checker/)
/compare/ Color comparison tool (e.g. /compare/)
/compare/{hex1}-vs-{hex2}/ Compare two colors (e.g. /compare/000000-vs-FFFFFF/)
/compare/{hex1}-vs-{hex2}-vs-{hex3}/ Compare three colors (e.g. /compare/FF0000-vs-00FF00-vs-0000FF/)
/graph/ Interactive color knowledge graph (e.g. /graph/)
/search/ Search named colors, brands, collections (e.g. /search/?q=blue)

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 colorfyi

Color conversion, WCAG contrast, harmonies (v0.2.2)

npm
npm install @fyipedia/colorfyi

TypeScript color utilities (v0.1.2)

Embed Widget

Embed data cards on your site: https://widget.colorfyi.com
npm install colorfyi-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.