The new urlscan Documentation Hub
We are excited to announce the launch of the new urlscan Documentation Hub. This centralized platform provides comprehensive, searchable resources for both urlscan.io and urlscan Pro.
Some of the API endpoints in the new Documentation Hub
What’s New
Our new Documentation Hub improves on our previous documentation with:
- Unified Platform Documentation: Coverage for both urlscan.io and urlscan Pro in one location
- Advanced Search: Quickly find information across all documentation
- Interactive OpenAPI Documentation: Complete API reference with live testing capabilities
- AI-Powered Assistant: Get instant answers and code examples from our documentation chatbot
- Comprehensive Guides: Step-by-step tutorials for common use cases
Previously, documentation was fragmented across multiple locations, creating challenges for users trying to understand platform capabilities and navigate between different systems.
Interactive OpenAPI Documentation
The complete OpenAPI specification provides:
- Live API Testing: Execute calls directly with your API keys
- Request/Response Examples: Real-world examples for every endpoint
- Parameter Documentation: Detailed descriptions of all parameters
- Error Code Reference: Comprehensive error handling information
- Code Generation: Generate client code in multiple languages
- Platform Indicators: Clear labeling of endpoint availability
OpenAPI documentation with request / response bodies for all API endpoints
Centralized Knowledge Base
The Documentation Hub covers:
- urlscan.io: Free scanning services, basic API access, and community features
- urlscan Pro: Advanced scanning, enhanced APIs, and monitoring
Enhanced search helps you find API endpoints, examples, or feature comparisons instantly. Our AI assistant answers questions about functionality, explains concepts, and generates code examples tailored to your development needs.
AI Search and code generation based on our documentation
Community-Driven Improvements
Enhanced feedback mechanisms allow users to:
- Report documentation issues directly from any page
- Suggest improvements and additional content
- Rate documentation helpfulness
- Contribute examples and use cases
Availability
The urlscan Documentation Hub is available immediately at docs.urlscan.io. Explore the new hub and provide feedback to help us improve it further.
More on urlscan Pro
If you want to learn about the urlscan Pro platform and how it might be valuable for your organization feel free to reach out to us! We offer free trials with no strings attached. We would be happy to give you a passionate demo of what our platform can do for you. Reach out to us at sales@urlscan.io.