{ "openapi": "3.0.1", "info": { "title": "Keyword Search Volume API: Google Keyword Planner data", "description": "Google Keyword Planner search volume, CPC, competition, bids and 12-month trend for up to 10,000 keywords per run, any country, region or city. Every keyword gets a row; repeats are free until Google publishes new figures; invalid, no-data and zero-volume keywords are free.", "version": "0.1", "x-build-id": "WhL9JBvs0ThHi0P9I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kkingsbe~keyword-search-volume/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kkingsbe-keyword-search-volume", "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/kkingsbe~keyword-search-volume/runs": { "post": { "operationId": "runs-sync-kkingsbe-keyword-search-volume", "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/kkingsbe~keyword-search-volume/run-sync": { "post": { "operationId": "run-sync-kkingsbe-keyword-search-volume", "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": "Keywords", "type": "array", "description": "Keywords to measure (metrics) or expand (ideas). Up to 10,000 distinct keywords per run. Case, extra spaces, surrounding quotes and ? ! , ( ) are ignored; duplicates are charged once.", "default": [ "project management software", "crm for small business", "email marketing tools" ], "items": { "type": "string" } }, "keywordsText": { "title": "Keywords as text", "type": "string", "description": "Optional: paste a list, one per line or comma-separated. Merged after `keywords`.", "default": "" }, "mode": { "title": "Mode", "enum": [ "metrics", "ideas", "both" ], "type": "string", "description": "metrics: figures for the keywords you supplied. ideas: expand them as seeds into related keywords with the same figures. both: metrics for your keywords plus ideas.", "default": "metrics" }, "location": { "title": "Location", "type": "string", "description": "Country, region or city as Google Ads names it (United States, Germany, California, Austin, Texas) or a numeric Google Ads location id. Ambiguous names list the matches.", "default": "United States" }, "language": { "title": "Language", "type": "string", "description": "Language name or code (46 supported, for example de or German). Empty means the main language of the location.", "default": "" }, "network": { "title": "Network", "enum": [ "google_search", "google_search_and_partners" ], "type": "string", "description": "google_search: Google Search only. google_search_and_partners: adds Google's search partner sites.", "default": "google_search" }, "includeMonthlySearches": { "title": "Include monthly searches", "type": "boolean", "description": "Include the month-by-month search counts on each row.", "default": true }, "monthsBack": { "title": "Months of history", "minimum": 1, "maximum": 48, "type": "integer", "description": "Months of history on each row, ending at the latest month Google has published. Above 12 the lookup is slower (can exceed an AI agent's 30-second wait).", "default": 12 }, "maxIdeas": { "title": "Maximum ideas", "minimum": 1, "maximum": 10000, "type": "integer", "description": "ideas and both modes only: total idea rows for the run.", "default": 100 }, "sortBy": { "title": "Keep ideas with the highest", "enum": [ "search_volume", "relevance", "competition_index", "cpc" ], "type": "string", "description": "ideas and both modes only: which ideas maxIdeas keeps, highest first.", "default": "search_volume" }, "minSearchVolume": { "title": "Minimum search volume for ideas", "minimum": 0, "type": "integer", "description": "Drop ideas (never your own keywords) below this average monthly search volume.", "default": 0 }, "includeAdultKeywords": { "title": "Include adult keywords", "type": "boolean", "description": "Include adult keywords in results; Google Ads omits them by default.", "default": false }, "maxItems": { "title": "Maximum charged keywords", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on new keywords looked up and charged in this run. Repeats are free and not counted. The run's maximum charge is respected as well.", "default": 1000 }, "includeRaw": { "title": "Include raw provider row", "type": "boolean", "description": "Add the provider's original row under raw.", "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 } } } } } } } } } }