ponarize-api


Nameponarize-api JSON
Version 0.6 PyPI version JSON
download
home_pageNone
SummaryRelevant, accurate and fast classification of Domains. Blacklist control for aggressive IPs.
upload_time2024-09-10 09:12:57
maintainerNone
docs_urlNone
authorPonaTech
requires_pythonNone
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # [![Ponarize](https://ponarize.com/assets/media/logos/pona-logo-black.png)](https://ponarize.com)

**Ponarize** - Relevant, accurate and fast classification of Domains. Blacklist control for aggressive IPs.

## Key Features:

- Real-Time Categorization & Reputation Scoring
- IP Blacklist Search & Reputation Scoring


## Endpoints availables

Ponarize API comes with 2 different endpoints, domain categorisation and ip blacklist control. Please note that depending on your subscription plan, certain API endpoints may or may not be available.

1. **Domain Categorization API**
   - Retrieve the Ponarize category for a specified domain.

2. **IP Check API**
   - Retrieve the Ponarize information for a IP address.


## Documentation

For comprehensive details regarding API endpoints, usage, and integration guidelines, please refer to our [API Documentation](https://ponarize.com/api-keys).

Begin leveraging Ponariz today to domain categorisation and IP checks! Visit [Ponarize.com](https://ponarize.com) and easily integrate it instantly!

Start using Ponariz today for your domain categorisation and ip controls!


## Installation

You can install Ponarize Python SDK with pip.

```bash
pip install ponarize-api
```

## Usage

The Ponarize Python SDK is a wrapper around the [requests](https://docs.python-requests.org/en/master/) library. Ponarize supports only one POST request.

Sign-up to Ponarize to [get your API key](https://ponarize.com/register) and 100 credits to get started.

### Making the POST request

```python
>>> from ponarize_api import PonarizeApiClient

>>> client = PonarizeApiClient(api_key='YOUR-API-KEY')

>>> response = client.categorize_domain("domain")
```

### Request Example

```python
>>> from ponarize_api import PonarizeApiClient

>>> client = PonarizeApiClient(api_key='YOUR-API-KEY')

>>> response = client.categorize_domain("plesk.com")
```

### Response Example

```json
 {
  "status": "success",
  "message": [
    {
      "domain": "plesk.com",
      "category": "Business",
      "category2": "Online Shopping",
      "category3": "Software/Hardware",
      "category4": "Internet Services",
      "category5": "-",
      "risk": "Minimal Risk",
      "domain_age": "1999-06-13T00",
      "domain_nameserver": ["gene.ns.cloudflare.com","jeff.ns.cloudflare.com"],
      "socialLinks": {
	  "linkedin": "https://www.linkedin.com/company/plesk",
	  "facebook": "https://www.facebook.com/Plesk",
	  "twitter": "https://twitter.com/Plesk",
	  "instagram": "null",
	  "youtube": "https://www.youtube.com/channel/UCeU-_6YHGQFcVSHLbEXLNlA"
      }
    }
  ]
 }
```

### AVAILABLE METHODS

```python
>>> categorize_domain(domain: str)
>>> check_ip(ip: str)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ponarize-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "PonaTech",
    "author_email": "info@pona.com.tr",
    "download_url": "https://files.pythonhosted.org/packages/6e/b2/78ce8cc1e7bbb6846cf499ea0f51d9a2ae061675b237b16e6f1dc3466abf/ponarize_api-0.6.tar.gz",
    "platform": null,
    "description": "# [![Ponarize](https://ponarize.com/assets/media/logos/pona-logo-black.png)](https://ponarize.com)\r\n\r\n**Ponarize** - Relevant, accurate and fast classification of Domains. Blacklist control for aggressive IPs.\r\n\r\n## Key Features:\r\n\r\n- Real-Time Categorization & Reputation Scoring\r\n- IP Blacklist Search & Reputation Scoring\r\n\r\n\r\n## Endpoints availables\r\n\r\nPonarize API comes with 2 different endpoints, domain categorisation and ip blacklist control. Please note that depending on your subscription plan, certain API endpoints may or may not be available.\r\n\r\n1. **Domain Categorization API**\r\n   - Retrieve the Ponarize category for a specified domain.\r\n\r\n2. **IP Check API**\r\n   - Retrieve the Ponarize information for a IP address.\r\n\r\n\r\n## Documentation\r\n\r\nFor comprehensive details regarding API endpoints, usage, and integration guidelines, please refer to our [API Documentation](https://ponarize.com/api-keys).\r\n\r\nBegin leveraging Ponariz today to domain categorisation and IP checks! Visit [Ponarize.com](https://ponarize.com) and easily integrate it instantly!\r\n\r\nStart using Ponariz today for your domain categorisation and ip controls!\r\n\r\n\r\n## Installation\r\n\r\nYou can install Ponarize Python SDK with pip.\r\n\r\n```bash\r\npip install ponarize-api\r\n```\r\n\r\n## Usage\r\n\r\nThe Ponarize Python SDK is a wrapper around the [requests](https://docs.python-requests.org/en/master/) library. Ponarize supports only one POST request.\r\n\r\nSign-up to Ponarize to [get your API key](https://ponarize.com/register) and 100 credits to get started.\r\n\r\n### Making the POST request\r\n\r\n```python\r\n>>> from ponarize_api import PonarizeApiClient\r\n\r\n>>> client = PonarizeApiClient(api_key='YOUR-API-KEY')\r\n\r\n>>> response = client.categorize_domain(\"domain\")\r\n```\r\n\r\n### Request Example\r\n\r\n```python\r\n>>> from ponarize_api import PonarizeApiClient\r\n\r\n>>> client = PonarizeApiClient(api_key='YOUR-API-KEY')\r\n\r\n>>> response = client.categorize_domain(\"plesk.com\")\r\n```\r\n\r\n### Response Example\r\n\r\n```json\r\n {\r\n  \"status\": \"success\",\r\n  \"message\": [\r\n    {\r\n      \"domain\": \"plesk.com\",\r\n      \"category\": \"Business\",\r\n      \"category2\": \"Online Shopping\",\r\n      \"category3\": \"Software/Hardware\",\r\n      \"category4\": \"Internet Services\",\r\n      \"category5\": \"-\",\r\n      \"risk\": \"Minimal Risk\",\r\n      \"domain_age\": \"1999-06-13T00\",\r\n      \"domain_nameserver\": [\"gene.ns.cloudflare.com\",\"jeff.ns.cloudflare.com\"],\r\n      \"socialLinks\": {\r\n\t  \"linkedin\": \"https://www.linkedin.com/company/plesk\",\r\n\t  \"facebook\": \"https://www.facebook.com/Plesk\",\r\n\t  \"twitter\": \"https://twitter.com/Plesk\",\r\n\t  \"instagram\": \"null\",\r\n\t  \"youtube\": \"https://www.youtube.com/channel/UCeU-_6YHGQFcVSHLbEXLNlA\"\r\n      }\r\n    }\r\n  ]\r\n }\r\n```\r\n\r\n### AVAILABLE METHODS\r\n\r\n```python\r\n>>> categorize_domain(domain: str)\r\n>>> check_ip(ip: str)\r\n```\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Relevant, accurate and fast classification of Domains. Blacklist control for aggressive IPs.",
    "version": "0.6",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1986b712110fba0e17c6d50f902be1a7eb96b8dadc4f86420ea43bf991f166ef",
                "md5": "d03d83b459d9acdf1e5a5687110ceb44",
                "sha256": "5b7ed697159309eefe6a1e4e879b7382fd07c8b6fbdc9dc3561c86bb5d456e6b"
            },
            "downloads": -1,
            "filename": "ponarize_api-0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d03d83b459d9acdf1e5a5687110ceb44",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 2921,
            "upload_time": "2024-09-10T09:12:55",
            "upload_time_iso_8601": "2024-09-10T09:12:55.060059Z",
            "url": "https://files.pythonhosted.org/packages/19/86/b712110fba0e17c6d50f902be1a7eb96b8dadc4f86420ea43bf991f166ef/ponarize_api-0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6eb278ce8cc1e7bbb6846cf499ea0f51d9a2ae061675b237b16e6f1dc3466abf",
                "md5": "00fea3969cfe5918d0532c924d1612e9",
                "sha256": "8668eb4969bac6ef9cdb4e3ce08a16c72951d3ba333ff6997bb2fdb15776ea5f"
            },
            "downloads": -1,
            "filename": "ponarize_api-0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "00fea3969cfe5918d0532c924d1612e9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2616,
            "upload_time": "2024-09-10T09:12:57",
            "upload_time_iso_8601": "2024-09-10T09:12:57.819358Z",
            "url": "https://files.pythonhosted.org/packages/6e/b2/78ce8cc1e7bbb6846cf499ea0f51d9a2ae061675b237b16e6f1dc3466abf/ponarize_api-0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-10 09:12:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ponarize-api"
}
        
Elapsed time: 0.31047s