{ "openapi": "3.0.1", "info": { "title": "Competitor Keywords Scraper — Ranked Keywords of Any Domain", "description": "The keywords any domain or page ranks for on Google — position, ranking URL, search volume, CPC, keyword difficulty, search intent and estimated traffic for each, in 94 countries. From $1.50 per 1,000 keywords plus a $0.02 lookup per domain; a domain that ranks for nothing is never charged.", "version": "1.0", "x-build-id": "T2FqzZex2J6VUc8EZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steadyfetch~competitor-keywords-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steadyfetch-competitor-keywords-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/steadyfetch~competitor-keywords-scraper/runs": { "post": { "operationId": "runs-sync-steadyfetch-competitor-keywords-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/steadyfetch~competitor-keywords-scraper/run-sync": { "post": { "operationId": "run-sync-steadyfetch-competitor-keywords-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 or pages", "type": "array", "description": "The domains or pages to get ranked keywords for, e.g. [\"ahrefs.com\"] — up to 100 per run, one per line. A bare domain or homepage (ahrefs.com, https://www.ahrefs.com/) reads the whole domain; a subdomain (blog.example.com) reads that subdomain; an address with a path (https://ahrefs.com/blog/) reads that one page. Entries that are not a domain are refused on their own uncharged row and never sent.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "The country whose Google rankings to read — pick one, or type a code or name (US, USA, United Kingdom, en-GB). 94 countries are covered; one country per run.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "The search language — a code or name (en, es, German). Leave empty for the country's main language; each country offers its own languages (the United States: English or Spanish)." }, "maxResultsPerDomain": { "title": "Max keywords per domain", "minimum": 1, "type": "integer", "description": "How many ranked keywords to deliver per domain, at most, a whole number, e.g. 500 — 100 by default, up to 5,000. Each request returns up to 1,000 keywords of one domain, so 1,000 keywords is one lookup and 5,000 is five. Ask for more and the run continues at 5,000, with one uncharged row saying so.", "default": 100 }, "sortBy": { "title": "Sort keywords by", "type": "string", "description": "The order each domain's keywords come back in, which also decides which keywords a limit keeps: \"traffic\" (most estimated traffic first, the default), \"volume\" (highest search volume first) or \"position\" (best position first).", "default": "traffic" }, "maxPosition": { "title": "Ranking at or above position", "minimum": 1, "type": "integer", "description": "Only keywords the domain ranks for at this position or better, a whole number from 1 to 100, e.g. 10 keeps the first page of Google and 3 the top three. The filter runs at the source, so lower rankings are never delivered or charged." }, "minSearchVolume": { "title": "Minimum search volume", "minimum": 0, "type": "integer", "description": "Only keywords searched at least this many times a month, a whole number, e.g. 100. The filter runs at the source, so keywords below it are never delivered or charged." } } }, "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 } } } } } } } } } }