{ "openapi": "3.0.1", "info": { "title": "Website Traffic Checker - Visits, Keywords & Rankings", "description": "Estimated monthly website traffic for any domain: organic and paid visits, keyword counts, and the keywords a site ranks for with ranks, volumes and CPC. Bulk-check hundreds of domains in one run.", "version": "1.0", "x-build-id": "bPSSuh5Vr7l1SvHq5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~similarweb-website-traffic-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-similarweb-website-traffic-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/sian.agency~similarweb-website-traffic-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-similarweb-website-traffic-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/sian.agency~similarweb-website-traffic-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-similarweb-website-traffic-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": { "operation": { "title": "🎯 What do you want to scrape?", "enum": [ "trafficEstimates", "topKeywords" ], "type": "string", "description": "Pick one per run. Traffic Estimates answers how many visits a domain gets: monthly organic and paid figures plus keyword counts, many domains at once. Ranking Keywords answers where those visits come from: the actual keywords a domain ranks for, each with its position, search volume, CPC and the page that ranks.", "default": "trafficEstimates" }, "domain": { "title": "🌐 Single domain", "type": "string", "description": "One domain to check, e.g. apify.com. Anything reasonable is accepted — https://apify.com, www.apify.com and apify.com/some/page all normalise to apify.com. Used only when the domain list and list file below are empty; duplicates are removed before anything is charged.", "default": "apify.com" }, "bulkDomains": { "title": "🌐 Domain list", "type": "array", "description": "Many domains at once, one per line. This field wins over the single domain above when it is filled. Traffic Estimates checks the list in batches of up to 1000 domains per request, so long lists stay fast and cheap. Free plan runs are capped at 5 domains.", "default": [], "items": { "type": "string" } }, "domainListUrl": { "title": "📄 Domain list file URL", "type": "string", "description": "A public URL to a plain-text file of domains, one per line, lines starting with # ignored. Wins over the two fields above when filled, for lists too long to paste. Any HTTP or HTTPS link to a .txt file works." }, "market": { "title": "🌍 Market", "enum": [ "US", "GB", "CA", "AU" ], "type": "string", "description": "Which country's Google search data to estimate from. The same domain can look very different per market — apify.com shows about 402k monthly organic visits from the United States and about 32k from the United Kingdom.", "default": "US" }, "maxKeywords": { "title": "🔑 Max keywords per domain", "minimum": 10, "maximum": 1000, "type": "integer", "description": "Used by the Ranking Keywords operation: how many of a domain's top keywords to return, strongest first. Free plan runs are capped at 10 per domain.", "default": 100 } } }, "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 } } } } } } } } } }