{ "openapi": "3.0.1", "info": { "title": "Similarweb Scraper: Website Traffic, Rank & Traffic Sources", "description": "Get Similarweb data for any list of websites: monthly visits, ranks, bounce rate, visit duration, traffic sources, top countries, top keywords and AI chatbot traffic (ChatGPT, Claude, Gemini). Bulk and fast. Pay only for domains with data.", "version": "1.0", "x-build-id": "aGmGJgbexmpJwYFdN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrape-lads~similarweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrape-lads-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/scrape-lads~similarweb-scraper/runs": { "post": { "operationId": "runs-sync-scrape-lads-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/scrape-lads~similarweb-scraper/run-sync": { "post": { "operationId": "run-sync-scrape-lads-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", "required": [ "domains" ], "properties": { "domains": { "title": "Domains or website URLs", "type": "array", "description": "Websites to look up on Similarweb, one per line. Bare domains (stripe.com), www hosts, full URLs (https://www.stripe.com/pricing) and Similarweb links (similarweb.com/website/stripe.com/) all work. www. is removed, duplicates are looked up and charged once, and invalid entries are skipped with a warning. Subdomains such as docs.python.org are kept.", "items": { "type": "string" } }, "maxItems": { "title": "Max domains", "minimum": 0, "type": "integer", "description": "Process at most this many domains from the list (after removing duplicates). 0 means no limit.", "default": 0 }, "includeWhois": { "title": "Add WHOIS data (add-on)", "type": "boolean", "description": "Registrar, creation, update and expiry dates, domain age, nameservers and status from the registry's official RDAP service. Charged per domain only when a record comes back.", "default": false }, "includeContacts": { "title": "Add contact details (add-on)", "type": "boolean", "description": "Public emails, phone links and social profiles (Facebook, Instagram, X, LinkedIn, YouTube, TikTok, GitHub, Pinterest) from the site's homepage and contact page. Charged per domain only when at least one contact is found.", "default": false }, "compareDomains": { "title": "Add a comparison row", "type": "boolean", "description": "When two or more domains have data, add one free summary row (rowType \"comparison\") ranking them by monthly visits with month-over-month and 3-month growth.", "default": true }, "includeNoDataRows": { "title": "Include domains without data", "type": "boolean", "description": "Write a row with status \"no_data\" (noData: true) for small sites Similarweb has no estimate for. These rows are never charged. Turn off to get only domains with data.", "default": true }, "includeAiPrompts": { "title": "Include top AI prompts", "type": "boolean", "description": "Add the example AI chatbot prompts Similarweb shows for the site (aiTopPrompts).", "default": true }, "maxConcurrency": { "title": "Parallel lookups", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many domains are fetched at the same time.", "default": 20 }, "maxRequestRetries": { "title": "Retries per domain", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times a blocked or failed lookup is retried. Every retry uses a new proxy IP.", "default": 5 } } }, "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 } } } } } } } } } }