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.
This is a Python API Wrapper for the [Spam Detector API](https://apiverve.com/marketplace/api/spamdetector)
---
## Installation
pip 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](https://apiverve.com)
---
## Usage
The Spam Detector API documentation is found here: [https://docs.apiverve.com/api/spamdetector](https://docs.apiverve.com/api/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
},
"code": 200
}
```
---
## Customer Support
Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
---
## Updates
Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
---
## Legal
All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
---
## License
Licensed under the The MIT License (MIT)
Copyright (©) 2024 APIVerve, and Evlar 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "apiverve-spamdetector",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "spam detector, spam detection, spam detect api, spam detector api, spam detection api",
"author": null,
"author_email": "APIVerve <hello@apiverve.com>",
"download_url": "https://files.pythonhosted.org/packages/f0/2b/578879a513e37fe17fdf344a521e763d807cb3a989b6cfca877702e66098/apiverve_spamdetector-1.1.5.tar.gz",
"platform": null,
"description": "Spam Detector API\r\n============\r\n\r\nSpam 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.\r\n\r\n\r\n\r\n\r\n\r\nThis is a Python API Wrapper for the [Spam Detector API](https://apiverve.com/marketplace/api/spamdetector)\r\n\r\n---\r\n\r\n## Installation\r\n\tpip install apiverve-spamdetector\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the spamdetector API client, you have to setup your account and obtain your API Key. \r\nYou can get it by signing up at [https://apiverve.com](https://apiverve.com)\r\n\r\n---\r\n\r\n## Usage\r\n\r\nThe Spam Detector API documentation is found here: [https://docs.apiverve.com/api/spamdetector](https://docs.apiverve.com/api/spamdetector). \r\nYou can find parameters, example responses, and status codes documented here.\r\n\r\n### Setup\r\n\r\n```\r\n# Import the client module\r\nfrom apiverve_spamdetector.apiClient import SpamdetectorAPIClient\r\n\r\n# Initialize the client with your APIVerve API key\r\napi = SpamdetectorAPIClient(\"[YOUR_API_KEY]\")\r\n```\r\n\r\n---\r\n\r\n\r\n### Perform Request\r\nUsing the API client, you can perform requests to the API.\r\n\r\n###### Define Query\r\n\r\n```\r\nquery = { \"text\": \"Can you please spare some change?! Desperate!!! Send cash\", \"email\": \"bankers@fre.323hotlain.net\", \"ip\": \"122.180.184.182\" }\r\n```\r\n\r\n###### Simple Request\r\n\r\n```\r\n# Make a request to the API\r\nresult = api.execute(query)\r\n\r\n# Print the result\r\nprint(result)\r\n```\r\n\r\n###### Example Response\r\n\r\n```\r\n{\r\n \"status\": \"ok\",\r\n \"error\": null,\r\n \"data\": {\r\n \"likelySpam\": true,\r\n \"isDisposableEmail\": false,\r\n \"isIPBlacklisted\": false,\r\n \"ipDetails\": {\r\n \"country\": \"IN\",\r\n \"region\": \"DL\"\r\n },\r\n \"parsed\": true\r\n },\r\n \"code\": 200\r\n}\r\n```\r\n\r\n---\r\n\r\n## Customer Support\r\n\r\nNeed any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).\r\n\r\n---\r\n\r\n## Updates\r\nStay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.\r\n\r\n---\r\n\r\n## Legal\r\n\r\nAll usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.\r\n\r\n---\r\n\r\n## License\r\nLicensed under the The MIT License (MIT)\r\n\r\nCopyright (©) 2024 APIVerve, and Evlar LLC\r\n\r\nPermission 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:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE 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.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "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.",
"version": "1.1.5",
"project_urls": {
"Documentation": "https://docs.apiverve.com/api/spamdetector?utm_source=pypi",
"Homepage": "https://apiverve.com?utm_source=pypi",
"Repository": "https://github.com/apiverve/spamdetector.Python-API",
"Twitter": "https://twitter.com/apivervehq"
},
"split_keywords": [
"spam detector",
" spam detection",
" spam detect api",
" spam detector api",
" spam detection api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9af70bff48b8f1d651d551fe99b177ad4136956b8dfd8939778f84654ce40db8",
"md5": "7a148a1731eea29852c27ba4b4ba0391",
"sha256": "bf823de87f6a2a716ed0684ff1ba0ac7f463eb1b42fa634a2e2ca1bf920e4e07"
},
"downloads": -1,
"filename": "apiverve_spamdetector-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a148a1731eea29852c27ba4b4ba0391",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 7409,
"upload_time": "2024-09-21T07:00:56",
"upload_time_iso_8601": "2024-09-21T07:00:56.998210Z",
"url": "https://files.pythonhosted.org/packages/9a/f7/0bff48b8f1d651d551fe99b177ad4136956b8dfd8939778f84654ce40db8/apiverve_spamdetector-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f02b578879a513e37fe17fdf344a521e763d807cb3a989b6cfca877702e66098",
"md5": "9edecf9e14d601289db7f4e5b79a7326",
"sha256": "dddb4341842389083bd520decf73505f2d6f6ec61c15f0fc5cc3cfcca3eaffd5"
},
"downloads": -1,
"filename": "apiverve_spamdetector-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "9edecf9e14d601289db7f4e5b79a7326",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 7158,
"upload_time": "2024-09-21T07:00:58",
"upload_time_iso_8601": "2024-09-21T07:00:58.208058Z",
"url": "https://files.pythonhosted.org/packages/f0/2b/578879a513e37fe17fdf344a521e763d807cb3a989b6cfca877702e66098/apiverve_spamdetector-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 07:00:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apiverve",
"github_project": "spamdetector.Python-API",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "apiverve-spamdetector"
}
JSON
