Developer Documentation
Comprehensive symbol and special character reference for developers and designers. 4,947 symbols with Unicode data, encoding in 11 formats (UTF-8, UTF-16, HTML entity, CSS, URL-encoded, etc.), 30 categories, 25 curated collections, 84 glossary terms, 75 guides across 8 series, and 9 interactive tools.
- 4,947 symbols with full Unicode metadata (codepoint, name, block, script, general category)
- 11 encoding formats per symbol: UTF-8, UTF-16 BE/LE, UTF-32, HTML decimal/hex entity, CSS, URL-encoded, JSON, XML
- 30 symbol categories (mathematical, arrows, currency, punctuation, dingbats, etc.)
- 25 curated symbol collections (e.g., math operators, card suits, zodiac, chess)
- Unicode block and super-block browser (118+ blocks grouped into 20 super-blocks)
- 84 glossary terms covering Unicode encoding, typography, and character standards
- 75 guides across 8 series (Unicode fundamentals, typography, encoding, etc.)
- 9 interactive tools: search, text symbols, unicode lookup, character counter, symbol table, encoding converter, text diff, string length, HTML entity search
- Use case pages for common symbol needs (e.g., symbols for math, currency, music)
- N² symbol comparison pages (side-by-side encoding, properties, usage)
Quick Start
curl -s "https://symbolfyi.com/api/v1/symbols/black-heart-suit/"
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/symbols/ | List all symbols (DRF, paginated) |
| GET | /api/v1/symbols/{slug}/ | Symbol detail with 11 encodings |
| GET | /api/v1/categories/ | List symbol categories |
| GET | /api/v1/categories/{slug}/ | Category detail |
| GET | /api/v1/collections/ | List symbol collections |
| GET | /api/v1/collections/{slug}/ | Collection detail |
| 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/guides/ | Guide articles (DRF, paginated) |
| GET | /api/v1/guides/{slug}/ | Guide detail |
| GET | /api/v1/guide-categories/ | Guide categories |
| GET | /api/v1/guide-series/ | Guide series |
| GET | /api/v1/tools/ | Interactive tools (DRF, paginated) |
| GET | /api/v1/search/?q={query} | Search symbols by name or codepoint |
| GET | /api/v1/stats/ | Site statistics |
URL Patterns
Use these patterns to construct URLs programmatically:
/symbol/{slug}/
Symbol detail with 11 encodings and Unicode properties (e.g. /symbol/black-heart-suit/)
/char/U+{codepoint}/
Character by Unicode codepoint (e.g. /char/U+2665/)
/category/
Browse all 30 symbol categories (e.g. /category/)
/category/{slug}/
Category detail with symbols (e.g. /category/math/)
/collection/
Browse 25 curated collections (e.g. /collection/)
/collection/{slug}/
Collection detail (e.g. /collection/zodiac-signs/)
/block/
Unicode blocks browser (e.g. /block/)
/block/{slug}/
Block detail with characters (e.g. /block/arrows/)
/browse/
Super-block browser (grouped blocks) (e.g. /browse/)
/browse/{slug}/
Super-block detail (e.g. /browse/symbols-and-punctuation/)
/symbols-for/
Use case index (symbols for specific needs) (e.g. /symbols-for/)
/symbols-for/{slug}/
Use case detail (e.g. /symbols-for/math/)
/glossary/
Symbol and Unicode glossary (84 terms) (e.g. /glossary/)
/glossary/{slug}/
Glossary term definition (e.g. /glossary/utf-8/)
/guides/
All guides (75 articles) (e.g. /guides/)
/guides/series/
Guide series (8 series) (e.g. /guides/series/)
/guides/series/{slug}/
Guide series detail (e.g. /guides/series/unicode-fundamentals/)
/guides/{slug}/
Guide detail (e.g. /guides/unicode-introduction/)
/tools/
Interactive tools index (9 tools) (e.g. /tools/)
/tools/{slug}/
Tool page (e.g. /tools/encoding-converter/)
/compare/
Symbol comparison index (e.g. /compare/)
/compare/{slug1}-vs-{slug2}/
Compare two symbols (e.g. /compare/em-dash-vs-en-dash/)
/search/
Search symbols by name, codepoint, or keyword (e.g. /search/?q=arrow)
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 symbolfyi
Symbol encoding in 11 formats (v0.2.2)
npm
npm install symbolfyi
TypeScript symbol utilities (v0.1.2)
Embed Widget
Embed data cards on your site:
https://widget.symbolfyi.com
npm install symbolfyi-embed
Format Support
- Markdown endpoints: Append
.mdto 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.