{ "openapi": "3.0.1", "info": { "title": "Similarweb [$0.99💰] AI Traffic·Rank·Visits·Keywords", "description": "Similarweb data plus AI-assistant traffic: what % of a domain's visits come from ChatGPT, Claude & Gemini, and which ones. Plus rank, monthly visits + 3-month trend, bounce rate, traffic sources, top keywords. From $0.99/1k domains (plan discounts to $0.70).", "version": "0.0", "x-build-id": "4brrOxDVNyifTM8R5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~similarweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~similarweb-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~similarweb-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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": "Website domains", "type": "array", "description": "List of domains (or URLs) to fetch traffic data for. One successful domain = one result row.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum domains per run", "minimum": 1, "type": "integer", "description": "Hard cap on how many domains are looked up in this run. Each domain that returns data is one paid result; domains Similarweb has no data for are listed free of charge in the NO_DATA_DOMAINS record of the run's key-value store. Default 1000. Runs on the free Apify plan are capped at 15 domains.", "default": 1000 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Residential proxies are recommended, and the default works out of the box.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "enrichEmails": { "title": "Enrich with contact emails (experimental, billed per email)", "type": "boolean", "description": "If enabled, finds a contact email for each result from its own website (or by discovering it from the name). Adds contactEmail + contactWebsite columns plus a detailed emailEnrichment object. Billed 5 premium-data units per email found (≈ $5 per 1,000 emails on the base plan, cheaper on higher plans); never charged for misses.", "default": false }, "datasetMode": { "title": "Dataset mode", "enum": [ "base_data", "similar_sites", "aitdk" ], "type": "string", "description": "base_data = traffic + AI. similar_sites = also competitors (~+$1/1k). aitdk = also WHOIS/RDAP + homepage keyword density (~+$2/1k). The toggles below still stack.", "default": "base_data" }, "includeSimilarSites": { "title": "Include similar sites / competitors — billed extra (~+$1/1k)", "type": "boolean", "description": "If enabled, each domain that returns data is also enriched with competitors (similar sites with category rank + affinity). Billed 1 premium-data unit per domain (≈ +$1 per 1,000 on the base plan); only charged when competitors are returned. Skip this if you turn on in-depth below — that already includes competitors.", "default": false }, "includeInDepth": { "title": "Include in-depth data (demographics + competitors + top countries) — billed extra", "type": "boolean", "description": "If enabled, each domain that returns data is also enriched with: audienceGender (male/female split), audienceAgeDistribution (age brackets), competitors (similar sites with category rank + affinity), and geographyCountries (top 5 countries with traffic share and change) plus geographyCountriesTotal (how many countries the site gets traffic from). Billed 4 premium-data units per in-depth domain (≈ +$4 per 1,000 on the base plan); a domain with competitors but no audience data pays 1 unit instead, and one with neither pays nothing. Audience data is often missing for sites under about 100,000 monthly visits. Includes similar sites, so you do not need includeSimilarSites as well.", "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 } } } } } } } } } }