# urlDNA
urlDNA is a powerful tool for comprehensive URL analysis, advanced brand monitoring, phishing detection, and custom query capabilities. This Python package allows users to interact with the urlDNA API seamlessly through Python.
[](https://forthebadge.com) [](https://forthebadge.com)
[](LICENSE)
[Homepage](https://urldna.io/)
## Features
- **Create Scan**: Initiate a new scan for a given URL.
- **Search**: Perform a search query to find relevant data.
- **Get Scan**: Retrieve the results of a all scans.
- **Viewports**: All available viewports by device.
- **User Agents**: All available user agents.
- **Fast Check**: Check if an URL is CLEAN or MALICIOUS (beta).
## Installation
To install the urlDNA Python package, use pip:
```bash
pip install urldna
```
## Usage
### Installation
First, import the package and initialize the client with your API key:
```python
from urldna import UrlDNA
# Initialize the client with your API key
api_key = 'YOUR_API_KEY'
client = UrlDNA(api_key)
```
## Create Scan
Initiate a new scan for a given URL to analyze its content and metadata.
```python
# Create a scan for a URL
url = 'https://example.com'
scan_result = client.create_scan(url)
print(f'Scan ID: {scan_result.scan.id}')
```
## Search
Perform a search query using Custom Query Language to find relevant data.
```python
# Perform a search query
query = 'domain LIKE google.com'
search_results = client.search(query)
print(search_results)
```
## Get Scan
Retrieve the results of a previously initiated scan using its scan ID.
```python
# Get scan results
scan_id = 'your_scan_id'
scan_result = client.get_scan(scan_id)
print(scan_result)
```
## Viewports
List of all available viewports (device, height, width)
```python'
viewports = client.viewports()
print(viewports)
```
## Viewports
List of all available user agents (browser, device, user_agent)
```python'
user_agents = client.user_agents()
print(user_agents)
```
## Fast check
Check if an URL is CLEAN or MALICIOUS (beta).
```python'
fast_check = client.fast_check("https://google.com")
print(fast_check)
```
# API Reference
for all API details, please viti the [API Documentation](https://urldna.io/api) page.
`UrlDNA(api_key)`
- Initializes the client with the provided API key. Copy your API key from [Profile](https://urldna.io/profile) page.
## Methods
- `create_scan(url, device='DESKTOP', width=1920, height=1080, user_agent=None, waiting_time=5, private_scan=False)`: Initiates a scan for the given URL and returns a scan ID.
- `search(query)`: Performs a search based on the given query and returns the results.
- `get_scan(scan_id)`: Retrieves the results of the scan identified by the given scan ID.
# Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a new Pull Request.
# License
This project is licensed under the MIT License. See the LICENSE file for details.
# Support
For any issues or questions, please contact [urldna@urldna.io](mailto:urldna@urldna.io).
# Acknowledgements
Thank you for using urlDNA! We hope our tool helps you gain valuable insights into your URLs and online presence.
Raw data
{
"_id": null,
"home_page": "https://urldna.io",
"name": "urlDNA",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "web scraping, website analysis, url scan",
"author": "urlDNA",
"author_email": "urldna@urldna.io",
"download_url": "https://files.pythonhosted.org/packages/ad/ee/babb164c3ddaeab13a56632ca0586c594a8bedf9283c89b5a1a19bdc7f41/urldna-0.0.10.tar.gz",
"platform": null,
"description": "# urlDNA\n\n\n\nurlDNA is a powerful tool for comprehensive URL analysis, advanced brand monitoring, phishing detection, and custom query capabilities. This Python package allows users to interact with the urlDNA API seamlessly through Python.\n\n\n\n[](https://forthebadge.com) [](https://forthebadge.com)\n\n[](LICENSE)\n\n[Homepage](https://urldna.io/)\n\n## Features\n\n- **Create Scan**: Initiate a new scan for a given URL.\n- **Search**: Perform a search query to find relevant data.\n- **Get Scan**: Retrieve the results of a all scans.\n- **Viewports**: All available viewports by device.\n- **User Agents**: All available user agents.\n- **Fast Check**: Check if an URL is CLEAN or MALICIOUS (beta).\n\n## Installation\n\nTo install the urlDNA Python package, use pip:\n\n```bash\npip install urldna\n```\n\n## Usage\n### Installation\nFirst, import the package and initialize the client with your API key:\n\n```python\nfrom urldna import UrlDNA\n\n# Initialize the client with your API key\napi_key = 'YOUR_API_KEY'\nclient = UrlDNA(api_key)\n```\n\n## Create Scan\nInitiate a new scan for a given URL to analyze its content and metadata.\n\n```python\n# Create a scan for a URL\nurl = 'https://example.com'\nscan_result = client.create_scan(url)\nprint(f'Scan ID: {scan_result.scan.id}')\n```\n\n## Search\nPerform a search query using Custom Query Language to find relevant data.\n\n```python\n# Perform a search query\nquery = 'domain LIKE google.com'\nsearch_results = client.search(query)\nprint(search_results)\n```\n\n## Get Scan\nRetrieve the results of a previously initiated scan using its scan ID.\n\n```python\n# Get scan results\nscan_id = 'your_scan_id'\nscan_result = client.get_scan(scan_id)\nprint(scan_result)\n```\n\n## Viewports\nList of all available viewports (device, height, width)\n\n```python'\nviewports = client.viewports()\nprint(viewports)\n```\n\n## Viewports\nList of all available user agents (browser, device, user_agent)\n\n```python'\nuser_agents = client.user_agents()\nprint(user_agents)\n```\n\n## Fast check\nCheck if an URL is CLEAN or MALICIOUS (beta).\n\n```python'\nfast_check = client.fast_check(\"https://google.com\")\nprint(fast_check)\n```\n\n# API Reference\n\nfor all API details, please viti the [API Documentation](https://urldna.io/api) page.\n\n`UrlDNA(api_key)`\n- Initializes the client with the provided API key. Copy your API key from [Profile](https://urldna.io/profile) page.\n\n## Methods\n- `create_scan(url, device='DESKTOP', width=1920, height=1080, user_agent=None, waiting_time=5, private_scan=False)`: Initiates a scan for the given URL and returns a scan ID.\n- `search(query)`: Performs a search based on the given query and returns the results.\n- `get_scan(scan_id)`: Retrieves the results of the scan identified by the given scan ID.\n\n# Contributing\nContributions are welcome! Please follow these steps to contribute:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Commit your changes (`git commit -am 'Add new feature'`).\n4. Push to the branch (`git push origin feature-branch`).\n5. Create a new Pull Request.\n\n# License\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n# Support\nFor any issues or questions, please contact [urldna@urldna.io](mailto:urldna@urldna.io).\n\n# Acknowledgements\nThank you for using urlDNA! We hope our tool helps you gain valuable insights into your URLs and online presence.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The DNA test for websites.",
"version": "0.0.10",
"project_urls": {
"Homepage": "https://urldna.io"
},
"split_keywords": [
"web scraping",
" website analysis",
" url scan"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f24dbe721088148388eacf2d17ffa98d123d89ee3f86847dbe99c184ab7ef798",
"md5": "6e8ea9414ff2074c37bef6744384b6db",
"sha256": "d877aa6cdcef645bd082d72b94a00471e4d38fac75066c353b43f9062bbd46de"
},
"downloads": -1,
"filename": "urlDNA-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e8ea9414ff2074c37bef6744384b6db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21198,
"upload_time": "2025-02-16T21:04:42",
"upload_time_iso_8601": "2025-02-16T21:04:42.887345Z",
"url": "https://files.pythonhosted.org/packages/f2/4d/be721088148388eacf2d17ffa98d123d89ee3f86847dbe99c184ab7ef798/urlDNA-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "adeebabb164c3ddaeab13a56632ca0586c594a8bedf9283c89b5a1a19bdc7f41",
"md5": "69ed69461cb1aad3082bf7b502bfe445",
"sha256": "e76cd0abf14e709b5b34dd86a55aced2844ca996ce3147d63c803efe3ff8fa04"
},
"downloads": -1,
"filename": "urldna-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "69ed69461cb1aad3082bf7b502bfe445",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10861,
"upload_time": "2025-02-16T21:04:44",
"upload_time_iso_8601": "2025-02-16T21:04:44.624485Z",
"url": "https://files.pythonhosted.org/packages/ad/ee/babb164c3ddaeab13a56632ca0586c594a8bedf9283c89b5a1a19bdc7f41/urldna-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-16 21:04:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "urldna"
}
JSON