{ "openapi": "3.0.1", "info": { "title": "Typosquat & Brand Domain Monitor", "description": "Generate the lookalike domains of your brand, find out which are already registered, and see which of those can host a website or send email. Run it on a schedule and get alerted the day a new lookalike is registered, which is usually days before a phishing campaign starts.", "version": "0.1", "x-build-id": "mgYnmh570UzPZX4zH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arched_friend~typosquat-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arched_friend-typosquat-monitor", "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/arched_friend~typosquat-monitor/runs": { "post": { "operationId": "runs-sync-arched_friend-typosquat-monitor", "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/arched_friend~typosquat-monitor/run-sync": { "post": { "operationId": "run-sync-arched_friend-typosquat-monitor", "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", "required": [ "domains" ], "properties": { "domains": { "title": "Your brand domains", "type": "array", "description": "The domains you want to protect, one per line, for example yourbrand.com. Lookalikes are generated from each one.", "items": { "type": "string" } }, "strategies": { "title": "Typo strategies", "type": "array", "description": "Which lookalike patterns to generate: omission, transposition, repetition, substitution, homoglyph, hyphenation.", "default": [ "omission", "transposition", "repetition", "substitution", "homoglyph", "hyphenation" ], "items": { "type": "string" } }, "extraTlds": { "title": "Also check these extensions", "type": "array", "description": "Check your exact brand name under these extensions too. A same-name different-extension registration is the commonest squat of all.", "default": [ "com", "net", "org", "co", "io", "app", "shop", "online", "site" ], "items": { "type": "string" } }, "includeAffixes": { "title": "Include prefixed and suffixed names", "type": "boolean", "description": "Also generate names like login-yourbrand.com and yourbrand-secure.com, which is what phishing pages usually use.", "default": true }, "affixWords": { "title": "Words to bolt on", "type": "array", "description": "The words used to build those names.", "default": [ "login", "secure", "account", "support", "help", "billing", "pay", "verify", "update", "mail", "app", "my", "portal", "signin" ], "items": { "type": "string" } }, "maxCandidatesPerDomain": { "title": "Maximum candidates per brand", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper limit on how many lookalikes to generate and check for each brand domain.", "default": 800 }, "onlyRegistered": { "title": "Only registered lookalikes", "type": "boolean", "description": "Return only domains that actually exist. Turn this off to see which lookalikes are still available for you to register defensively.", "default": true }, "onlyChanged": { "title": "Only what changed since last run", "type": "boolean", "description": "Return only newly registered lookalikes and ones that just gained a website or mail records. Turn this on for scheduled monitoring.", "default": false }, "lookupRegistrationDetails": { "title": "Look up registrar and registration date", "type": "boolean", "description": "Query RDAP for each registered lookalike to get its registrar and age. A freshly registered lookalike is the highest-risk kind.", "default": true }, "concurrency": { "title": "Parallel DNS lookups", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many candidates to check at once.", "default": 25 }, "requestTimeoutSecs": { "title": "Timeout per lookup", "minimum": 5, "maximum": 60, "type": "integer", "description": "How long to wait for each registration lookup.", "default": 15 } } }, "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 } } } } } } } } } }