# scarlet-shark-python
Scarlet Shark REST API Python client.
## Installation
```
pip install scarlet-shark-python
```
## Usage example
```python
from scarlet_shark_python.client import ClientFactory
client = ClientFactory.get_client('<your API key>', api_version='v0.4', print_json=True)
result = client.search_domain(domain='scarletshark.com')
```
prints
```json
{
"age": 4043,
"associated_urls": [],
"classification": "security",
"disclosure_email": "unknown",
"domain": "scarletshark.com",
"domain_description": "",
"ip": "40.[redacted]",
"reference_url": "",
"registered": "2012-04-02",
"service": {
"service_email": "",
"service_id": 0,
"service_name": "unknown",
"service_trust": "unknown",
"service_type": "unknown",
"service_url": ""
},
"tags": [
"security"
],
"threat_actor_aliases": [],
"threat_actor_id": 0,
"threat_classification": "safe",
"threat_explanation": "The domain is considered to be safe and it hosts no known malicious content.",
"tracking_domain": false
}
```
## Supported actions
### API version 0.4
* search_dns
* search_domain
* search_email
* search_hash
* search_ip
* search_network
* search_threat_actors
* search_threat_tools
* search_url
Raw data
{
"_id": null,
"home_page": "https://github.com/PiRogueToolSuite/scarlet-shark-python",
"name": "scarlet-shark-python",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "U+039b",
"author_email": "esther@pts-project.org",
"download_url": "https://files.pythonhosted.org/packages/9a/2d/bd10a3705594bf94d0b6908ed2818c38bdf7f5179d37a04a7d47264be3e5/scarlet-shark-python-1.0.3.tar.gz",
"platform": null,
"description": "# scarlet-shark-python\nScarlet Shark REST API Python client.\n\n## Installation\n```\npip install scarlet-shark-python\n```\n\n## Usage example\n```python\nfrom scarlet_shark_python.client import ClientFactory\n\nclient = ClientFactory.get_client('<your API key>', api_version='v0.4', print_json=True)\nresult = client.search_domain(domain='scarletshark.com')\n```\nprints\n```json\n{\n \"age\": 4043,\n \"associated_urls\": [],\n \"classification\": \"security\",\n \"disclosure_email\": \"unknown\",\n \"domain\": \"scarletshark.com\",\n \"domain_description\": \"\",\n \"ip\": \"40.[redacted]\",\n \"reference_url\": \"\",\n \"registered\": \"2012-04-02\",\n \"service\": {\n \"service_email\": \"\",\n \"service_id\": 0,\n \"service_name\": \"unknown\",\n \"service_trust\": \"unknown\",\n \"service_type\": \"unknown\",\n \"service_url\": \"\"\n },\n \"tags\": [\n \"security\"\n ],\n \"threat_actor_aliases\": [],\n \"threat_actor_id\": 0,\n \"threat_classification\": \"safe\",\n \"threat_explanation\": \"The domain is considered to be safe and it hosts no known malicious content.\",\n \"tracking_domain\": false\n}\n```\n\n## Supported actions\n### API version 0.4\n* search_dns\n* search_domain\n* search_email\n* search_hash\n* search_ip\n* search_network\n* search_threat_actors\n* search_threat_tools\n* search_url\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Scarlet Shark REST API Python client",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/PiRogueToolSuite/scarlet-shark-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06a34647ec86c28b569dee1e7eb5cf16878358bdf085b9337bd97309f929732b",
"md5": "1aead0fae25c685ec275cff3745ef663",
"sha256": "6f7a7ae9a28a734044804248c553ec44c3dcbc06e2e992e9918820d49a98ad21"
},
"downloads": -1,
"filename": "scarlet_shark_python-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1aead0fae25c685ec275cff3745ef663",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17683,
"upload_time": "2023-05-02T10:54:45",
"upload_time_iso_8601": "2023-05-02T10:54:45.776287Z",
"url": "https://files.pythonhosted.org/packages/06/a3/4647ec86c28b569dee1e7eb5cf16878358bdf085b9337bd97309f929732b/scarlet_shark_python-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a2dbd10a3705594bf94d0b6908ed2818c38bdf7f5179d37a04a7d47264be3e5",
"md5": "b92b5e3a9acb05e48fba4a5fad9540c0",
"sha256": "407034ad63f3c7a9cc7a5d599dbca1322507fc7fc2714ec63f2fad83a4f6ca77"
},
"downloads": -1,
"filename": "scarlet-shark-python-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "b92b5e3a9acb05e48fba4a5fad9540c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16706,
"upload_time": "2023-05-02T10:54:47",
"upload_time_iso_8601": "2023-05-02T10:54:47.293376Z",
"url": "https://files.pythonhosted.org/packages/9a/2d/bd10a3705594bf94d0b6908ed2818c38bdf7f5179d37a04a7d47264be3e5/scarlet-shark-python-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-02 10:54:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PiRogueToolSuite",
"github_project": "scarlet-shark-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.29.0"
]
]
}
],
"lcname": "scarlet-shark-python"
}
JSON
