Iris Investigate API¶
Overview¶
The Iris Investigate API enables deep domain analysis and infrastructure mapping at human scale. It provides comprehensive domain profiles with dozens of attributes, pivot searches across multiple data points, and guided pivot counts to identify meaningful connections.
For a complete overview of Iris Investigate capabilities and use cases, see the Iris Overview.
Consult the OpenAPI reference for the Iris API suite for additional detail.
Key characteristics of the Iris Investigate API include:
- Dozens of domain name attributes on every result, including:
- Domain risk scores from proximity and threat profile algorithms
- RDAP, WHOIS, IP, active DNS, website & SSL data
- Counts of connected domains on most attributes
- Unified API endpoint for both domain profiles & pivot searches
- Support for batch processing and pagination
- Search by identity, IP, name server, mail server, SSL certificate, & more
- Offered with interactive Iris web app
Documentation Structure¶
This documentation is organized into the following sections:
- Quick Start: Get started with authentication and your first API calls
- Concepts: Understand core concepts like guided pivots, pagination, and quota consumption
- Search: Learn about search parameters and filtering capabilities
- How-To Guides: Step-by-step guides for common tasks
API Reference¶
For complete API specifications and interactive documentation:
- OpenAPI Specification - Complete YAML specification for all Iris APIs
- SwaggerHub Interactive Docs - Test endpoints and explore the API interactively
- Authentication - Authentication methods and setup
- Rate Limits - Quota policies and limits
- Error Codes - Complete error code reference
Next Steps¶
- New to the API? Start with the Quick Start guide
- Need to understand how pivots work? See Guided Pivots
- Looking for specific parameters? Check the Search Parameters documentation