Skip to main content

Spam Detector is a simple tool for detecting spam in a text. It utilize an email address or IP address to validate the given text against the spam database.

Project description

Spam Detector API

Spam Detector is a simple tool for detecting spam in a text. It utilize an email address or IP address to validate the given text against the spam database.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Spam Detector API


Installation

Using pip:

pip install apiverve-spamdetector

Using pip3:

pip3 install apiverve-spamdetector

Configuration

Before using the spamdetector 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_spamdetector.apiClient import SpamdetectorAPIClient

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

query = {
    "text": "Can you please spare some change?! Desperate!!! Send cash",
    "email": "bankers@fre.323hotlain.net",
    "ip": "122.180.184.182"
}

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

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

Usage

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

Setup

# Import the client module
from apiverve_spamdetector.apiClient import SpamdetectorAPIClient

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

Perform Request

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

Define Query
query = {
    "text": "Can you please spare some change?! Desperate!!! Send cash",
    "email": "bankers@fre.323hotlain.net",
    "ip": "122.180.184.182"
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "likelySpam": true,
    "isDisposableEmail": false,
    "isIPBlacklisted": false,
    "ipDetails": {
      "country": "IN",
      "region": "DL"
    },
    "parsed": true
  }
}

Error Handling

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

Basic Error Handling

from apiverve_spamdetector.apiClient import SpamdetectorAPIClient, SpamdetectorAPIClientError

api = SpamdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "text": "Can you please spare some change?! Desperate!!! Send cash",
    "email": "bankers@fre.323hotlain.net",
    "ip": "122.180.184.182"
}

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

api = SpamdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "text": "Can you please spare some change?! Desperate!!! Send cash",
    "email": "bankers@fre.323hotlain.net",
    "ip": "122.180.184.182"
}

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 SpamdetectorAPIClientError 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_spamdetector.apiClient import SpamdetectorAPIClient, SpamdetectorAPIClientError

query = {
    "text": "Can you please spare some change?! Desperate!!! Send cash",
    "email": "bankers@fre.323hotlain.net",
    "ip": "122.180.184.182"
}

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

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

query = {
    "text": "Can you please spare some change?! Desperate!!! Send cash",
    "email": "bankers@fre.323hotlain.net",
    "ip": "122.180.184.182"
}

# 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_spamdetector.apiClient import SpamdetectorAPIClient

api = SpamdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "text": "Can you please spare some change?! Desperate!!! Send cash",
    "email": "bankers@fre.323hotlain.net",
    "ip": "122.180.184.182"
}

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

Uploaded Source

Built Distribution

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

apiverve_spamdetector-1.1.14-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for apiverve_spamdetector-1.1.14.tar.gz
Algorithm Hash digest
SHA256 da5ee68f58973c85840403a8be333f7b8828fdb59a65c4268dbf9e65394c1cc9
MD5 80997e67356ef66a009de38828aa1f9d
BLAKE2b-256 e5f01320cac593d9f120bbf976de47d6ca8f0dff80b4e5e30179b80e4e65990f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_spamdetector-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 150e0dad892a40344e57423f0a831ada38b34a087f35ceb24ddfd13dc22226e9
MD5 0f88bea7ab422ddf4958acfae33f5ae5
BLAKE2b-256 98740a0067e1d771bcc9765b3c7f29afab863a3449050c165b8c18c0840f2c30

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