{ "openapi": "3.0.1", "info": { "title": "Google Keyword Search Volume: Planner Volume, CPC, Competition", "description": "Google keyword search volume from Keyword Planner data: monthly volume, 12-month history, CPC, competition level and index, top-of-page bids, for thousands of keywords per run in any country. Optional keyword ideas from seed keywords. No Google Ads account needed.", "version": "0.1", "x-build-id": "N9wBtKjlebIF71Gdh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quarra~google-keyword-search-volume/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quarra-google-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/quarra~google-keyword-search-volume/runs": { "post": { "operationId": "runs-sync-quarra-google-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/quarra~google-keyword-search-volume/run-sync": { "post": { "operationId": "run-sync-quarra-google-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 get the Google search volume for: up to thousands per run (they are sent in batches of 1,000). Each keyword: 80 characters and 10 words at most; Google does not accept symbols such as ! , % ( ) @ or emoji (those are listed as not accepted, free). Duplicates are removed.", "items": { "type": "string" } }, "ideaSeeds": { "title": "Seed keywords for keyword ideas (optional)", "type": "array", "description": "Get related keyword ideas from Google Keyword Planner for these seeds, each with volume, CPC and competition. Seeds are sent 20 per request. Ideas are charged like keywords (see 'Maximum keyword ideas').", "items": { "type": "string" } }, "maxIdeas": { "title": "Maximum keyword ideas", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Most keyword ideas to return in the whole run, spread over your seeds. Each idea is charged like a keyword with data.", "default": 100 }, "ideasSort": { "title": "Order of ideas", "enum": [ "relevance", "search_volume" ], "type": "string", "description": "Which ideas are kept when there are more than 'Maximum keyword ideas'.", "default": "relevance" }, "country": { "title": "Country", "type": "string", "description": "Country of the searches: a two-letter code (US, GB, FR, DE, IN...), a country name, or WORLDWIDE for all countries together. Keyword Planner volumes depend on the country, not on the language.", "default": "US" }, "searchPartners": { "title": "Include Google search partners", "type": "boolean", "description": "Also count searches on Google's partner sites. Off: Google Search only.", "default": false }, "dateFrom": { "title": "History from (optional)", "type": "string", "description": "First month of the history, as YYYY-MM-DD. Default: the last 12 months. Google keeps four years." }, "dateTo": { "title": "History to (optional)", "type": "string", "description": "Last month of the history, as YYYY-MM-DD. Google reports whole months up to last month." }, "maxItems": { "title": "Maximum keywords with data", "minimum": 1, "type": "integer", "description": "Stop after this many keywords with data (ideas included). Keywords without data are free and do not count. Leave empty for no limit other than your maximum charge per run." } } }, "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 } } } } } } } } } }