Categories and Versions • Endpoints • HTTP Response Codes • Technical detail and API Rate Limiting • Contributing • License • Credits • Support Project
|
|
Index • Search emojis • Random emojis • Popular emojis • Categories • Search by id
GET https://api.emojisworld.fr/v1{
"message": "Welcome on Emojis World API ( version 1) !!"
}GET https://api.emojisworld.fr/v1/search| Query Strings | Type | Description | Example |
|---|---|---|---|
| q | String - Required | A search word (only in english) | q=happy |
| limit | Integer - Optional | Fetch up to a specified number of results (max: 50) | limit=25 |
| categories | List of Integers - Optional | Filter response by categories ids | categories=1,2,3 |
| sub_categories | List of Integers - Optional | Filter response by sub_categories ids | sub_categories=1,2,3 |
| versions | List of Floats - Optional | Filter response by specifics versions | versions=1.0,13.1 |
https://api.emojisworld.fr/v1/search?q=party&categories=7,8,6&sub_categories=61,66,63&versions=0.6,13.0{
"totals": 4,
"results": [
{
"id": 1691,
"name": "party popper",
"emoji": "🎉",
"unicode": "1F389",
"version": "0.6",
"category": {
"id": 7,
"name": "Activities"
},
"sub_category": {
"id": 61,
"name": "event"
},
"children": [
]
},
{
"id": 1248,
"name": "dress",
"emoji": "👗",
"unicode": "1F457",
"version": "0.6",
"category": {
"id": 8,
"name": "Objects"
},
"sub_category": {
"id": 66,
"name": "clothing"
},
"children": [
]
},
{
"id": 1718,
"name": "bowling",
"emoji": "🎳",
"unicode": "1F3B3",
"version": "0.6",
"category": {
"id": 7,
"name": "Activities"
},
"sub_category": {
"id": 63,
"name": "sport"
},
"children": [
]
},
{
"id": 1687,
"name": "fireworks",
"emoji": "🎆",
"unicode": "1F386",
"version": "0.6",
"category": {
"id": 7,
"name": "Activities"
},
"sub_category": {
"id": 61,
"name": "event"
},
"children": [
]
}
]
}GET https://api.emojisworld.fr/v1/random| Query Strings | Type | Description | Example |
|---|---|---|---|
| limit | Integer - Optional | Fetch up to a specified number of results (max: 50) | limit=25 |
| categories | List of Integers - Optional | Filter the response by categories ids | categories=1,2,3 |
| sub_categories | List of Integers - Optional | Filter the response by sub categories ids | sub_categories=1,2,3 |
| versions | List of Floats - Optional | Filter response by specifics versions | versions=1.0,13.1 |
GET https://api.emojisworld.fr/v1/random?&categories=7,8,6&sub_categories=61,66,63&versions=0.6,13.0&limit=2{
"totals": 2,
"results": [
{
"id": 1254,
"name": "clutch bag",
"emoji": "👝",
"unicode": "1F45D",
"version": "0.6",
"category": {
"id": 8,
"name": "Objects"
},
"sub_category": {
"id": 66,
"name": "clothing"
},
"children": [
]
},
{
"id": 3588,
"name": "military helmet",
"emoji": "🪖",
"unicode": "1FA96",
"version": "13.0",
"category": {
"id": 8,
"name": "Objects"
},
"sub_category": {
"id": 66,
"name": "clothing"
},
"children": [
]
}
]
}GET https://api.emojisworld.fr/v1/popular| Query Strings | Type | Description | Example |
|---|---|---|---|
| limit | Integer - Optional | Fetch up to a specified number of results (max: 50) | limit=25 |
| categories | List of Integers - Optional | Filter the response by categories ids | categories=1,2,3 |
| sub_categories | List of Integers - Optional | Filter the response by sub categories ids | sub_categories=1,2,3 |
| versions | List of Floats - Optional | Filter response by specifics versions | versions=1.0,13.1 |
GET https://api.emojisworld.fr/v1/popular?&categories=7,8,6&sub_categories=61,66,63&versions=0.6,13.0&limit=2{
"totals": 2,
"results": [
{
"id": 1253,
"name": "handbag",
"emoji": "👜",
"unicode": "1F45C",
"version": "0.6",
"count": 46,
"category": {
"id": 8,
"name": "Objects"
},
"sub_category": {
"id": 66,
"name": "clothing"
},
"children": [
]
},
{
"id": 1252,
"name": "purse",
"emoji": "👛",
"unicode": "1F45B",
"version": "0.6",
"count": 45,
"category": {
"id": 8,
"name": "Objects"
},
"sub_category": {
"id": 66,
"name": "clothing"
},
"children": [
]
}
]
}GET https://api.emojisworld.fr/v1/categories{
"totals":10,
"results":[
{
"id":1,
"name":"Smileys & Emotion",
"emojis_count":163,
"sub_categories":[
{
"id": 1,
"name": "face-smiling",
"emojis_count": 14
},
{
"id": 2,
"name": "face-affection",
"emojis_count": 9
}
]
}
]
}GET https://api.emojisworld.fr/v1/emojis/{id}{
"id": 1,
"name": "grinning face",
"emoji": "😀",
"unicode": "1F600",
"version": "1.0",
"category": {
"id": 1,
"name": "Smileys & Emotion"
},
"sub_category": {
"id": 1,
"name": "face-smiling"
},
"children": [
],
"parent": null
}| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Access Forbidden |
| 404 | Not Found |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
API Rate Limiting : 500 REQUESTS / DAY / IP.
| Header | Description | Example |
|---|---|---|
| X-Rate-Limit-Limit | The maximum number of request you-re permitted to make per period of 1 day | 500 |
| X-Rate-Limit-Remaining | Your current number of request | 100 |
| X-Rate-Limit-Reset | The time at which the rate limit resets | Tue Aug 17 2021 17:43:28 GMT+0200 |
- API is using Node.js with the Express.js framework
- All emojis data are stored in a MySQL and Typesense databases
I search contributors for help me to complete and correct keywords for each emoji. This will allow for a better and more relevant search.
You can find the complete list of emojis and associated keywords in emojis.json file.
We encourage you to contribute to Emojis World !! Please check out the Contributing to Emojis World guide for guidelines about how to proceed. Join us!
Trying to report a possible security vulnerability in Emojis World ? Consider using email : contact@antonbourtnik.fr with clear description of security vulnerability.
Emojis World is made available under the MIT License.
Emojis World is created and maintained by Anton Bourtnik