Public / Documentation

API Documentation

Emoji API Docs

Read-only API with search, categories, and emoji detail. Responses are cacheable and include ETag.

https://dewemoji.com/v1

Authentication

Public endpoints are open. Personal plan holders can create API keys for private keyword access.

Authorization: Bearer YOUR_API_KEY
X-Api-Key: YOUR_API_KEY
  • Authorization or X-Api-Key for Personal API keys
  • X-Account-Id (optional usage association)

Plans & limits

Private keyword matching uses only keywords with is_active=true. Inactive keywords remain stored but are excluded from search results until reactivated.

Tier Page size cap Auth Rate limits Notes
Free (public) 20 None Server-level only Public dataset (EN + ID) plus up to 20 active private keywords for signed-in users.
Personal 50 API key Unlimited public + private Unlocks private keyword search + sync.

Endpoints

  • /emojis — search & paginate
  • /emoji?slug=<slug> — single emoji (query)
  • /emoji/<slug> — single emoji (pretty URL)
  • /categories — category map
  • /user/register — create account
  • /user/login — account login
  • /user/apikeys — manage API keys (Personal)

GET /emojis

Search across name, category, aliases, and EN/ID keywords.

Query Param Type Description Default
q / querystringKeyword search (AND match).empty
categorystringTop-level category label.all
subcategorystringSubcategory slug.empty
pagenumber1-based page.1
limitnumberItems per page (max 50).20
 
curl "<BASE_URL>/emojis?q=love&category=Smileys%20%26%20Emotion&limit=20&page=1"

GET /emoji and /emoji/<slug>

curl "<BASE_URL>/emoji/smiling-face-with-smiling-eyes"

GET /categories

curl "<BASE_URL>/categories"

Try it

Demo request is limited to page=1 and limit=10.

Errors & caching

  • 400 — invalid_request
  • 401 — invalid_key
  • 409 — pending_cooldown (billing checkout lock, wait retry_after seconds)
  • 404 — not_found
  • 429 — rate_limited

Responses may include ETag and Cache-Control: public, max-age=300.