{
  "openapi": "3.0.1",
  "info": {
    "title": "Keyword Search Volume Scraper - CPC, Difficulty & Ideas",
    "description": "Bulk keyword search volume, CPC (broad, phrase, exact), keyword difficulty, clicks, SERP features and advertisers from SpyFu's keyword database, 32 countries. Keyword ideas and domain keywords too. Filters, monitor mode. No login or API key. $0.90 per 1,000 keywords.",
    "version": "0.1",
    "x-build-id": "ZdPgXxAKZVGprdkUb"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~keyword-volume-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-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/topapi~keyword-volume-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-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/topapi~keyword-volume-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-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": {
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Keywords, one per line (\"coffee maker\", \"plumber near me\", \"best crm software\"). In Metrics mode each keyword gets its own row; in Ideas mode each is a seed for keyword ideas. 100 keywords go to SpyFu in one call, so lists of thousands are fine. Leave empty (and no domain) for a 3-keyword sample.",
            "items": {
              "type": "string"
            }
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "metrics",
              "ideas",
              "both",
              "domain"
            ],
            "type": "string",
            "description": "Metrics: volume, CPC, difficulty and clicks for the keywords you list. Ideas: keyword ideas for each keyword (the seed) with the same metrics. Metrics + ideas: both in one run. Domain: the keywords a domain ranks for in Google (fill in Domains).",
            "default": "metrics"
          },
          "domains": {
            "title": "Domains",
            "type": "array",
            "description": "Websites (\"ahrefs.com\", \"https://www.nytimes.com\") for the keywords they rank for in Google organic search: keyword, rank, rank change, ranking URL, estimated SEO clicks, plus the keyword's volume, CPC and difficulty. Used in Domain mode, or whenever filled in.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country",
            "enum": [
              "US",
              "UK",
              "CA",
              "AU",
              "NZ",
              "IE",
              "IN",
              "SG",
              "ZA",
              "DE",
              "AT",
              "CH",
              "FR",
              "BE",
              "NL",
              "IT",
              "ES",
              "PT",
              "SE",
              "NO",
              "DK",
              "FI",
              "PL",
              "CZ",
              "TR",
              "UA",
              "BR",
              "MX",
              "AR",
              "CL",
              "VE",
              "JP"
            ],
            "type": "string",
            "description": "The Google market. SpyFu keeps a keyword database for these 32 countries.",
            "default": "US"
          },
          "ideaTypes": {
            "title": "Idea types",
            "type": "array",
            "description": "Which keyword ideas to collect for each seed (Ideas mode). Related: keywords containing the seed. Questions: question keywords containing the seed. Also ranks for: keywords the pages ranking for the seed also rank for. Also buys ads for: keywords the advertisers on the seed also bid on. Transactional: buying-intent keywords containing the seed.",
            "items": {
              "type": "string",
              "enum": [
                "related",
                "questions",
                "alsoRanksFor",
                "alsoBuysAdsFor",
                "transactional"
              ],
              "enumTitles": [
                "Related keywords",
                "Questions",
                "Also ranks for",
                "Also buys ads for",
                "Transactional"
              ]
            },
            "default": [
              "related"
            ]
          },
          "maxIdeas": {
            "title": "Max ideas per seed and idea type",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many ideas to keep for each seed and idea type, highest volume first unless you sort otherwise.",
            "default": 100
          },
          "maxDomainKeywords": {
            "title": "Max keywords per domain",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many ranked keywords to keep for each domain, most organic clicks first unless you sort otherwise.",
            "default": 100
          },
          "maxItems": {
            "title": "Max rows in total",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many charged rows across the whole run. Leave empty for no limit."
          },
          "minVolume": {
            "title": "Min search volume",
            "minimum": 0,
            "type": "integer",
            "description": "Only keywords with at least this many monthly searches. Applied by SpyFu in its own query."
          },
          "maxVolume": {
            "title": "Max search volume",
            "minimum": 0,
            "type": "integer",
            "description": "Only keywords with at most this many monthly searches."
          },
          "minCpc": {
            "title": "Min CPC (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Only keywords whose broad-match cost per click is at least this."
          },
          "maxCpc": {
            "title": "Max CPC (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Only keywords whose broad-match cost per click is at most this."
          },
          "minDifficulty": {
            "title": "Min keyword difficulty",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "SpyFu's ranking difficulty, 0-100."
          },
          "maxDifficulty": {
            "title": "Max keyword difficulty",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only keywords at or under this ranking difficulty (0-100), e.g. 30 for easy wins."
          },
          "minClicks": {
            "title": "Min monthly clicks",
            "minimum": 0,
            "type": "integer",
            "description": "Only keywords whose searches lead to at least this many clicks a month."
          },
          "minWords": {
            "title": "Min words",
            "minimum": 1,
            "type": "integer",
            "description": "Only keywords with at least this many words (3+ for long-tail)."
          },
          "maxWords": {
            "title": "Max words",
            "minimum": 1,
            "type": "integer",
            "description": "Only keywords with at most this many words."
          },
          "includeTerms": {
            "title": "Must include words",
            "type": "array",
            "description": "Only keywords containing these words (SpyFu matches word forms: \"woman\" finds \"women\").",
            "items": {
              "type": "string"
            }
          },
          "includeAnyTerm": {
            "title": "Any of the words is enough",
            "type": "boolean",
            "description": "On: a keyword needs only one of the words above. Off: it needs all of them.",
            "default": false
          },
          "excludeTerms": {
            "title": "Exclude words",
            "type": "array",
            "description": "Drop keywords containing any of these words (brand names, \"free\", \"jobs\").",
            "items": {
              "type": "string"
            }
          },
          "includeAdultKeywords": {
            "title": "Include adult keywords",
            "type": "boolean",
            "description": "Keep adult keywords in idea and domain lists (SpyFu filters them out by default). Keywords you list yourself are always looked up.",
            "default": false
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "searchVolume",
              "keywordDifficulty",
              "cpc",
              "clicks",
              "paidCompetitors",
              "keyword",
              "seoClicks",
              "rank"
            ],
            "type": "string",
            "description": "Order of idea and domain lists (which rows the limits above keep). Default: search volume for ideas, organic clicks for domains."
          },
          "sortOrder": {
            "title": "Sort order",
            "enum": [
              "descending",
              "ascending"
            ],
            "type": "string",
            "description": "High to low or low to high.",
            "default": "descending"
          },
          "includeAdvertisers": {
            "title": "Advertiser history",
            "type": "boolean",
            "description": "Add the domains that bought Google ads on each keyword, month by month (often 12 months; 'advertisers_by_month'). Without it each row still carries the latest month's top 10 advertisers and their count. Same price.",
            "default": false
          },
          "includeNotFound": {
            "title": "Rows for keywords SpyFu does not know",
            "type": "boolean",
            "description": "In Metrics mode, a keyword missing from SpyFu's database for the country gets a row with found: false. These rows are free.",
            "default": true
          },
          "dedupe": {
            "title": "One row per keyword",
            "type": "boolean",
            "description": "On: a keyword found under several seeds or idea types is delivered (and charged) once. Off: once per seed and idea type, with its seed_keyword and idea_type.",
            "default": true
          },
          "monitorMode": {
            "title": "Monitor mode",
            "type": "boolean",
            "description": "Remember what earlier runs delivered (same input, same monitor name). A run then delivers only new keywords and keywords whose volume or CPC moved by the threshold below, difficulty by 5+ points or rank changed, with the previous values; unchanged keywords are skipped and not charged.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Keeps separate memories for separate schedules of the same input.",
            "default": "default"
          },
          "changeThresholdPct": {
            "title": "Change threshold (%)",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "In monitor mode, a keyword counts as changed when its search volume or CPC moved by at least this percent.",
            "default": 10
          },
          "emitBaseline": {
            "title": "Deliver the first run",
            "type": "boolean",
            "description": "On: the first monitor run delivers everything it finds. Off: it only records them (nothing delivered or charged) and later runs deliver changes.",
            "default": true
          },
          "resetMonitor": {
            "title": "Reset the monitor memory",
            "type": "boolean",
            "description": "Forget what earlier runs delivered and start again.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. By default the run calls SpyFu directly and moves one rung up (Apify datacenter, then residential) only if SpyFu refuses an egress."
          },
          "maxConcurrency": {
            "title": "Parallel calls",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "SpyFu calls in flight at once.",
            "default": 8
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}