{
  "openapi": "3.0.1",
  "info": {
    "title": "Keyword Search Volume, CPC & Difficulty Checker",
    "description": "Google search volume, CPC, competition, keyword difficulty, search intent and monthly trend for up to 10,000 keywords per run, by country or city, plus keyword ideas from a seed. No account or API key. Export to JSON, CSV or Excel.",
    "version": "0.0",
    "x-build-id": "9wIhLTHxC7UTkilan"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nice_dev~keyword-volume-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nice_dev-keyword-volume-scraper",
        "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/nice_dev~keyword-volume-scraper/runs": {
      "post": {
        "operationId": "runs-sync-nice_dev-keyword-volume-scraper",
        "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/nice_dev~keyword-volume-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-nice_dev-keyword-volume-scraper",
        "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": "Mode",
            "enum": [
              "metrics",
              "ideas"
            ],
            "type": "string",
            "description": "**Keyword metrics**: data for exactly the keywords you give. **Keyword ideas**: each keyword is a seed; the Actor finds the related searches people type (seed + a…z + question words) and returns the metrics of every idea, the seed included.",
            "default": "metrics"
          },
          "query": {
            "title": "Keyword",
            "maxLength": 200,
            "type": "string",
            "description": "One keyword or phrase (e.g. `running shoes`). Put more in **Keywords** below."
          },
          "searchQueries": {
            "title": "Keywords",
            "maxItems": 10000,
            "uniqueItems": true,
            "type": "array",
            "description": "Your keyword list, one per line (up to 10 000). Added to **Keyword**; duplicates (case ignored) are looked up once. In Ideas mode each line is a seed.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Location",
            "maxLength": 200,
            "type": "string",
            "description": "Where the volumes are counted: a country (`France` or its 2-letter code `fr`), `worldwide` (all countries together), a city written as `City, Country` (`Paris, France`; with a region `Springfield, Illinois, United States`) or a Google Ads location id (`1023191`). Always add the country to a city: many towns share a name (`Paris` alone may give an American town) and the log tells which one was used. States and regions alone are not available, only countries and cities. An id that is not a country is used as given: its rows have `cpcUsd` but no `cpc` (currency unknown). Empty = United States."
          },
          "locations": {
            "title": "More locations",
            "maxItems": 100,
            "uniqueItems": true,
            "type": "array",
            "description": "Several locations in one run, written as in **Location** (`France`, `Paris, France`, `1023191`, `worldwide`): every keyword is looked up in every location (3 keywords × 4 locations = 12 rows). Added to **Location**. Max 100.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "language": {
            "title": "Language",
            "maxLength": 5,
            "type": "string",
            "description": "2-letter language code of the searches (`en`, `fr`, `de`, `ja`…). Empty = the main language of each location (French for France, English for worldwide)."
          },
          "maxItems": {
            "title": "Max keywords",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum number of keyword rows to save for the whole run (after deduplication and filters). 0 = no limit.",
            "default": 1000
          },
          "maxItemsPerQuery": {
            "title": "Max ideas per seed",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Ideas mode: cap for EACH seed keyword × location, so that the first seed cannot use up the whole **Max keywords** budget (a seed gives a few hundred ideas; its own row counts). 0 = no per-seed cap. In Keyword metrics mode it caps the rows of each location.",
            "default": 0
          },
          "extractDetails": {
            "title": "Full keyword data",
            "type": "boolean",
            "description": "On: monthly searches of the last months, search intent, mobile / desktop share, click rate (organic / paid / no click), searcher age and gender, and search volume in the other countries. Off: volume, CPC and competition only (faster, cheaper per keyword, see Pricing).",
            "default": false
          },
          "includeDifficulty": {
            "title": "Keyword difficulty (paid add-on)",
            "type": "boolean",
            "description": "Add the SEO difficulty (how hard it is to rank in the top 10 organic results, 0-100) and the paid difficulty (how crowded the ads are, 0-100) to each keyword. Charged per keyword that has them (see Pricing).",
            "default": false
          },
          "includeQuestionIdeas": {
            "title": "Question ideas",
            "type": "boolean",
            "description": "Ideas mode: also expand each seed with question and comparison words (`how`, `what`, `why`, `best`, `vs`, `for`…), in the language of the search (English, French, German, Spanish, Italian, Portuguese, Dutch; other languages get the English words).",
            "default": true
          },
          "includeNotFound": {
            "title": "Keep keywords without data",
            "type": "boolean",
            "description": "Save a row with `found: false` for each keyword the source returns no data for (a keyword nobody searches comes back with 0 searches, a normal row): in Keyword metrics mode the output then keeps one row per input keyword, in Keyword ideas mode an idea without data is kept too. These rows are free.",
            "default": true
          },
          "minVolume": {
            "title": "Min search volume",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Only keywords with at least this many monthly searches. 0 = no minimum.",
            "default": 0
          },
          "maxVolume": {
            "title": "Max search volume",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Only keywords with at most this many monthly searches (find long-tail keywords). 0 = no maximum.",
            "default": 0
          },
          "minCpc": {
            "title": "Min CPC (USD)",
            "minimum": 0,
            "maximum": 10000,
            "type": "number",
            "description": "Only keywords whose cost per click, in US dollars, is at least this. 0 = no minimum.",
            "default": 0
          },
          "maxDifficulty": {
            "title": "Max SEO difficulty",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only keywords whose SEO difficulty (0-100) is at most this. Works with or without the difficulty add-on. 0 = no maximum.",
            "default": 0
          },
          "excludeKeywords": {
            "title": "Exclude keywords",
            "maxItems": 50,
            "uniqueItems": true,
            "type": "array",
            "description": "Drop the keywords that contain one of these words (case and accents ignored), e.g. `free`, `amazon`.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "onlyNew": {
            "title": "Only new keywords",
            "type": "boolean",
            "description": "Skip the keywords (same keyword, location and language) that a previous run with the same **Memory key** already delivered: they are not saved and not charged. First run = everything is new.",
            "default": false
          },
          "stateKey": {
            "title": "Memory key",
            "pattern": "^[a-zA-Z0-9_-]{1,64}$",
            "maxLength": 64,
            "type": "string",
            "description": "Name of the memory used by **Only new keywords**. Give each schedule / task its own key (e.g. `shoes-ideas`) so that they do not share their memory. Letters, digits, `-` and `_`.",
            "default": "default"
          },
          "resetState": {
            "title": "Reset the memory",
            "type": "boolean",
            "description": "Forget everything remembered under this **Memory key** before the run: this run returns (and charges) every keyword again. Untick it afterwards.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify Proxy or your own proxies. Keep the default: it is included in the price. The residential Apify proxy is not available in this Actor.",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum number of requests processed in parallel.",
            "default": 10
          },
          "maxRequestsPerMinute": {
            "title": "Max requests per minute",
            "minimum": 10,
            "maximum": 2000,
            "type": "integer",
            "description": "Most requests in any 60 seconds, all of them counted (keyword data and idea lookups). A budget, not an even pace: up to this many can leave at once when the minute starts (spread them with the minimum delay below). Lower it if the log shows HTTP 429 / 403.",
            "default": 600
          },
          "minRequestIntervalMs": {
            "title": "Min delay between requests",
            "minimum": 0,
            "maximum": 60000,
            "type": "integer",
            "description": "Smallest gap between two requests, in milliseconds. Unlike the per-minute rate, this spreads the requests evenly instead of letting them go out in a burst. 0 = no gap.",
            "default": 0
          },
          "maxRequestRetries": {
            "title": "Max request retries",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Retries per request before it is marked as failed. Behind a proxy, a request that is turned away is also retried on a new proxy session up to 10 times without using up these retries.",
            "default": 5
          },
          "debugLog": {
            "title": "Debug log",
            "type": "boolean",
            "description": "Include debug messages in the run log.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}