Developer API

Build with the Openseye API

Integrate threat detection and automated takedowns directly into your applications with our comprehensive REST API.

API Key Authentication

Secure your API requests with API keys that you can generate and rotate from your dashboard.

Rate Limiting

Fair usage limits ensure reliable performance. Professional plans include higher rate limits.

Webhooks

Receive real-time notifications for threat events via configurable webhook endpoints.

Low Latency

Our API is optimized for performance with response times under 100ms for most requests.

Quick Start

Get started with the Openseye API in minutes

Example Request
curl -X GET "https://api.openseye.com/v1/threats" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Example Response
{
  "data": [
    {
      "id": "threat_abc123",
      "type": "phishing",
      "domain": "example-phishing.com",
      "status": "active",
      "severity": "high",
      "detected_at": "2024-01-15T10:30:00Z",
      "target_brand": "Your Company"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 20
  }
}

API Endpoints

Core endpoints for threat detection and management

GET/api/v1/threatsList all detected threats with filtering and pagination
GET/api/v1/threats/:idGet detailed information about a specific threat
POST/api/v1/threats/:id/takedownInitiate a takedown request for a threat
GET/api/v1/domainsList monitored domains and their status
POST/api/v1/domainsAdd a new domain to monitoring
GET/api/v1/alertsRetrieve alert history and status
POST/api/v1/webhooksConfigure webhook endpoints for real-time notifications
GET/api/v1/reportsGenerate and download threat reports