API Documentation
Welcome to urlDNA api documentation.
Before start to using the APIs remeber to create a FREE account to get the API key. If you already have an account, please see your profile page to find out the API key.
Quota Limits
You can make up to 10 APIs request daily for search and show scan, but you can create unlimited new scan!
If you want increase your daily API quota limit, please contact us
User agents
Get list of all available user agents that you can use for your scan
Request
Response attributes
| Attribute | Description |
|---|---|
| browser | Browser or operating system |
| device | DESKTOP or MOBILE |
| share | Usage score |
| user_agent | HTTP user agent |
Response
Viewports
Get list of all available viewports that you can use for your scan
Request
Response attributes
| Attribute | Description |
|---|---|
| device | DESKTOP or MOBILE |
| width | Screen width |
| height | Screen height |
Response
Scan
Get the scan object
Request
Response attributes
| Attribute | Description |
|---|---|
| scan | Contains submitted attributes and URL attributes (domain, protocol etc) |
| certificate | Contains certificate information if the protocol is HTTPS |
| console_messages | List of all console messages |
| cookies | List of all cookies (name, value, and security) |
| dom | Source HTML from the page |
| favicon | Contains favicon information(hash, url to download etc) |
| http_transactions | List of all HTTP transaction |
| ip_address | Contains all information about the IP address |
| malicious | If present the URL may be malicious (BETA function) |
| page | Contains meta tags, headers, and plain text |
| scan_details | Contains additional information about the scan |
| techonoglies | Contains the URL for downloading the screenshot image |
| technologies | List of all detected technologies |
Response
New scan
Scan new URL.
When you submit a new scan it has been pushed into a tasks queue.
You have to grab the scan_id and use the GET scan API endpoint to see the scan status.
When the scan status is DONE it's ready to see all attributes.
This might take a few minutes, depending on system loads.
Request attributes
| Attribute | Description | Required | Default |
|---|---|---|---|
| url | URL to scan, it should contain HTTP or HTTPS protocol | True | |
| device | Device to use for scraping, DESKTOP or MOBILE | False | DESKTOP |
| user_agent | Must be one of provided user agents | False | Mozilla/5.0 (Windows NT 10.0;Win64;x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.114 Safari/537.36 |
| width | Screen width, must be one of valid viewports | False | 1920 |
| height | Screen height, must be one of valid viewports | False | 1080 |
| waiting_time | Seconds to waitafter page is loaded, must be between 3 and 15 | False | 5 |
| private_scan | Set scan as private, only you can see the scan | False | false |
Request
Response attributes
| Attribute | Description |
|---|---|
| id | Scan ID |
| status | Current scan status, could be: PENDING, RUNNING, DONE or ERROR |
| submitted_date | Date of submission |
Response
Search
You can run searches using free language text or using Custom Query Language, please see the info in the search navbar.
The results contain only a list of scans with essential attributes.
Request attributes
| Attribute | Description | Required | Default |
|---|---|---|---|
| query | Query text | True |
Request
Response