GET/emoji/[lookup]

getEmoji

Get a .png of an emoji by looking it up.

Request

GET/emoji/[lookup]

Parameters

lookup

string

The lookup term, which could be the emoji name or unicode character.

Query

style

stringOptional (default: apple)

The style of the emoji. Must be one of: apple, facebook, google, twitter.

size

stringOptional (default: 64)

The size of the image in pixels. Supported values per style: - apple: 64, 160 - facebook: 64, 96 - google: 64, 136 - twitter: 64, 72

asJson

booleanOptional (default: false)

If true, returns JSON metadata instead of the PNG image.

Responses

200

Successful response

Body

file

A file is returned as the body.

Headers

Content-Typestring

The content type of the image

Cache-Controlstring

The cache control header

200

Successful response when asJson=true

Body

object

{
  "data": {
    "name": "herb",
    "unified": "1F33F",
    "image": "https://ted.ac/api/emoji/herb",
    "category": "Animals & Nature",
    "subcategory": "plant-other"
  },
  "error": null
}

400

Error

The provided size is not supported for the selected style.

Body

object

{
  "data": null,
  "error": "Size \"96\" is not supported for style \"apple\""
}

400

Error

The provided style is invalid.

Body

object

{
  "data": null,
  "error": "Invalid style"
}

400

Error

The lookup string could not be decoded.

Body

object

{
  "data": null,
  "error": "Malformed lookup string"
}

404

Error

No matching emoji was found or image is missing.

Body

object

{
  "data": null,
  "error": "Invalid lookup"
}

400

Error

Failed to fetch the emoji image from the CDN.

Body

object

{
  "data": null,
  "error": "Failed to fetch emoji image"
}