{
"openapi": "3.0.1",
"info": {
"title": "Keyword Search Volume & CPC API: Difficulty, AI Overview",
"description": "Analyze keywords or generate keyword ideas with Google search volume, CPC, competition, 12 month trends, keyword difficulty, intent, SERP features and AI Overview presence. Up to 1,000 keywords per run. Pay per keyword processed, no subscription.",
"version": "1.0",
"x-build-id": "71Jpz9ACqxVuL9igG"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/koalabed~keyword-search-volume/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-koalabed-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/koalabed~keyword-search-volume/runs": {
"post": {
"operationId": "runs-sync-koalabed-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/koalabed~keyword-search-volume/run-sync": {
"post": {
"operationId": "run-sync-koalabed-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": {
"mode": {
"title": "What do you want to do?",
"enum": [
"metrics",
"ideas"
],
"type": "string",
"description": "Analyze my keywords: get data for the exact keywords you enter below.
Generate keyword ideas: start from one or more seed keywords and get related keywords with the same data (settings in the Keyword ideas section).",
"default": "metrics"
},
"keywords": {
"title": "Keywords to analyze",
"type": "array",
"description": "Enter the keywords you want to analyze. Use + Add for one at a time or Bulk edit to paste many (one per line). Enter 2 to 1,000 per run (up to 10 on Apify's free plan); duplicates are removed automatically and not billed. At least 2 are required because every data request has a fixed cost. Used when Analyze my keywords is selected.",
"items": {
"type": "string"
}
},
"country": {
"title": "Country",
"enum": [
"US",
"GB",
"CA",
"AU",
"IN",
"IE",
"NZ",
"SG",
"ZA",
"DE",
"AT",
"CH",
"FR",
"BE",
"NL",
"ES",
"MX",
"IT",
"BR",
"PT",
"PL",
"SE",
"JP",
"AE"
],
"type": "string",
"description": "Choose the Google market used for search volume, CPC, competition and SERP data.",
"default": "US"
},
"language": {
"title": "Language",
"enum": [
"auto",
"en",
"es",
"fr",
"de",
"nl",
"it",
"pt",
"pl",
"sv",
"ja",
"hi",
"ar"
],
"type": "string",
"description": "Language of the searches. Automatic uses the main language of the selected country (English for the United States). Pick a specific language only for multilingual markets, such as French in Canada or Spanish in the United States.",
"default": "auto"
},
"seedKeywords": {
"title": "Seed keywords",
"type": "array",
"description": "Enter one or more seed keywords to generate related keyword ideas. Use Bulk edit to paste several (up to 20).",
"items": {
"type": "string"
}
},
"maxIdeas": {
"title": "Maximum ideas",
"minimum": 2,
"maximum": 1000,
"type": "integer",
"description": "Maximum number of related keyword ideas to return (2 to 1,000). Each idea returned is one processed keyword, with or without search-volume data. If fewer than 2 come back, the 2-keyword minimum is billed.",
"default": 100
},
"minSearchVolume": {
"title": "Minimum monthly search volume",
"minimum": 0,
"type": "integer",
"description": "Exclude keyword ideas below this monthly search volume. Leave at 0 to include every idea.",
"default": 0
},
"includeSerpFeatures": {
"title": "Include SERP features and AI Overview",
"type": "boolean",
"description": "Adds the Google SERP features for each keyword and whether an AI Overview was present, from the latest available Google results snapshot. Each row shows that snapshot's date in serp_checked_at. Search volume and CPC follow their own monthly update cycle (data_month).",
"default": true
}
}
},
"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
}
}
}
}
}
}
}
}
}
}