# Opportify-SDK-Python
## Overview
The **Opportify Insights API** provides access to a powerful and up-to-date platform. With advanced data warehousing and AI-driven capabilities, this API is designed to empower your business to make informed, data-driven decisions and effectively assess potential risks.
[Sign Up Free](https://www.opportify.ai)
### Base URL
Use the following base URL for all API requests:
```plaintext
https://api.opportify.ai/insights/v1/<service>/<endpoint>
```
## Requirements
Requires Python v3.8 or later
## Getting Started
First, install Opportify SDK via PyPI manager:
```
pip install opportify-sdk
```
### Calling Email Insights
```python
from opportify_sdk import EmailInsights
# Initialize the wrapper with your API key
api_key = "<YOUR-API-KEY-HERE>"
email_insights = EmailInsights(api_key)
# Optional: Configure host, version, and debug mode
email_insights.set_version("v1")
# Define request parameters
params = {
"email": "<SOME-EMAIL-HERE>",
"enableAutoCorrection": True,
"enableAi": True
}
# Call the API
try:
result = email_insights.analyze(params)
print("Response:", result)
except Exception as e:
print(f"Error: {e}")
```
### Calling IP Insights
```python
from opportify_sdk import IpInsights
# Initialize the wrapper with your API key
api_key = "<YOUR-API-KEY-HERE>"
ip_insights = IpInsights(api_key)
# Optional: Configure host, version, and debug mode
ip_insights.set_version("v1")
# Define request parameters
params = {
"ip": "<SOME-IP-HERE>",
"enableAi": True
}
# Call the API
try:
result = ip_insights.analyze(params)
print("Response:", result)
except Exception as e:
print(f"Error: {e}")
```
### Enable Debug Mode
```python
ip_insights.set_version("v1").set_debug_mode(True)
email_insights.set_version("v1").set_debug_mode(False)
```
## About this package
This Python package is a customization of the base generated by:
- [OpenAPI Generator](https://openapi-generator.tech) project.
Raw data
{
"_id": null,
"home_page": "https://github.com/opportify/opportify-sdk-python",
"name": "opportify-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Opportify Insights API, Opportify",
"author": "Opportify & OpenAPI-Generator",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/32/c7/7015803a7dcaceb27b601f772fc9724e454ef0b21ccd7da6e2d539105201/opportify_sdk-0.1.1.tar.gz",
"platform": null,
"description": "# Opportify-SDK-Python\n\n## Overview\n\nThe **Opportify Insights API** provides access to a powerful and up-to-date platform. With advanced data warehousing and AI-driven capabilities, this API is designed to empower your business to make informed, data-driven decisions and effectively assess potential risks.\n\n[Sign Up Free](https://www.opportify.ai)\n\n### Base URL\nUse the following base URL for all API requests:\n\n```plaintext\nhttps://api.opportify.ai/insights/v1/<service>/<endpoint>\n```\n\n## Requirements\n\nRequires Python v3.8 or later\n\n## Getting Started\n\nFirst, install Opportify SDK via PyPI manager:\n\n```\npip install opportify-sdk\n```\n\n### Calling Email Insights\n\n```python\nfrom opportify_sdk import EmailInsights\n\n# Initialize the wrapper with your API key\napi_key = \"<YOUR-API-KEY-HERE>\"\nemail_insights = EmailInsights(api_key)\n\n# Optional: Configure host, version, and debug mode\nemail_insights.set_version(\"v1\")\n\n# Define request parameters\nparams = {\n \"email\": \"<SOME-EMAIL-HERE>\",\n \"enableAutoCorrection\": True,\n \"enableAi\": True \n}\n\n# Call the API\ntry:\n result = email_insights.analyze(params)\n print(\"Response:\", result)\nexcept Exception as e:\n print(f\"Error: {e}\")\n```\n\n### Calling IP Insights\n\n```python\n\nfrom opportify_sdk import IpInsights\n\n# Initialize the wrapper with your API key\napi_key = \"<YOUR-API-KEY-HERE>\"\nip_insights = IpInsights(api_key)\n\n# Optional: Configure host, version, and debug mode\nip_insights.set_version(\"v1\")\n\n# Define request parameters\nparams = {\n \"ip\": \"<SOME-IP-HERE>\",\n \"enableAi\": True \n}\n\n# Call the API\ntry:\n result = ip_insights.analyze(params)\n print(\"Response:\", result)\nexcept Exception as e:\n print(f\"Error: {e}\")\n```\n\n### Enable Debug Mode\n\n```python\nip_insights.set_version(\"v1\").set_debug_mode(True)\nemail_insights.set_version(\"v1\").set_debug_mode(False)\n```\n\n## About this package\n\nThis Python package is a customization of the base generated by:\n\n- [OpenAPI Generator](https://openapi-generator.tech) project.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Opportify Insights API",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/opportify/opportify-sdk-python"
},
"split_keywords": [
"openapi",
" openapi-generator",
" opportify insights api",
" opportify"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf13cfddf7cb7e90bbd1ca026d1ecdb36b251e4caeb4d42267da879ddf94495a",
"md5": "cf5da9683bbf125f396a681f946408d3",
"sha256": "2afb2e51a2ebfbf70cdf7bae3b043a020ec8376ede92e9d9d73733d0c514cadc"
},
"downloads": -1,
"filename": "opportify_sdk-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf5da9683bbf125f396a681f946408d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 123204,
"upload_time": "2024-12-29T19:40:13",
"upload_time_iso_8601": "2024-12-29T19:40:13.184903Z",
"url": "https://files.pythonhosted.org/packages/bf/13/cfddf7cb7e90bbd1ca026d1ecdb36b251e4caeb4d42267da879ddf94495a/opportify_sdk-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "32c77015803a7dcaceb27b601f772fc9724e454ef0b21ccd7da6e2d539105201",
"md5": "6b13247ac551f936ceb519864da64f06",
"sha256": "eda7e1770d74a57b0030b64d3cff1c8625c3112967ffe11a209ff66291a66a61"
},
"downloads": -1,
"filename": "opportify_sdk-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "6b13247ac551f936ceb519864da64f06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 47031,
"upload_time": "2024-12-29T19:40:16",
"upload_time_iso_8601": "2024-12-29T19:40:16.460849Z",
"url": "https://files.pythonhosted.org/packages/32/c7/7015803a7dcaceb27b601f772fc9724e454ef0b21ccd7da6e2d539105201/opportify_sdk-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-29 19:40:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opportify",
"github_project": "opportify-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "urllib3",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"1.25.3"
]
]
},
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.8.2"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"2"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"4.7.1"
]
]
},
{
"name": "openapi_client",
"specs": [
[
">=",
"1.0.0"
]
]
}
],
"tox": true,
"lcname": "opportify-sdk"
}
JSON
