API Documentation
Free Unicode symbol API. No authentication required. JSON responses.
Base URL
https://symbolfyi.com/api/
GET
Symbol Detail
Get complete information about a symbol including Unicode properties and all encoding representations.
/api/symbol/{slug}/
Parameters
| slug | Symbol slug (e.g. black-heart-suit) |
Example
curl https://symbolfyi.com/api/symbol/black-heart-suit/
{
"character": "♥",
"name": "Black Heart Suit",
"codepoint": "U+2665",
"slug": "black-heart-suit",
"category": "Card Suits",
"block": "Miscellaneous Symbols",
"script": "Common",
"general_category": "So",
"keywords": "heart, love, card, suit",
"encodings": {
"unicode": "U+2665",
"html_decimal": "♥",
"html_hex": "♥",
"html_entity": "♥",
"css": "\\2665",
"javascript": "\\u2665",
"python": "\\u2665",
"java": "\\u2665",
"utf8_bytes": "E2 99 A5",
"utf16_bytes": "26 65",
"url_encoded": "%E2%99%A5"
},
"url": "/symbol/black-heart-suit/"
}
GET
Search Symbols
Search symbols by name, keyword, alias, or HTML entity. Also accepts a single character for exact lookup.
/api/search/?q={query}
Parameters
| q | Search query (name, keyword, or character) |
Example
curl "https://symbolfyi.com/api/search/?q=arrow"
{
"results": [
{"character": "→", "name": "Rightwards Arrow", "slug": "rightwards-arrow", "codepoint": "U+2192", "category": "Arrows", "url": "/symbol/rightwards-arrow/"},
{"character": "←", "name": "Leftwards Arrow", "slug": "leftwards-arrow", "codepoint": "U+2190", "category": "Arrows", "url": "/symbol/leftwards-arrow/"},
{"character": "↑", "name": "Upwards Arrow", "slug": "upwards-arrow", "codepoint": "U+2191", "category": "Arrows", "url": "/symbol/upwards-arrow/"}
]
}
GET
Category Symbols
Get all symbols in a category (max 200).
/api/category/{slug}/
Parameters
| slug | Category slug (e.g. arrows, currency, mathematical) |
Example
curl https://symbolfyi.com/api/category/currency/
{
"category": {"name": "Currency", "slug": "currency", "icon": "$"},
"symbols": [
{"character": "$", "name": "Dollar Sign", "slug": "dollar-sign", "codepoint": "U+0024", "url": "/symbol/dollar-sign/"},
{"character": "€", "name": "Euro Sign", "slug": "euro-sign", "codepoint": "U+20AC", "url": "/symbol/euro-sign/"},
{"character": "£", "name": "Pound Sign", "slug": "pound-sign", "codepoint": "U+00A3", "url": "/symbol/pound-sign/"}
]
}
GET
Encode Character
Get Unicode info and all encoding representations for any character. Works with any Unicode character, not just curated symbols.
/api/encode/?char={character}
Parameters
| char | Any Unicode character (first character used if multiple) |
Example
curl "https://symbolfyi.com/api/encode/?char=★"
{
"character": "★",
"name": "BLACK STAR",
"codepoint": "U+2605",
"category": "So",
"category_name": "Symbol, other",
"block": "Miscellaneous Symbols",
"script": "Common",
"encodings": {
"unicode": "U+2605",
"html_decimal": "★",
"html_hex": "★",
"html_entity": "",
"css": "\\2605",
"javascript": "\\u2605",
"python": "\\u2605",
"java": "\\u2605",
"utf8_bytes": "E2 98 85",
"utf16_bytes": "26 05",
"url_encoded": "%E2%98%85"
}
}
Usage Notes
- ✓ Free to use for any purpose
- ✓ No API key or authentication required
- ✓ CORS enabled for browser requests
- ✓ OpenAPI 3.1 specification available at /api/openapi.json
- ⚠ Please be reasonable with request rates