Developer Documentation

Comprehensive emoji reference for developers and content creators. 3,781 emojis with Unicode data, CLDR names, platform images, shortcodes, and encoding details. 10 categories, 100 subcategories, 67 glossary terms, 137 stories, 10 interactive tools, and platform comparison across Apple, Google, Microsoft, Samsung, Facebook, and Twitter.

Quick Start

curl -s "https://emojifyi.com/api/v1/emojis/grinning-face/"

API Endpoints

Method Endpoint Description
GET /api/v1/emojis/ List all emojis (DRF, paginated)
GET /api/v1/emojis/{slug}/ Emoji detail with platform images and encodings
GET /api/v1/categories/ List emoji categories
GET /api/v1/categories/{slug}/ Category detail with subcategories
GET /api/v1/glossary/ Glossary terms (DRF, paginated)
GET /api/v1/glossary/{slug}/ Glossary term detail
GET /api/v1/faqs/ FAQs (DRF, paginated)
GET /api/v1/stories/ Stories (DRF, paginated)
GET /api/v1/stories/{slug}/ Story detail
GET /api/v1/tools/ Interactive tools (DRF, paginated)
GET /api/v1/search/?q={query} Search emojis by keyword
GET /api/v1/stats/ Site statistics

URL Patterns

Use these patterns to construct URLs programmatically:

/emoji/{slug}/ Emoji detail with platform images, encodings, variants (e.g. /emoji/grinning-face/)
/category/ Browse all 10 emoji categories (e.g. /category/)
/category/{slug}/ Category detail with subcategories and emojis (e.g. /category/smileys-emotion/)
/type/ Browse by emoji type (fully-qualified, component, etc.) (e.g. /type/)
/type/{slug}/ Type detail page (e.g. /type/fully-qualified/)
/year/ Browse emojis by year added (e.g. /year/)
/year/{year}/ Emojis added in a specific year (e.g. /year/2024/)
/versions/ All emoji versions timeline (e.g. /versions/)
/versions/{version}/ Version detail with new emojis (e.g. /versions/16.0/)
/collection/ Themed emoji collections (e.g. /collection/)
/collection/{slug}/ Collection detail (e.g. /collection/food-drink/)
/glossary/ Emoji and Unicode glossary (e.g. /glossary/)
/glossary/{slug}/ Glossary term definition (e.g. /glossary/zwj-sequence/)
/stories/ Emoji stories and articles (e.g. /stories/)
/stories/{slug}/ Story detail (e.g. /stories/evolution-of-emoji/)
/tools/ Interactive emoji tools index (e.g. /tools/)
/tools/compare/ Platform comparison tool (e.g. /tools/compare/)
/tools/quiz/ Emoji quiz game (e.g. /tools/quiz/)
/tools/keyboard/ Emoji keyboard with copy (e.g. /tools/keyboard/)
/tools/text-to-emoji/ Convert text to emoji (e.g. /tools/text-to-emoji/)
/tools/stats/ Emoji statistics dashboard (e.g. /tools/stats/)
/tools/sequence-analyzer/ Analyze emoji sequences and ZWJ (e.g. /tools/sequence-analyzer/)
/tools/translator/ Emoji translator (e.g. /tools/translator/)
/tools/shortcode-finder/ Find shortcodes for emojis (e.g. /tools/shortcode-finder/)
/tools/unicode-lookup/ Unicode codepoint lookup (e.g. /tools/unicode-lookup/)
/tools/collection-builder/ Build custom emoji collections (e.g. /tools/collection-builder/)
/compare/{slug1}-vs-{slug2}/ Compare two emojis side-by-side (e.g. /compare/grinning-face-vs-beaming-face-with-smiling-eyes/)
/search/ Search emojis by keyword, name, or codepoint (e.g. /search/?q=heart)

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 emojifyi

Emoji encoding & metadata for 3,953 emojis (v0.2.2)

npm
npm install emojifyi

TypeScript emoji utilities (v0.1.2)

Embed Widget

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