Skip to main content

The DNA test for websites.

Project description


urlDNA Logo

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.

forthebadge forthebadge

GitHub license



  • 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.


To install the urlDNA Python package, use pip:

pip install urldna



First, import the package and initialize the client with your API key:

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.

# Create a scan for a URL
url = ''
scan_result = client.create_scan(url)
print(f'Scan ID: {}')


Perform a search query using Custom Query Language to find relevant data.

# Perform a search query
query = 'domain LIKE'
search_results =

Get Scan

Retrieve the results of a previously initiated scan using its scan ID.

# Get scan results
scan_id = 'your_scan_id'
scan_result = client.get_scan(scan_id)


List of all available viewports (device, height, width)

viewports = client.viewports()


List of all available user agents (browser, device, user_agent)

user_agents = client.user_agents()

API Reference

for all API details, please viti the API Documentation page.


  • Initializes the client with the provided API key. Copy your API key from Profile page.


  • 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.


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.


This project is licensed under the MIT License. See the LICENSE file for details.


For any issues or questions, please contact


Thank you for using urlDNA! We hope our tool helps you gain valuable insights into your URLs and online presence.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

urldna-0.0.4.tar.gz (9.9 kB view hashes)

Uploaded Source

Built Distribution

urlDNA-0.0.4-py3-none-any.whl (19.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page