{ "openapi": "3.0.1", "info": { "title": "DomScan Domain Intelligence API for Apify", "description": "Run domain intelligence checks for up to 100 domains or URLs. Get one structured result per target for WHOIS, DNS, health, SSL, technology, reputation, subdomains, valuation, or availability, with explicit status and the complete DomScan response.", "version": "1.0", "x-build-id": "dYiuku6TG7iSPwP2W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/narrative_karat~domscan-domain-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-narrative_karat-domscan-domain-intelligence", "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/narrative_karat~domscan-domain-intelligence/runs": { "post": { "operationId": "runs-sync-narrative_karat-domscan-domain-intelligence", "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/narrative_karat~domscan-domain-intelligence/run-sync": { "post": { "operationId": "run-sync-narrative_karat-domscan-domain-intelligence", "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": [ "targets", "operation" ], "properties": { "targets": { "title": "Domains or URLs", "minItems": 1, "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Domains or public HTTP(S) URLs to analyze. URLs are normalized to their hostname except for technology detection, which can use the full URL.", "items": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "operation": { "title": "Operation", "enum": [ "overview", "whois", "dns", "health", "ssl-audit", "technology", "reputation", "subdomains", "valuation", "availability" ], "type": "string", "description": "The DomScan analysis to run for every target.", "default": "overview" }, "dnsRecordType": { "title": "DNS record type", "enum": [ "A", "AAAA", "MX", "NS", "TXT", "SOA", "CNAME", "CAA", "PTR", "SRV" ], "type": "string", "description": "Used only by the DNS records operation.", "default": "A" }, "technologyMode": { "title": "Technology scan mode", "enum": [ "fast", "rendered", "deep" ], "type": "string", "description": "Used only by technology detection. Rendered and deep scans inspect more page behavior and cost more than fast scans.", "default": "fast" }, "technologyMaxPages": { "title": "Maximum pages for a deep scan", "minimum": 1, "maximum": 5, "type": "integer", "description": "Used only by deep technology detection. Other modes always inspect one page.", "default": 3 }, "subdomainVerify": { "title": "Verify discovered subdomains", "type": "boolean", "description": "Used only by subdomain discovery. Checks DNS for returned hostnames.", "default": false }, "subdomainLimit": { "title": "Maximum subdomains", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Used only by subdomain discovery.", "default": 500 }, "preferCache": { "title": "Prefer cached evidence", "type": "boolean", "description": "Use compatible cached evidence when the selected operation supports it.", "default": false }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of targets processed at the same time. Lower this value when running large or expensive scans.", "default": 3 } } }, "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 } } } } } } } } } }