{
"openapi": "3.0.1",
"info": {
"title": "SimilarWeb Data Extractor — Website Traffic & Analytics",
"description": "Extract website traffic estimates and analytics data from SimilarWeb. Get monthly visits, bounce rate, pages per visit, traffic sources, top countries, and competitor analysis. No SimilarWeb subscription required. Essential for competitive intelligence and market research.",
"version": "0.1",
"x-build-id": "05BtLh6bkvw40QNu9"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/rastriq~similarweb-data-extractor/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-rastriq-similarweb-data-extractor",
"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/rastriq~similarweb-data-extractor/runs": {
"post": {
"operationId": "runs-sync-rastriq-similarweb-data-extractor",
"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/rastriq~similarweb-data-extractor/run-sync": {
"post": {
"operationId": "run-sync-rastriq-similarweb-data-extractor",
"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": "One domain per line, without https://.",
"items": {
"type": "string"
}
},
"includeShopperData": {
"title": "Include e-commerce data",
"type": "boolean",
"description": "Also fetch top products, brands, and revenue for each domain above.
Only works for major e-commerce sites (Amazon, eBay, Walmart...).",
"default": false
},
"includeTopWebsites": {
"title": "Enable",
"type": "boolean",
"description": "Fetch the top 50 websites ranked by traffic.",
"default": false
},
"country": {
"title": "Country",
"enum": [
"",
"spain",
"united-states",
"united-kingdom",
"germany",
"france",
"italy",
"brazil",
"mexico",
"argentina",
"colombia",
"chile",
"japan",
"india",
"canada",
"australia",
"netherlands",
"portugal",
"turkey",
"poland",
"sweden",
"switzerland",
"belgium",
"austria",
"russia",
"south-korea",
"china",
"indonesia",
"thailand",
"philippines",
"vietnam",
"egypt",
"south-africa",
"nigeria",
"saudi-arabia",
"united-arab-emirates",
"israel"
],
"type": "string",
"description": "Also used by Option 3 (Trending) below.",
"default": ""
},
"category": {
"title": "Category",
"enum": [
"",
"arts-and-entertainment",
"business-and-consumer-services",
"community-and-society",
"computers-electronics-and-technology",
"e-commerce-and-shopping",
"education",
"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"
],
"type": "string",
"description": "Filter by website category.",
"default": ""
},
"includeTrends": {
"title": "Enable",
"type": "boolean",
"description": "Fetch rising, falling, new-in, and dropped-out websites.",
"default": false
},
"searchTerms": {
"title": "Search terms",
"type": "array",
"description": "One term per line. Example: artificial intelligence",
"items": {
"type": "string"
}
},
"delayBetweenRequests": {
"title": "Delay between requests (seconds)",
"minimum": 0,
"maximum": 30,
"type": "number",
"description": "Seconds between API calls to avoid rate limiting. Requests run in parallel (5 at a time), this delay applies per request.",
"default": 1
},
"debugMode": {
"title": "Debug mode",
"type": "boolean",
"description": "Log extra details (response sizes, raw payloads).",
"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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}