{ "openapi": "3.0.1", "info": { "title": "Keyword Search Volume & CPC: Google Ads Keyword Planner Data", "description": "Keyword search volume API: monthly Google searches, CPC, competition and 12-month history for up to 10,000 keywords per run, from Google Ads data. Any country and language. $0.0008 per keyword with data plus $0.02 per 700-keyword batch; no-data keywords are free.", "version": "0.2", "x-build-id": "YkiDsTKokTZS7XxHF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datagleaner~keyword-volume/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datagleaner-keyword-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/datagleaner~keyword-volume/runs": { "post": { "operationId": "runs-sync-datagleaner-keyword-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/datagleaner~keyword-volume/run-sync": { "post": { "operationId": "run-sync-datagleaner-keyword-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", "maxItems": 10000, "type": "array", "description": "Keywords to look up, up to 10,000 per run. Each is lowercased, trimmed and de-duplicated. A keyword can be up to 80 characters and 10 words, and cannot contain ! @ % ^ ( ) = { } ; ~ ` < > ? \\ | or a comma. Invalid keywords come back as free rows with the reason. Leave the list empty to run a built-in 3-keyword example.", "items": { "type": "string" } }, "locationName": { "title": "Country (optional)", "type": "string", "description": "Country name such as \"United States\" (default), \"United Kingdom\", \"Canada\", \"Germany\" or \"India\". About 90 countries are built in; for a region, a city or another country use Location code. Ignored when a location code is set." }, "locationCode": { "title": "Location code (optional)", "minimum": 1, "type": "integer", "description": "Google Ads location code for any country, region or city, for example 2840 (United States, the default), 2826 (United Kingdom) or 2124 (Canada). Overrides the country name. A region, a city, or a country and language pair outside the keyword database uses Keyword Planner live, billed at the Keyword Planner batch price." }, "languageCode": { "title": "Language code (optional)", "type": "string", "description": "Language code such as en, es, fr, de, pt, it, nl, ja or zh-TW. Leave empty for the country's main language (English where the keyword database has it, e.g. de for Germany, ja for Japan). A language the keyword database does not have for that country uses Keyword Planner live, billed at the Keyword Planner batch price." }, "includeMonthlyHistory": { "title": "Include 12-month history", "type": "boolean", "description": "Add monthlySearches to every row: the search volume of each of the last 12 months, to see seasonality and trend.", "default": true }, "searchPartners": { "title": "Include search partners", "type": "boolean", "description": "Count searches on Google's search partner sites as well as Google Search itself. Off by default. Turning it on uses Keyword Planner live, billed at the Keyword Planner batch price.", "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 } } } } } } } } } }