Feature Request: REST API Interface for OSINT Searches

Summary

I'd like to propose extending Maigret to include a REST API interface, allowing external applications to query Maigret's OSINT capabilities programmatically via API keys. This would position Maigret as an OSINT hub that other services can integrate with.

Current State

Currently, Maigret is primarily a command-line tool and web interface. To use it from external applications, they must either:

• Invoke the CLI directly
• Embed a web interface
• Implement their own OSINT logic

Proposed Solution

Add a REST API layer that:

• Accepts authenticated HTTP requests with usernames/identities to search
• Returns structured OSINT results in JSON format
• Supports API key authentication for rate limiting and access control
• Maintains all existing site checks and detection logic

Use Cases

1. Third-party OSINT integrations: Services can add Maigret as a data provider without maintaining their own username-search infrastructure
2. Internal tools: Organizations can query Maigret from internal applications and dashboards
3. Scalable deployments: The API allows Maigret to be deployed as a microservice for distributed systems

Implementation Notes

I'm offering to contribute to this feature. Before I proceed, I'd like feedback from maintainers on:

• Whether this aligns with the project's vision
• Any architectural preferences or constraints
• Where the API code should live in the project structure

This would be additive: the CLI and web interface would remain unchanged.

Related

• Current interfaces: CLI tool, web interface