{
  "openapi": "3.0.1",
  "info": {
    "title": "Keyword Search Volume & Ideas: Google Ads Data, Pay per Keyword",
    "description": "Google Ads search volume, CPC, competition and 12-month trend for up to 10,000 keywords, plus keyword ideas from seeds or a URL, for any country and language. $0.002 per keyword with data + $0.12 per 1,000-keyword batch; empty results are free.",
    "version": "0.1",
    "x-build-id": "9nDXGYIA6E1an9K4X"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/stubborn_otter~keyword-search-volume/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-stubborn_otter-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/stubborn_otter~keyword-search-volume/runs": {
      "post": {
        "operationId": "runs-sync-stubborn_otter-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/stubborn_otter~keyword-search-volume/run-sync": {
      "post": {
        "operationId": "run-sync-stubborn_otter-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": "Mode",
            "enum": [
              "metrics",
              "ideas",
              "ideasFromUrl"
            ],
            "type": "string",
            "description": "Metrics: search volume, CPC, competition and 12-month trend for exactly the keywords you list. Ideas: related keywords (with the same metrics) for up to 20 seed keywords. Ideas from a URL: keywords Google Ads associates with a site or page.",
            "default": "metrics"
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "One keyword per line. Metrics mode: up to 10,000 keywords (duplicates are removed; case doesn't matter). Ideas mode: up to 20 seed keywords. Each keyword: at most 80 characters and 10 words, no emoji or symbols such as ! @ % * ? , | — rejected keywords are listed with the reason and never charged. Pricing: $0.002 per keyword that has Google data, plus $0.12 per batch of up to 1,000 keywords sent to DataForSEO. Keywords Google reports no data for are free. 5 keywords ≈ $0.13, 50 ≈ $0.22, 1,000 ≈ $2.12.",
            "items": {
              "type": "string"
            }
          },
          "targetUrl": {
            "title": "Website or page (ideas from a URL)",
            "type": "string",
            "description": "Only for 'Ideas from a URL': a domain such as example.com, or a page URL such as https://example.com/blog/post."
          },
          "targetType": {
            "title": "Use the whole site or one page",
            "enum": [
              "site",
              "page"
            ],
            "type": "string",
            "description": "Only for 'Ideas from a URL': 'site' finds keywords for the whole domain; 'page' for that one URL.",
            "default": "site"
          },
          "maxIdeas": {
            "title": "Max ideas",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Ideas modes: keep at most this many ideas (1–10,000), chosen by 'Sort ideas by'. You're charged only for kept ideas with data, so 100 ideas cost at most $0.12 + $0.20.",
            "default": 100
          },
          "sortBy": {
            "title": "Sort ideas by",
            "enum": [
              "relevance",
              "search_volume",
              "competition_index",
              "low_top_of_page_bid",
              "high_top_of_page_bid"
            ],
            "type": "string",
            "description": "Ideas modes: which ideas to keep when cutting to 'Max ideas', and their order. Metrics mode always keeps your order.",
            "default": "relevance"
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Country name or ISO code (United States, US, Germany, DE, …), a DataForSEO location code for a region or city (e.g. 1023191 for New York), or 'worldwide'. A typo lists the closest matches.",
            "default": "United States"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Language name or code (English, en, German, de, …), or 'any' for all languages.",
            "default": "English"
          },
          "searchPartners": {
            "title": "Include Google search partners",
            "type": "boolean",
            "description": "Off: Google Search only (what Keyword Planner shows by default). On: Google Search plus search partner sites.",
            "default": false
          },
          "includeAdultKeywords": {
            "title": "Include adult keywords",
            "type": "boolean",
            "description": "Ideas modes: also return adult keyword ideas. Off by default, as in Keyword Planner.",
            "default": false
          },
          "useCache": {
            "title": "Reuse results from the last 7 days",
            "type": "boolean",
            "description": "Metrics mode: keywords you checked in the last 7 days (same location, language and network) come from a cache in your own Apify account, with 'cached_at' set. They cost $0.002 each and need no batch fee. Google publishes volumes monthly, so a week-old result is current. Off: always ask DataForSEO.",
            "default": true
          },
          "includeSummaryRow": {
            "title": "Add a summary row at the end",
            "type": "boolean",
            "description": "Also push the run summary as the last dataset item (type 'summary'). Off by default so the dataset stays a clean table. The summary is always in the OUTPUT record.",
            "default": false
          },
          "dataforseoLogin": {
            "title": "Your DataForSEO API login (optional)",
            "type": "string",
            "description": "The API login from app.dataforseo.com/api-access (usually your email address)."
          },
          "dataforseoPassword": {
            "title": "Your DataForSEO API password (optional)",
            "type": "string",
            "description": "The API password from app.dataforseo.com/api-access. It is generated by DataForSEO and differs from your account password."
          },
          "maxVendorSpendUsd": {
            "title": "Max DataForSEO spend per run (your login)",
            "minimum": 0.09,
            "type": "number",
            "description": "Only with your own login: stop sending batches once this run has spent this much of your DataForSEO balance (one batch is about $0.09). Keywords beyond it are listed as skipped and not charged.",
            "default": 1
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}