{ "openapi": "3.0.1", "info": { "title": "Domain & Email Breach Checker — Have I Been Pwned", "description": "Check if domains or emails appear in known data breaches. Uses Have I Been Pwned database. Returns breach names, dates, data types exposed (passwords, emails, phone numbers). Monitor for new breaches affecting your organization.", "version": "0.4", "x-build-id": "hvnnNcp2yTO9uobyj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gochujang~domain-breach-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gochujang-domain-breach-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/gochujang~domain-breach-checker/runs": { "post": { "operationId": "runs-sync-gochujang-domain-breach-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/gochujang~domain-breach-checker/run-sync": { "post": { "operationId": "run-sync-gochujang-domain-breach-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "domains": { "title": "Domains to check", "type": "array", "description": "List of domains to check for breaches (e.g. adobe.com, linkedin.com). Requires hibpApiKey.", "items": { "type": "string" } }, "emails": { "title": "Email addresses to check", "type": "array", "description": "Email addresses to check against HIBP. Requires hibpApiKey.", "items": { "type": "string" } }, "hibpApiKey": { "title": "HIBP API Key", "type": "string", "description": "Have I Been Pwned API key. Required for domain and email checking. Get one at haveibeenpwned.com/API/Key ($4/month for first 1000 queries)." }, "checkAllBreaches": { "title": "Include full breach database", "type": "boolean", "description": "Fetch and return the full HIBP breach database (no API key required). Useful for security research and awareness.", "default": true }, "dataClasses": { "title": "Filter by data types exposed", "type": "array", "description": "Only include breaches that exposed these data types. Leave empty to include all.", "items": { "type": "string", "enum": [ "Passwords", "Email addresses", "Phone numbers", "Physical addresses", "Credit cards", "Names", "Usernames", "Dates of birth", "Social media profiles", "IP addresses", "Geographic locations", "Government issued IDs", "Bank account numbers", "Health records", "Sexual orientations" ] } }, "breachAfterDate": { "title": "Only breaches after date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Filter to only show breaches discovered/added after this date. Format: YYYY-MM-DD" }, "alertNewBreaches": { "title": "Alert on new breaches", "type": "boolean", "description": "Use named KVS to track breach counts across runs; alert when new breaches detected.", "default": false }, "telegramBotToken": { "title": "Telegram Bot Token", "type": "string", "description": "Telegram bot token for sending alerts (e.g. 123456:ABC-DEF...)." }, "telegramChatId": { "title": "Telegram Chat ID", "type": "string", "description": "Telegram chat ID to send alerts to (e.g. -1001234567890)." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }