{ "openapi": "3.0.1", "info": { "title": "Similarweb Scraper – Website Traffic & Analytics Data", "description": "Similarweb scraper and API alternative. Export website traffic, ranks and analytics to CSV/JSON; scrape Top Websites data without login or API key.", "version": "1.0", "x-build-id": "5RkfPXROlllqFTlaj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logiover~similarweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logiover-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/logiover~similarweb-scraper/runs": { "post": { "operationId": "runs-sync-logiover-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/logiover~similarweb-scraper/run-sync": { "post": { "operationId": "run-sync-logiover-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": { "categories": { "title": "Categories (ranking mode)", "type": "array", "description": "Pick one or more Similarweb categories to pull Top Websites rankings for (50 sites each). Leave empty to scrape ALL top categories (1,000+ sites).", "items": { "type": "string", "enum": [ "arts-and-entertainment", "business-and-consumer-services", "community-and-society", "computers-electronics-and-technology", "e-commerce-and-shopping", "finance", "food-and-drink", "gambling", "games", "health", "heavy-industry-and-engineering", "hobbies-and-leisure", "home-and-garden", "jobs-and-career", "law-and-government", "lifestyle", "news-and-media", "pets-and-animals", "reference-materials", "science-and-education", "sports", "travel-and-tourism", "vehicles", "adult", "ai-chatbots-and-tools" ], "enumTitles": [ "Arts & Entertainment", "Business & Consumer Services", "Community & Society", "Computers, Electronics & Technology", "E-commerce & Shopping", "Finance", "Food & Drink", "Gambling", "Games", "Health", "Heavy Industry & Engineering", "Hobbies & Leisure", "Home & Garden", "Jobs & Career", "Law & Government", "Lifestyle", "News & Media", "Pets & Animals", "Reference Materials", "Science & Education", "Sports", "Travel & Tourism", "Vehicles", "Adult", "AI Chatbots & Tools" ] } }, "countries": { "title": "Countries (ranking mode)", "type": "array", "description": "Pick one or more countries for country-level Top Websites rankings (50 sites each). Combine with categories for country+category lists (Similarweb limits combined lists to ~5 rows on the free pages).", "items": { "type": "string", "enum": [ "united-states", "united-kingdom", "canada", "australia", "germany", "france", "spain", "italy", "netherlands", "belgium", "switzerland", "austria", "sweden", "norway", "denmark", "finland", "poland", "portugal", "ireland", "greece", "czech-republic", "romania", "hungary", "ukraine", "russia", "turkey", "israel", "saudi-arabia", "united-arab-emirates", "egypt", "south-africa", "nigeria", "india", "pakistan", "bangladesh", "indonesia", "malaysia", "singapore", "thailand", "vietnam", "philippines", "japan", "south-korea", "taiwan", "china", "hong-kong", "brazil", "mexico", "argentina", "colombia", "chile", "peru", "new-zealand" ], "enumTitles": [ "United States", "United Kingdom", "Canada", "Australia", "Germany", "France", "Spain", "Italy", "Netherlands", "Belgium", "Switzerland", "Austria", "Sweden", "Norway", "Denmark", "Finland", "Poland", "Portugal", "Ireland", "Greece", "Czech Republic", "Romania", "Hungary", "Ukraine", "Russia", "Turkey", "Israel", "Saudi Arabia", "United Arab Emirates", "Egypt", "South Africa", "Nigeria", "India", "Pakistan", "Bangladesh", "Indonesia", "Malaysia", "Singapore", "Thailand", "Vietnam", "Philippines", "Japan", "South Korea", "Taiwan", "China", "Hong Kong", "Brazil", "Mexico", "Argentina", "Colombia", "Chile", "Peru", "New Zealand" ] } }, "global": { "title": "Include global Top 50 (ranking mode)", "type": "boolean", "description": "Also scrape the global Top Websites list (top 50 sites worldwide).", "default": false }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Cap total output records (0 = no cap). Useful to limit large all-category runs. An empty input defaults this to 150 for a fast, cheap first run.", "default": 0 }, "domains": { "title": "Domains (enrichment mode)", "type": "array", "description": "Website domains to look up individually on Similarweb. One full-analytics record per domain (total visits, ranks, bounce rate, pages/visit, visit duration, traffic sources, top countries). Protocol and www are stripped automatically.", "items": { "type": "string" } }, "concurrency": { "title": "Enrichment concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel browsers for domain-enrichment mode (1-10). Higher finishes large domain lists faster but uses more memory.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Similarweb is protected by AWS WAF. US residential proxies are required. Leave the default (Apify Proxy · RESIDENTIAL · US).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }