Документация API

Бесплатный API символов Unicode. Аутентификация не требуется. Ответы в формате JSON.

Бесплатно Аутентификация не требуется JSON OpenAPI ↗

Базовый URL

https://symbolfyi.com/api/

GET

Детали символа

Получить полную информацию о символе, включая свойства Unicode и все представления кодировок.

/api/symbol/{slug}/

Параметры

slug	Слаг символа (например, black-heart-suit)

Пример

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": "&#9829;",
    "html_hex": "&#x2665;",
    "html_entity": "&hearts;",
    "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

Поиск символов

Поиск символов по имени, ключевому слову, псевдониму или HTML-сущности. Также принимает одиночный символ для точного поиска.

/api/search/?q={query}

Параметры

q	Поисковый запрос (имя, ключевое слово или символ)

Пример

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

Символы категории

Получить все символы в категории (макс. 200).

/api/category/{slug}/

Параметры

slug	Слаг категории (например, arrows, currency, mathematical)

Пример

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

Кодировать символ

Получить информацию Unicode и все представления кодировок для любого символа. Работает с любым символом Unicode, не только с отобранными символами.

/api/encode/?char={character}

Параметры

char	Любой символ Unicode (используется первый символ, если их несколько)

Пример

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": "&#9733;",
    "html_hex": "&#x2605;",
    "html_entity": "",
    "css": "\\2605",
    "javascript": "\\u2605",
    "python": "\\u2605",
    "java": "\\u2605",
    "utf8_bytes": "E2 98 85",
    "utf16_bytes": "26 05",
    "url_encoded": "%E2%98%85"
  }
}

Примечания по использованию

✓ Бесплатно для использования в любых целях
✓ Ключ API или аутентификация не требуются
✓ CORS включён для запросов из браузера
✓ Спецификация OpenAPI 3.1 доступна по адресу /api/openapi.json
⚠ Пожалуйста, соблюдайте разумную частоту запросов