Skip to main content

Anagram Detector is a tool for checking if two words or phrases are anagrams of each other. It provides character frequency analysis and similarity scoring.

Project description

Anagram Detector API

Anagram Detector is a tool for checking if two words or phrases are anagrams of each other. It provides character frequency analysis and similarity scoring.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Anagram Detector API


Installation

Using pip:

pip install apiverve-anagramdetector

Using pip3:

pip3 install apiverve-anagramdetector

Configuration

Before using the anagramdetector 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_anagramdetector.apiClient import AnagramdetectorAPIClient

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

query = {
    "text1": "listen",
    "text2": "silent",
    "ignorecase": true,
    "ignorespaces": true
}

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

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

Usage

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

Setup

# Import the client module
from apiverve_anagramdetector.apiClient import AnagramdetectorAPIClient

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

Perform Request

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

Define Query
query = {
    "text1": "listen",
    "text2": "silent",
    "ignorecase": true,
    "ignorespaces": true
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "text1": "listen",
    "text2": "silent",
    "is_anagram": true,
    "cleaned_text1": "listen",
    "cleaned_text2": "silent",
    "sorted_text1": "eilnst",
    "sorted_text2": "eilnst",
    "length_text1": 6,
    "length_text2": 6,
    "character_frequency_text1": {
      "l": 1,
      "i": 1,
      "s": 1,
      "t": 1,
      "e": 1,
      "n": 1
    },
    "character_frequency_text2": {
      "s": 1,
      "i": 1,
      "l": 1,
      "e": 1,
      "n": 1,
      "t": 1
    },
    "common_characters": {
      "l": 1,
      "i": 1,
      "s": 1,
      "t": 1,
      "e": 1,
      "n": 1
    },
    "unique_to_text1": {},
    "unique_to_text2": {},
    "similarity_percentage": 100,
    "options": {
      "ignore_case": true,
      "ignore_spaces": true
    }
  }
}

Error Handling

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

Basic Error Handling

from apiverve_anagramdetector.apiClient import AnagramdetectorAPIClient, AnagramdetectorAPIClientError

api = AnagramdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "text1": "listen",
    "text2": "silent",
    "ignorecase": true,
    "ignorespaces": true
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except AnagramdetectorAPIClientError 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_anagramdetector.apiClient import AnagramdetectorAPIClient, AnagramdetectorAPIClientError

api = AnagramdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "text1": "listen",
    "text2": "silent",
    "ignorecase": true,
    "ignorespaces": true
}

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 AnagramdetectorAPIClientError 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_anagramdetector.apiClient import AnagramdetectorAPIClient, AnagramdetectorAPIClientError

query = {
    "text1": "listen",
    "text2": "silent",
    "ignorecase": true,
    "ignorespaces": true
}

# Using context manager ensures proper cleanup
with AnagramdetectorAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except AnagramdetectorAPIClientError 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_anagramdetector.apiClient import AnagramdetectorAPIClient

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

query = {
    "text1": "listen",
    "text2": "silent",
    "ignorecase": true,
    "ignorespaces": true
}

# 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_anagramdetector.apiClient import AnagramdetectorAPIClient

api = AnagramdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "text1": "listen",
    "text2": "silent",
    "ignorecase": true,
    "ignorespaces": true
}

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_anagramdetector-1.1.14.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

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

apiverve_anagramdetector-1.1.14-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for apiverve_anagramdetector-1.1.14.tar.gz
Algorithm Hash digest
SHA256 c8401144fecac4d07fa99ed1b57760baff4ef01b6cd917b36d2b77f59ba3bca4
MD5 716d3270c072a9d2a6f4ca0e8b875e1a
BLAKE2b-256 77da9bf48c9f938a23178179ea83e677627bf2b9ec2db8a1151e969bf6372fb3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_anagramdetector-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 a8604e3155499f2a98feeaa22b67b3c16c6c0559900923bb820e89ab360fafc5
MD5 545a056d585fbbb8cf482906efb508d2
BLAKE2b-256 c69ec1e27c42f0e5a90a9c9535197ac36a6cfb4661bdc0e9b940410a88889323

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