{ "openapi": "3.0.1", "info": { "title": "Keyword Ideas Generator — Keyword Research, Volume & CPC", "description": "Keyword ideas from your seed keywords — search volume, CPC, competition, keyword difficulty and search intent for every idea, in 94 countries. From $2.00 per 1,000 ideas plus a $0.19 lookup per 1,000; a seed list with no ideas is never charged.", "version": "1.0", "x-build-id": "sqbQSEBA9n8bBLLaE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steadyfetch~keyword-ideas-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steadyfetch-keyword-ideas-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~keyword-ideas-scraper/runs": { "post": { "operationId": "runs-sync-steadyfetch-keyword-ideas-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~keyword-ideas-scraper/run-sync": { "post": { "operationId": "run-sync-steadyfetch-keyword-ideas-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": { "keywords": { "title": "Seed keywords", "type": "array", "description": "The seed keywords to get keyword ideas for, e.g. [\"coffee grinder\"] — up to 200 per run, one per line, each up to 80 characters. Ideas come back as one list for all the seeds together; with a single seed every row names it in `seed`. Leave it empty and the run is a 10-idea sample for \"coffee grinder\", charged like any run.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "The country to get keyword ideas for — 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 language of the keyword ideas — 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)." }, "maxResults": { "title": "Max keyword ideas", "minimum": 1, "type": "integer", "description": "How many keyword ideas to deliver, at most, a whole number, e.g. 500 — 100 by default, up to 5,000. Each request returns up to 1,000 ideas, so 1,000 ideas 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 ideas by", "type": "string", "description": "The order the ideas come back in, which also decides which ideas a limit keeps: \"relevance\" to your seeds (default), \"search_volume\" (highest first), \"keyword_difficulty\" (easiest to rank for first) or \"cpc\" (highest first).", "default": "relevance" }, "minSearchVolume": { "title": "Minimum search volume", "minimum": 0, "type": "integer", "description": "Only ideas searched at least this many times a month, a whole number, e.g. 100. The filter runs at the source, so ideas below it are never delivered or charged." }, "maxKeywordDifficulty": { "title": "Maximum keyword difficulty", "minimum": 0, "type": "integer", "description": "Only ideas with a keyword difficulty (0-100, how hard the first page of results is to rank on) at or below this, a whole number, e.g. 30. The filter runs at the source, so harder ideas 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 } } } } } } } } } }