{ "openapi": "3.0.1", "info": { "title": "SimilarWeb API (Scraper)", "description": "Extract SimilarWeb website analytics: traffic, rankings, engagement, traffic sources, top keywords, and top countries. Bulk domains in parallel.", "version": "1.1", "x-build-id": "e5tSVt6dpjykjFAAK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clovys~similarweb-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clovys-similarweb-api", "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/clovys~similarweb-api/runs": { "post": { "operationId": "runs-sync-clovys-similarweb-api", "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/clovys~similarweb-api/run-sync": { "post": { "operationId": "run-sync-clovys-similarweb-api", "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": "Domains", "minItems": 1, "maxItems": 100000, "type": "array", "description": "List of domains or URLs to analyze (e.g. apify.com, https://www.google.com). Up to 100 000 per run (auto-split into ~3k chunks on Apify).", "items": { "type": "string" } }, "fetchMode": { "title": "Fetch mode", "enum": [ "extension", "auto", "browser", "http" ], "type": "string", "description": "extension = fast lightweight API (recommended). auto = extension then browser fallback. browser = Camoufox only. http = legacy Impit website fetch.", "default": "extension" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 12, "type": "integer", "description": "Parallel workers. Fast modes: 5–10. Browser mode: keep 1–3. Auto-heal may temporarily lower this under blocks.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Datacenter / Apify automatic proxy is enough for the default fast mode. Residential is optional for browser fallback." }, "cacheTtlHours": { "title": "Cache TTL (hours)", "minimum": 0, "maximum": 168, "type": "integer", "description": "Reuse successful results already stored in this run's KV store. 0 disables. Default 72h saves cost on repeated domains.", "default": 72 }, "includeKeywords": { "title": "Include top keywords", "type": "boolean", "description": "Include top organic keywords when available.", "default": true }, "includeCountries": { "title": "Include top countries", "type": "boolean", "description": "Include geographic traffic share breakdown.", "default": true }, "maxRetries": { "title": "Max retries per domain", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries on network / block errors.", "default": 1 }, "extensionVersion": { "title": "Extension version (advanced)", "type": "string", "description": "Advanced: only change if support instructs you to. Used by the fast fetch mode.", "default": "6.12.18" }, "bootstrapCookies": { "title": "Bootstrap cookies (http mode)", "type": "boolean", "description": "Advanced: seed cookies via browser for legacy http mode. Leave off.", "default": false }, "_shard": { "title": "Internal shard flag", "type": "boolean", "description": "Internal self-shard marker. Do not set manually.", "default": false }, "_parentDatasetId": { "title": "Internal parent dataset", "type": "string", "description": "Internal parent dataset id for self-shard children. Do not set manually." } } }, "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 } } } } } } } } } }