{ "openapi": "3.0.1", "info": { "title": "Similarweb Scraper | Website Traffic, Rankings and Competitors", "description": "Scrape Similarweb data for any website: monthly traffic, global and country rank, bounce rate, traffic sources, top keywords, audience demographics, similar sites, technologies, and company details. Search by domain, keyword, or Top Websites ranking. No account needed, fast CSV or JSON export.", "version": "1.0", "x-build-id": "zXr0b8ptEqVYwHWp7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/silentflow~similarweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-silentflow-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/silentflow~similarweb-scraper/runs": { "post": { "operationId": "runs-sync-silentflow-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/silentflow~similarweb-scraper/run-sync": { "post": { "operationId": "run-sync-silentflow-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": { "domains": { "title": "🌐 Domains", "type": "array", "description": "Websites to read, one per line: a domain (apify.com), a page address (https://www.notion.so/product) or a Similarweb page (similarweb.com/website/stripe.com/). Each becomes one row with monthly visits, global, country and category rank, bounce rate, pages per visit, visit duration, traffic sources, top countries, top keywords, similar sites, technologies, demographics and the company behind the site. A domain Similarweb does not track gives no row.", "items": { "type": "string" } }, "keywords": { "title": "🔎 Keywords", "type": "array", "description": "Find websites by name, one term per line: flight gives the 10 domains whose name matches best (flightradar24.com, flightaware.com, flights.google.com...), crypto the crypto sites. Each match becomes a full row, the same as a domain you typed.", "items": { "type": "string" } }, "country": { "title": "🌍 Country", "enum": [ "worldwide", "argentina", "australia", "austria", "belgium", "brazil", "bulgaria", "canada", "chile", "colombia", "costa-rica", "croatia", "czech-republic", "denmark", "dominican-republic", "ecuador", "egypt", "finland", "france", "germany", "greece", "guatemala", "hong-kong", "hungary", "india", "indonesia", "iraq", "ireland", "israel", "italy", "japan", "korea-republic-of", "kuwait", "malaysia", "mexico", "morocco", "netherlands", "new-zealand", "norway", "pakistan", "panama", "peru", "philippines", "poland", "portugal", "puerto-rico", "qatar", "romania", "russian-federation", "saudi-arabia", "serbia", "singapore", "slovakia", "south-africa", "spain", "sweden", "switzerland", "taiwan", "thailand", "turkey", "ukraine", "united-arab-emirates", "united-kingdom", "united-states", "uruguay", "venezuela-bolivarian-republic-of", "vietnam" ], "type": "string", "description": "The country whose most visited websites to read, Worldwide for the global ranking. Every ranked site becomes a full row with its position in rank." }, "category": { "title": "📂 Category", "enum": [ "all-categories", "arts-and-entertainment", "arts-and-entertainment/animation-and-comics", "arts-and-entertainment/arts-and-entertainment", "arts-and-entertainment/books-and-literature", "arts-and-entertainment/humor", "arts-and-entertainment/music", "arts-and-entertainment/performing-arts", "arts-and-entertainment/tv-movies-and-streaming", "arts-and-entertainment/visual-arts-and-design", "business-and-consumer-services", "business-and-consumer-services/business-and-consumer-services", "business-and-consumer-services/business-services", "business-and-consumer-services/marketing-and-advertising", "business-and-consumer-services/online-marketing", "business-and-consumer-services/publishing-and-printing", "business-and-consumer-services/real-estate", "business-and-consumer-services/relocation-and-household-moving", "business-and-consumer-services/shipping-and-logistics", "business-and-consumer-services/textiles", "community-and-society", "community-and-society/community-and-society", "community-and-society/decease", "community-and-society/faith-and-beliefs", "community-and-society/holidays-and-seasonal-events", "community-and-society/lgbtq", "community-and-society/philanthropy", "community-and-society/romance-and-relationships", "computers-electronics-and-technology", "computers-electronics-and-technology/advertising-networks", "computers-electronics-and-technology/computer-hardware", "computers-electronics-and-technology/computer-security", "computers-electronics-and-technology/computers-electronics-and-technology", "computers-electronics-and-technology/consumer-electronics", "computers-electronics-and-technology/email", "computers-electronics-and-technology/file-sharing-and-hosting", "computers-electronics-and-technology/graphics-multimedia-and-web-design", "computers-electronics-and-technology/programming-and-developer-software", "computers-electronics-and-technology/search-engines", "computers-electronics-and-technology/social-networks-and-online-communities", "computers-electronics-and-technology/telecommunications", "computers-electronics-and-technology/web-hosting-and-domain-names", "e-commerce-and-shopping", "e-commerce-and-shopping/auctions", "e-commerce-and-shopping/classifieds", "e-commerce-and-shopping/coupons-and-rebates", "e-commerce-and-shopping/e-commerce-and-shopping", "e-commerce-and-shopping/marketplace", "e-commerce-and-shopping/price-comparison", "e-commerce-and-shopping/tickets", "finance", "finance/accounting-and-auditing", "finance/banking-credit-and-lending", "finance/finance", "finance/financial-planning-and-management", "finance/insurance", "finance/investing", "food-and-drink", "food-and-drink/beverages", "food-and-drink/cooking-and-recipes", "food-and-drink/food-and-drink", "food-and-drink/groceries", "food-and-drink/restaurants-and-delivery", "food-and-drink/vegetarian-and-vegan", "gambling", "gambling/bingo", "gambling/casinos", "gambling/gambling", "gambling/lottery", "gambling/poker", "gambling/sports-betting", "games", "games/board-and-card-games", "games/games", "games/puzzles-and-brainteasers", "games/roleplaying-games", "games/video-games-consoles-and-accessories", "health", "health/addictions", "health/alternative-and-natural-medicine", "health/biotechnology-and-pharmaceuticals", "health/childrens-health", "health/dentist-and-dental-services", "health/developmental-and-physical-disabilities", "health/geriatric-and-aging-care", "health/health", "health/health-conditions-and-concerns", "health/medicine", "health/mens-health", "health/mental-health", "health/nutrition-diets-and-fitness", "health/pharmacy", "health/public-health-and-safety", "health/womens-health", "heavy-industry-and-engineering", "heavy-industry-and-engineering/aerospace-and-defense", "heavy-industry-and-engineering/agriculture", "heavy-industry-and-engineering/architecture", "heavy-industry-and-engineering/chemical-industry", "heavy-industry-and-engineering/construction-and-maintenance", "heavy-industry-and-engineering/energy-industry", "heavy-industry-and-engineering/heavy-industry-and-engineering", "heavy-industry-and-engineering/metals-and-mining", "heavy-industry-and-engineering/waste-water-and-environmental", "hobbies-and-leisure", "hobbies-and-leisure/ancestry-and-genealogy", "hobbies-and-leisure/antiques-and-collectibles", "hobbies-and-leisure/camping-scouting-and-outdoors", "hobbies-and-leisure/crafts", "hobbies-and-leisure/hobbies-and-leisure", "hobbies-and-leisure/models", "hobbies-and-leisure/photography", "home-and-garden", "home-and-garden/furniture", "home-and-garden/gardening", "home-and-garden/home-and-garden", "home-and-garden/home-improvement-and-maintenance", "home-and-garden/interior-design", "jobs-and-career", "jobs-and-career/human-resources", "jobs-and-career/jobs-and-career", "jobs-and-career/jobs-and-employment", "law-and-government", "law-and-government/government", "law-and-government/immigration-and-visas", "law-and-government/law-and-government", "law-and-government/law-enforcement-and-protective-services", "law-and-government/legal", "law-and-government/national-security", "lifestyle", "lifestyle/beauty-and-cosmetics", "lifestyle/childcare", "lifestyle/fashion-and-apparel", "lifestyle/gifts-and-flowers", "lifestyle/jewelry-and-luxury-products", "lifestyle/lifestyle", "lifestyle/tobacco", "lifestyle/weddings", "news-and-media", "pets-and-animals", "pets-and-animals/animals", "pets-and-animals/birds", "pets-and-animals/fish-and-aquaria", "pets-and-animals/horses", "pets-and-animals/pet-food-and-supplies", "pets-and-animals/pets", "pets-and-animals/pets-and-animals", "reference-materials", "reference-materials/dictionaries-and-encyclopedias", "reference-materials/maps", "reference-materials/public-records-and-directories", "reference-materials/reference-materials", "science-and-education", "science-and-education/astronomy", "science-and-education/biology", "science-and-education/business-training", "science-and-education/chemistry", "science-and-education/earth-sciences", "science-and-education/education", "science-and-education/environmental-science", "science-and-education/grants-scholarships-and-financial-aid", "science-and-education/history", "science-and-education/libraries-and-museums", "science-and-education/literature", "science-and-education/math", "science-and-education/philosophy", "science-and-education/physics", "science-and-education/public-records-and-directories", "science-and-education/science-and-education", "science-and-education/social-sciences", "science-and-education/universities-and-colleges", "science-and-education/weather", "sports", "sports/american-football", "sports/baseball", "sports/basketball", "sports/boxing", "sports/climbing", "sports/cycling-and-biking", "sports/extreme-sports", "sports/fantasy-sports", "sports/fishing", "sports/golf", "sports/hunting-and-shooting", "sports/martial-arts", "sports/rugby", "sports/running", "sports/soccer", "sports/sports", "sports/tennis", "sports/volleyball", "sports/water-sports", "sports/winter-sports", "travel-and-tourism", "travel-and-tourism/accommodation-and-hotels", "travel-and-tourism/air-travel", "travel-and-tourism/car-rentals", "travel-and-tourism/ground-transportation", "travel-and-tourism/tourist-attractions", "travel-and-tourism/transportation-and-excursions", "travel-and-tourism/travel-and-tourism", "vehicles", "vehicles/automotive-industry", "vehicles/aviation", "vehicles/boats", "vehicles/makes-and-models", "vehicles/motorcycles", "vehicles/motorsports", "vehicles/vehicles", "adult", "ai-chatbots-and-tools" ], "type": "string", "description": "The category of the ranking: a main category (Finance) or a sub-category (Travel and Tourism › Air Travel). Combined with a country it gives that country's top 5 of the category; alone, the worldwide top 50." }, "maxItems": { "title": "🔢 Max websites", "minimum": 1, "type": "integer", "description": "How many rows to save for the whole run. A domain gives 1 row, a keyword up to 10, a ranking up to 68, and similar websites add up to 10 per row, so 100 covers a ranking or a list of a hundred domains in full.", "default": 100 }, "includeCompetitors": { "title": "🔗 Read similar websites too", "type": "boolean", "description": "On: the 10 most similar websites of each row are read as full rows, with competitorOf naming the site they came from. One level only, so 5 domains give up to 55 rows. Off: the similar sites stay listed in the competitors column of each row, with their category, category rank and affinity.", "default": false }, "debugMode": { "title": "🐞 Debug mode", "type": "boolean", "description": "Adds detailed lines to the run log. Leave it off for normal runs.", "default": false } } }, "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 } } } } } } } } } }