cheatsnake / emojihub

😺 A simple & free HTTP API with emojis for your cool apps

EmojiHub provides an opportunity to get random emojis from already sorted categories and groups. You can also get a whole list of emojis by a certain category, group, or get the entire emoji database consisting of 1791 objects.

All emoji data is stored in a simple JSON object from which you can get html codes to insert into your web applications.

📄 API documentation

• Get random emoji

GET https://emojihub.yurace.pro/api/random

{
    "name": "hugging face",
    "category": "smileys and people",
    "group": "face positive",
    "htmlCode": ["🤗"],
    "unicode": ["U+1F917"]
}

• Get an array of all emojis

GET https://emojihub.yurace.pro/api/all

Each endpoint can be supplemented by a path to a specific category or group:

/category/{category-name}

/group/{group-name}

📚 Table with all available emoji categories and groups:

Category	Groups
smileys-and-people	body, cat-face, clothing, creature-face, emotion, face-negative, face-neutral, face-positive, face-positive, face-role, face-sick, family, monkey-face, person, person-activity, person-gesture, person-role, skin-tone
animals-and-nature	animal-amphibian, animal-bird, animal-bug, animal-mammal, animal-marine, animal-reptile, plant-flower, plant-other
food-and-drink	dishware, drink, food-asian, food-fruit, food-prepared, food-sweet, food-vegetable
travel-and-places	travel-and-places
activities	activities
objects	objects
symbols	symbols
flags	flags

🎯 Examples

https://emojihub.yurace.pro/api/random/group/face-positive

https://emojihub.yurace.pro/api/random/category/food-and-drink

https://emojihub.yurace.pro/api/all/category/travel-and-places

https://emojihub.yurace.pro/api/all/group/animal-bird

🚀 Server startup

1. Clone this repository:

git clone https://github.com/cheatsnake/emojihub.git

cd ./emojihub

2. Inside the project, run this command to install the necessary packages:

go mod download

Make sure you have already installed Go on your computer.

3. Start the server by running the last command:

go run cmd/main.go

The server will start at the address: http://localhost:4000

🐳 Docker container startup

Run the following commands to create an image and start the container:

docker build -t emojihub . --target production

docker run -p 4000:4000 --name emojihub-server emojihub

emojihub's Issues

Using emojihub in a student project

Hi @cheatsnake - one of our teachers at scrimba.com wants to use your api in a project she is building for students. For public api's I prefer that we host our own version for students it since it is not uncommon for public api's to change domains, path structure to change in versions, they go down etc. which creates issues for our recorded material. This also reduces the traffic from your heroku instance.

Happy to put in canonical url tags,etc. to give you any seo,etc. Feel free to reach out on frode at scrimba to discuss as well.

Heroku application error

I want to access the emoji data but am unable to - when I copy paste the given urls like https://emojihub.herokuapp.com/api/random/group_face_positive into my browser and search I get the following message: "An error occurred in the application and your page could not be served. If you are the application owner, check your logs for details. You can do this from the Heroku CLI with the command
heroku logs --tail"

Why emoji in https://emojihub.herokuapp.com/api/all are not in sequence.

Before:

After:

Cors not enabled

Got a cors error when making a request to https://emojihub.yurace.pro/api/all/group/animal-bird in javascript of a page.

Migrated from Heroku

Migrated from Heroku

Hello, Developers! Due to the closure of free hosting service Heroku, I decided to move all my public APIs projects on my own server.

Because of this, the EmojiHub has undergone some changes:

1. The new permanent domain name - emojihub.yurace.pro.
2. Complete rewrite of the code in Go language (now everything is fast, lightweight and easy to clone). You can still find the old version in the special branch.
3. Updated API endpoints (following to best practices).

Hopefully in the future there will be no such incompatible changes and now we will be completely focused only on adding new functionality.

Thank you for continuing to use the EmojiHub API!