{ "openapi": "3.0.1", "info": { "title": "Similarweb Scraper — Bulk Traffic CSV & API", "description": "Collect available Similarweb traffic and competitor signals for domains; unavailable metrics remain unknown. Bulk export: JSON, CSV, Excel and API. PPE: from $1/1K website results; usage extra.", "version": "2.2", "x-build-id": "GW8chUfki9JZd74Qc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~similarweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-similarweb-scraper", "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/apivault_labs~similarweb-scraper/runs": { "post": { "operationId": "runs-sync-apivault_labs-similarweb-scraper", "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/apivault_labs~similarweb-scraper/run-sync": { "post": { "operationId": "run-sync-apivault_labs-similarweb-scraper", "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": { "mode": { "title": "What do you want to do?", "enum": [ "overview", "similar_sites", "all_in_one", "compare", "monitor", "market_map", "discovery" ], "type": "string", "description": "Choose a focused workflow, from a fast traffic overview to competitor discovery, monitoring and market mapping.", "default": "overview" }, "domains": { "title": "Domains or website URLs", "maxItems": 10000, "type": "array", "description": "Required for every mode except Discovery. Up to 10,000 domains; duplicates are removed automatically. In Compare, the first domain is the primary website. In Market Map, these are seed websites.", "items": { "type": "string" } }, "includeSimilarSites": { "title": "Include similar sites in Overview", "type": "boolean", "description": "Adds a reliable competitor lookup to every overview record. Off by default to preserve maximum bulk speed. Similar Sites, Complete Profile and Market Map modes enable it automatically.", "default": false }, "includeTopKeywords": { "title": "Top organic keywords", "type": "boolean", "description": "Include top search keywords and available volume, CPC and estimated traffic.", "default": true }, "includeAiTraffic": { "title": "AI / LLM referral intelligence", "type": "boolean", "description": "Include generative-AI traffic share, estimated visits, source ranking, three-month source trends and available top audience prompts.", "default": true }, "includeScreenshot": { "title": "Website screenshot URL", "type": "boolean", "description": "Include the available website preview image URL.", "default": false }, "includeRawData": { "title": "Cleaned raw data", "type": "boolean", "description": "Adds a nested raw_data field. Best for advanced analysis and small runs.", "default": false }, "includeNoData": { "title": "Return domains with no traffic data", "type": "boolean", "description": "Keep one clearly marked dataset row for valid domains even when traffic coverage is unavailable. Recommended for reliable bulk reconciliation.", "default": true }, "returnFailureRecords": { "title": "Return failed domains in the dataset", "type": "boolean", "description": "Keep a status row with a retry reason when a valid domain cannot be fetched, so bulk outputs do not silently lose inputs.", "default": true }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Use the same name on future scheduled runs to compare against the saved baseline.", "default": "my-competitors" }, "monitorDepth": { "title": "Monitoring depth", "enum": [ "overview", "all_in_one" ], "type": "string", "description": "Choose a fast traffic baseline or a complete website intelligence baseline.", "default": "overview" }, "changeThreshold": { "title": "Change sensitivity", "enum": [ "low", "medium", "high" ], "type": "string", "description": "Controls how large a movement must be before it is reported as a material change.", "default": "medium" }, "onlyChanges": { "title": "Return changed domains only", "type": "boolean", "description": "After the baseline run, omit unchanged domains from the dataset.", "default": false }, "marketMapMaxCompetitors": { "title": "Competitors to add to the map", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of unique competitors selected across all seed domains, ranked by similarity.", "default": 20 }, "discoveryType": { "title": "Discovery list", "enum": [ "top", "trending" ], "type": "string", "description": "Find either leading websites by rank or websites currently gaining, losing, entering or leaving visibility.", "default": "top" }, "discoveryCountry": { "title": "Country", "type": "string", "description": "Country URL name, for example worldwide, united-states, united-kingdom, germany, india or brazil.", "default": "worldwide" }, "discoveryCategory": { "title": "Category (optional)", "type": "string", "description": "For example e-commerce-and-shopping, finance, health, games or travel-and-tourism." }, "maxResults": { "title": "Maximum discovery results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Public ranking pages normally contain up to 50 sites. Trending lists contain rising, falling, new and dropped groups.", "default": 1000 }, "enrichDiscovery": { "title": "Add full traffic metrics to discovered sites", "type": "boolean", "description": "Enrich every discovered domain with visits, ranks, channels, keywords and AI traffic.", "default": true }, "maxConcurrency": { "title": "Parallel domains", "minimum": 1, "maximum": 20, "type": "integer", "description": "Overview supports higher concurrency. Use 3–5 for Complete Profile and Market Map.", "default": 10 }, "timeout": { "title": "Request timeout (seconds)", "minimum": 8, "maximum": 60, "type": "integer", "description": "Maximum time allowed for each external request before retrying or moving on.", "default": 15 }, "maxRetries": { "title": "Retries per source", "minimum": 0, "maximum": 8, "type": "integer", "description": "Automatic retries for temporary blocks, rate limits and server errors.", "default": 2 } } }, "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 } } } } } } } } } }