{
"openapi": "3.0.1",
"info": {
"title": "Keyword Search Volume & CPC (Google Keyword Planner)",
"description": "Bulk Google keyword search volume, CPC, competition and trends from official Google Keyword Planner data. Check up to 100,000 keywords per run, or get keyword ideas for keyword research, in 50 countries. About $2 per 1,000 keywords.",
"version": "0.0",
"x-build-id": "ImWrKalY6D27gxpHi"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/precisionlabs~keyword-search-volume/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-precisionlabs-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/precisionlabs~keyword-search-volume/runs": {
"post": {
"operationId": "runs-sync-precisionlabs-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/precisionlabs~keyword-search-volume/run-sync": {
"post": {
"operationId": "run-sync-precisionlabs-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",
"required": [
"keywords"
],
"properties": {
"keywords": {
"title": "Keywords",
"type": "array",
"description": "One keyword per line, up to 100,000. In Keyword ideas mode these are the seed keywords. Punctuation Google Ads doesn't accept, such as ? or !, is removed automatically.",
"items": {
"type": "string"
}
},
"mode": {
"title": "Mode",
"enum": [
"volume",
"ideas"
],
"type": "string",
"description": "Search volume: metrics for your exact keywords. Keyword ideas: related keywords Google suggests for your seeds, most searched first.",
"default": "volume"
},
"location": {
"title": "Country",
"enum": [
"worldwide",
"2840",
"2826",
"2124",
"2036",
"2554",
"2372",
"2276",
"2250",
"2724",
"2380",
"2528",
"2056",
"2756",
"2040",
"2620",
"2616",
"2203",
"2642",
"2348",
"2300",
"2752",
"2578",
"2208",
"2246",
"2804",
"2792",
"2376",
"2784",
"2682",
"2818",
"2710",
"2566",
"2404",
"2356",
"2702",
"2458",
"2360",
"2608",
"2764",
"2704",
"2392",
"2410",
"2158",
"2344",
"2076",
"2484",
"2032",
"2152",
"2170",
"2604"
],
"type": "string",
"description": "Where the searches happen. For a region or city, use Custom location below.",
"default": "2840"
},
"language": {
"title": "Language",
"enum": [
"all",
"en",
"es",
"de",
"fr",
"it",
"pt",
"nl",
"pl",
"sv",
"da",
"fi",
"cs",
"ro",
"hu",
"el",
"tr",
"uk",
"ru",
"ar",
"hi",
"id",
"th",
"vi",
"ja",
"ko"
],
"type": "string",
"description": "Only count searches in this language. Most tools default to all languages.",
"default": "all"
},
"historyMonths": {
"title": "Monthly history",
"enum": [
"12",
"24",
"36"
],
"type": "string",
"description": "How many months of search volume to return per keyword. Trends are calculated either way.",
"default": "12"
},
"maxIdeas": {
"title": "Max keyword ideas",
"minimum": 1,
"maximum": 20000,
"type": "integer",
"description": "Keyword ideas mode only: stop after this many ideas in total. Each idea is billed as one keyword.",
"default": 500
},
"customLocation": {
"title": "Custom location",
"type": "string",
"description": "Overrides Country. A Google Ads location name, such as London,England,United Kingdom or California,United States."
},
"searchPartners": {
"title": "Include Google search partners",
"type": "boolean",
"description": "Add searches on Google's partner sites to Google Search. Off matches Google Keyword Planner's default.",
"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
}
}
}
}
}
}
}
}
}
}