{ "openapi": "3.0.1", "info": { "title": "Brand Impersonation Domain Monitor: Look-alikes", "description": "Find look-alike domains and TLS certificates that impersonate your brand: typos, homoglyphs and \"brand-login\" names, with registration date, registrar, DNS, mail servers, a login or payment form check and a 0-100 risk score. Monitor mode reports only new ones.", "version": "1.0", "x-build-id": "86J3AElchWxfRrlbr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/offerastudio~brand-impersonation-domain-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-offerastudio-brand-impersonation-domain-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/offerastudio~brand-impersonation-domain-monitor/runs": { "post": { "operationId": "runs-sync-offerastudio-brand-impersonation-domain-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/offerastudio~brand-impersonation-domain-monitor/run-sync": { "post": { "operationId": "run-sync-offerastudio-brand-impersonation-domain-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": [ "brands" ], "properties": { "brands": { "title": "Brands", "type": "array", "description": "Each brand has a \"name\" and the \"domains\" you officially own, e.g. [{\"name\": \"Acme\", \"domains\": [\"acme.com\", \"acme.shop\"]}]. Official domains are never reported. Up to 50 brands." }, "extraKeywords": { "title": "Extra keywords", "type": "array", "description": "Words that phishers add to your brand name in your market, e.g. refund, rewards, kundendienst. They are combined with the brand name, and added to the built-in list (login, support, secure, account, verify ...).", "items": { "type": "string" } }, "tlds": { "title": "TLDs to try", "type": "array", "description": "Other top-level domains to try with the brand name, without the dot. Default: com, net, org, co, io, shop, online, app, xyz, info, store, site.", "items": { "type": "string" } }, "checkCertificates": { "title": "Search certificate logs", "type": "boolean", "description": "Also search public certificate transparency logs (crt.sh) for certificates that contain your brand name, which finds look-alikes this Actor would never guess. crt.sh can be slow; partial results are fine.", "default": true }, "mode": { "title": "Mode", "enum": [ "all", "monitor" ], "type": "string", "description": "All: report every flagged domain. Monitor: report only domains not reported in an earlier run with the same monitor name.", "default": "all" }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Names this watch (monitor mode). Runs with the same name share one memory of reported domains, kept in a named key-value store." }, "maxCandidatesPerBrand": { "title": "Max candidates per brand", "minimum": 10, "maximum": 2000, "type": "integer", "description": "How many generated look-alike names are checked per brand (typos, homoglyphs, keywords, TLD swaps, interleaved so each kind is covered). Certificate hits come on top, up to the same number. Default 300, maximum 2,000.", "default": 300 }, "includeUnregistered": { "title": "Also list unregistered candidates", "type": "boolean", "description": "Add a free row for each candidate that is not registered (useful to see which names you could still buy defensively). Default off.", "default": false } } }, "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 } } } } } } } } } }