{ "openapi": "3.0.1", "info": { "title": "🌐 SimilarWeb Quick Scraper", "description": "πŸš€ SimilarWeb Quick Scraper extracts key traffic & audience insights from SimilarWeb in minutesβ€”perfect for competitor research, market analysis, and lead generation. πŸ“Š Save time, uncover growth trends, and act faster with reliable data. 🌐", "version": "0.1", "x-build-id": "a8BbPK2uP3f3pwb4u" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~similarweb-quick-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-similarweb-quick-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/api-empire~similarweb-quick-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-similarweb-quick-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/api-empire~similarweb-quick-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-similarweb-quick-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", "required": [ "websites" ], "properties": { "websites": { "title": "πŸ”— Websites / Domains", "type": "array", "description": "πŸ“₯ Paste one or more domains (e.g. apple.com) or full URLs (e.g. https://www.apple.com/iphone) β€” full URLs are auto-trimmed to their domain. Supports bulk input.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "πŸ›‘οΈ Proxy Configuration", "type": "object", "description": "🧭 The scraper starts direct (no proxy) and auto-escalates to a Datacenter then Residential proxy if SimilarWeb blocks it β€” sticking with the highest tier for the rest of the run. Pick a country here to geo-target the residential pool, or supply your own proxy URLs.", "default": { "useApifyProxy": true } }, "concurrency": { "title": "⚑ Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "πŸ”’ Maximum simultaneous requests. Keep it gentle (4 is a good default) to avoid blocks.", "default": 4 }, "maxRetries": { "title": "πŸ” Max Retries", "minimum": 1, "maximum": 10, "type": "integer", "description": "πŸ› οΈ Retry attempts on the residential tier before giving up on a domain.", "default": 3 }, "requestDelay": { "title": "⏱️ Delay Between Requests (seconds)", "minimum": 0, "maximum": 10, "type": "number", "description": "🐒 Optional fixed delay before each request (random jitter is added). Raise it on stubborn blocks.", "default": 0 }, "timeout": { "title": "βŒ› Request Timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "⏳ Per-request timeout. Proxies are slower, so 60s is a safe default.", "default": 60 }, "impersonate": { "title": "🎭 Browser Fingerprint", "enum": [ "chrome", "chrome110", "chrome120", "edge", "safari" ], "type": "string", "description": "πŸ•΅οΈ Real-browser TLS/JA3 fingerprint to spoof (helps slip past anti-bot WAFs).", "default": "chrome" }, "token": { "title": "🎫 Priority Token (optional)", "type": "string", "description": "πŸ”‘ Optional token for priority queue. Leave blank β€” not required for normal use." } } }, "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 } } } } } } } } } }