Skip to main content

Emoji is a simple tool for getting emoji data. It returns the emoji name, category, and more.

Project description

Emoji Lookup API

Emoji is a simple tool for getting emoji data. It returns the emoji name, category, and more.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Emoji Lookup API


Installation

Using pip:

pip install apiverve-emojilookup

Using pip3:

pip3 install apiverve-emojilookup

Configuration

Before using the emoji API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_emojilookup.apiClient import EmojiAPIClient

# Initialize the client with your APIVerve API key
api = EmojiAPIClient("[YOUR_API_KEY]")

query = { "emoji": "🥳" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Emoji Lookup API documentation is found here: https://docs.apiverve.com/ref/emoji. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_emojilookup.apiClient import EmojiAPIClient

# Initialize the client with your APIVerve API key
api = EmojiAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "emoji": "🥳" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "count": 1,
    "emojisFound": [
      {
        "emoji": "🥳",
        "description": "partying face",
        "category": "Smileys & Emotion",
        "aliases": [
          "partying_face"
        ],
        "tags": [
          "celebration",
          "birthday"
        ],
        "unicode_version": "11.0",
        "ios_version": "12.1",
        "codePoint": "1f973"
      }
    ]
  }
}

Error Handling

The API client provides comprehensive error handling through the EmojiAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_emojilookup.apiClient import EmojiAPIClient, EmojiAPIClientError

api = EmojiAPIClient("[YOUR_API_KEY]")

query = { "emoji": "🥳" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except EmojiAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_emojilookup.apiClient import EmojiAPIClient, EmojiAPIClientError

api = EmojiAPIClient("[YOUR_API_KEY]")

query = { "emoji": "🥳" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except EmojiAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_emojilookup.apiClient import EmojiAPIClient, EmojiAPIClientError

query = { "emoji": "🥳" }

# Using context manager ensures proper cleanup
with EmojiAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except EmojiAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_emojilookup.apiClient import EmojiAPIClient

# Enable debug mode
api = EmojiAPIClient("[YOUR_API_KEY]", debug=True)

query = { "emoji": "🥳" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_emojilookup.apiClient import EmojiAPIClient

api = EmojiAPIClient("[YOUR_API_KEY]")

query = { "emoji": "🥳" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_emojilookup-1.1.14.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_emojilookup-1.1.14-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_emojilookup-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_emojilookup-1.1.14.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_emojilookup-1.1.14.tar.gz
Algorithm Hash digest
SHA256 29396ad34265552c9f53d7c757a412e7b0d420bc0e492673783e3d464ee2c58d
MD5 414f2bdf83229e8fe85810e301423067
BLAKE2b-256 95e2cae5b47c90216a6181766cce466f3637b281bcc4545f09085e8a4f085914

See more details on using hashes here.

File details

Details for the file apiverve_emojilookup-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_emojilookup-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 4b2a2068b9e4c06ede80abe686ba387a064edd29be4e72ab004473a1d7b60ae7
MD5 4c2b080dc295fa4f92bb33baa20c4ab4
BLAKE2b-256 304a88e6317a41e39bb97d7dab850ee584fe93fd6dca4a78a134da40222bb9db

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page