{ "openapi": "3.0.1", "info": { "title": "Typosquat & Lookalike Domain Detector with Threat Signals", "description": "Find typosquatted and lookalike domains impersonating your brand: typo, homoglyph, bitsquat, TLD-swap and combosquat variants, checked against live registries and enriched with registrar, DNS, MX and TLS data to separate real threats from parked domains. Unregistered variants are never charged.", "version": "0.1", "x-build-id": "XdLkJE8L9nuhKSTWP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cottony_brittlegill~domain-typosquat-detector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cottony_brittlegill-domain-typosquat-detector", "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/cottony_brittlegill~domain-typosquat-detector/runs": { "post": { "operationId": "runs-sync-cottony_brittlegill-domain-typosquat-detector", "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/cottony_brittlegill~domain-typosquat-detector/run-sync": { "post": { "operationId": "run-sync-cottony_brittlegill-domain-typosquat-detector", "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": { "brandDomains": { "title": "Brand domains to protect", "type": "array", "description": "Domains you own or are authorized to monitor. Each one is expanded into typosquat and lookalike candidates. Accepts bare domains or URLs.", "items": { "type": "string" } }, "brandDomainsText": { "title": "Brand domains (paste as text)", "type": "string", "description": "Alternative to the list above: paste domains separated by newlines or commas. Merged with the list." }, "variantKinds": { "title": "Variant algorithms", "type": "array", "description": "Which squatting techniques to generate. Leave empty to use all of them: omission, insertion, repetition, replacement, transposition, hyphenation, subdomain, addition, vowelswap, bitsquatting, homoglyph, tldswap, combosquat.", "items": { "type": "string", "enum": [ "omission", "insertion", "repetition", "replacement", "transposition", "hyphenation", "subdomain", "addition", "vowelswap", "bitsquatting", "homoglyph", "tldswap", "combosquat" ] } }, "tlds": { "title": "TLDs for TLD-swap variants", "type": "array", "description": "Suffixes to test with the same brand label (e.g. your-brand.net, your-brand.io). Leave empty for a sensible default set of the 20 most abused TLDs.", "items": { "type": "string" } }, "keywords": { "title": "Combosquat keywords", "type": "array", "description": "Words combined with your brand name (e.g. brand-login.com, secure-brand.com). Leave empty for the default set: login, secure, account, support, verify, billing, help, mail.", "items": { "type": "string" } }, "verifyMode": { "title": "Verification mode", "enum": [ "dns-first", "rdap-all" ], "type": "string", "description": "dns-first (recommended): resolve DNS first and only query the registry for variants that are actually delegated — fast, cheap, respectful of registry rate limits. rdap-all: query the registry for every single variant — also catches registered-but-undelegated squats, but is far slower and much more likely to hit registry rate limits.", "default": "dns-first" }, "includeSsl": { "title": "Check TLS certificates", "type": "boolean", "description": "For registered lookalikes that resolve, fetch the TLS certificate (issuer, subject, validity). A valid certificate on a lookalike is a strong sign it is built to be convincing in a browser.", "default": true }, "onlyRegistered": { "title": "Output registered lookalikes only", "type": "boolean", "description": "On (recommended): the dataset contains only lookalikes that actually exist. Off: every candidate checked is written out, including the unregistered ones, as a full audit trail. Unregistered candidates are never charged either way.", "default": true }, "maxVariantsPerDomain": { "title": "Max variants per brand domain", "minimum": 10, "maximum": 3000, "type": "integer", "description": "Upper bound on generated candidates per brand domain. The budget is spread evenly across the enabled algorithms so you always get homoglyph and TLD-swap coverage, not just hundreds of one type.", "default": 400 }, "maxFindings": { "title": "Max registered lookalikes per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard ceiling on billable findings for this run. The scan stops once it is reached, so a run can never cost more than this number times the per-finding price.", "default": 500 }, "perRegistryConcurrency": { "title": "Per-registry concurrency", "minimum": 1, "maximum": 3, "type": "integer", "description": "How many registry (RDAP/WHOIS) queries may be in flight against one registry at a time. Kept low to respect registry rate limits (RFC 7480).", "default": 2 }, "globalConcurrency": { "title": "Global concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many candidate domains to check in parallel across all registries. Higher is faster but uses more memory and more network sockets.", "default": 10 }, "lookupTimeoutMs": { "title": "Per-lookup timeout (ms)", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "How long to wait for each individual DNS, RDAP, WHOIS or TLS lookup before giving up on it (milliseconds).", "default": 8000 } } }, "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 } } }, "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 } } } } } } } } } }