# scarlet-shark-python
Scarlet Shark REST API Python client.
## Installation
```
pip install scarlet-shark-client
```
## Usage example
```python
from scarlet_shark_client.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-client",
"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/90/05/50821b67f46bf8bb1d38c6e993b7ee536d0a00353c7ecde1d03e6f63ffd7/scarlet-shark-client-1.0.5.tar.gz",
"platform": null,
"description": "# scarlet-shark-python\nScarlet Shark REST API Python client.\n\n## Installation\n```\npip install scarlet-shark-client\n```\n\n## Usage example\n\n```python\nfrom scarlet_shark_client.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.5",
"project_urls": {
"Homepage": "https://github.com/PiRogueToolSuite/scarlet-shark-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e38df48060cf89c785ba8d0ae0a1819c2b2b1eeb112398667c27973365583fcb",
"md5": "75aa0a901c080a5cd64dd3589c441558",
"sha256": "8508d9f1768279dec49221b7cf03cafd8a4f9e41d2920be1adcb944362848720"
},
"downloads": -1,
"filename": "scarlet_shark_client-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "75aa0a901c080a5cd64dd3589c441558",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17701,
"upload_time": "2023-05-23T09:30:53",
"upload_time_iso_8601": "2023-05-23T09:30:53.675340Z",
"url": "https://files.pythonhosted.org/packages/e3/8d/f48060cf89c785ba8d0ae0a1819c2b2b1eeb112398667c27973365583fcb/scarlet_shark_client-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "900550821b67f46bf8bb1d38c6e993b7ee536d0a00353c7ecde1d03e6f63ffd7",
"md5": "7aabcc13681f8f279c7cb3359d64b9ca",
"sha256": "b8ceec9026c37dbcdc89cda0cb3574a409d88781d50af993dc33773f04138a6a"
},
"downloads": -1,
"filename": "scarlet-shark-client-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "7aabcc13681f8f279c7cb3359d64b9ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16758,
"upload_time": "2023-05-23T09:30:55",
"upload_time_iso_8601": "2023-05-23T09:30:55.557773Z",
"url": "https://files.pythonhosted.org/packages/90/05/50821b67f46bf8bb1d38c6e993b7ee536d0a00353c7ecde1d03e6f63ffd7/scarlet-shark-client-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-23 09:30:55",
"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-client"
}
JSON
