URLScans API Documentation
Integrate URLScans's phishing detection and brand protection capabilities into your applications, workflows, and security tools.
Real-time Detection
Get instant phishing detection results with sub-second response times. Perfect for real-time security checks.
Enterprise Grade
Built for scale with rate limiting, authentication, and comprehensive error handling. Production-ready infrastructure.
RESTful API
Simple, intuitive REST API with JSON responses. Easy integration with any programming language or framework.
Comprehensive Docs
Detailed documentation with code examples, authentication guides, and best practices for integration.
API Endpoints
/api/scan?url=example.comScan a URL, domain, or IP address for phishing threats. Requires X-API-Key (public web key or registered user key).
/api/db/lookups?limit=20List recent scan records from the database (newest first). Requires X-API-Key.
/api/categoriesJSON body with url fieldGet website content category signals for a URL. Requires X-API-Key.
/api/whois?domain=example.comGet WHOIS/RDAP data for a domain. Requires X-API-Key.
Quick Start Example
// Scan a URL, domain, or IP (include your API key)
const response = await fetch(
'https://urlscans.com/api/scan?url=' + encodeURIComponent('example.com'),
{
headers: {
'X-API-Key': 'YOUR_API_KEY',
},
}
);
const result = await response.json();
console.log(result.verdict.verdict); // 'safe' | 'suspicious' | 'malicious'
console.log(result.verdict.score); // risk score
console.log(result.verdict.categories); // Threat categories
console.log(result.urlScansAnalysis.emailAuth); // SPF / DMARC / DKIM (when checked)
console.log(result.urlScansAnalysis.cloudflareCategories); // Cloudflare Radar categoriesAuthentication
Endpoints above require a valid X-API-Key header. The public site sends this key from the browser automatically; scripts, servers, and integrations must set the header themselves. Register for a free API key (1,000 scans/month).
Ready to Integrate?
Start using URLScans API today or contact us for enterprise integration support.