{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Search Scraper: SERP, Ads & AI Overview",
    "description": "Scrape Google search results for any keyword and country: organic rank, title, URL, snippet, date, sitelinks, People also ask, related searches, AI Overview and ads. Rank tracking, SEO research.",
    "version": "0.1",
    "x-build-id": "bRufNUqdl1CjgktMd"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tortuga~google-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tortuga-google-search-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/tortuga~google-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-tortuga-google-search-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/tortuga~google-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-tortuga-google-search-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": {
          "queries": {
            "title": "Search terms or Google search URLs",
            "type": "array",
            "description": "One Google search per line: a search term as you would type it on Google (\"best running shoes\", \"site:example.com pricing\", \"\\\"your brand\\\" reviews\") or a full Google search URL such as https://www.google.co.uk/search?q=coffee&hl=en. Google operators (site:, intitle:, filetype:, quotes, -word, after:2026-01-01) work. A URL keeps its own domain, country (gl), language (hl), start page and filters.",
            "items": {
              "type": "string"
            }
          },
          "maxPagesPerQuery": {
            "title": "Results pages per search",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many Google results pages to read per search term (page 1, 2, 3, ...). A page has up to 10 organic results (often 6-10, because Google mixes in videos, forums and other blocks). Each page is one request through Apify's Google SERP proxy. The actor stops earlier when Google has no next page.",
            "default": 1
          },
          "countryCode": {
            "title": "Country",
            "enum": [
              "us",
              "gb",
              "ca",
              "au",
              "in",
              "de",
              "fr",
              "es",
              "it",
              "nl",
              "br",
              "mx",
              "jp",
              "pl",
              "se",
              "ch",
              "ie",
              "nz",
              "sg",
              "za"
            ],
            "type": "string",
            "description": "Country whose Google results you get: sets the Google domain (google.co.uk for United Kingdom, ...), Google's gl parameter and a country-level location, so results do not depend on where the proxy happens to exit. For another country, paste a Google search URL with its domain or gl= (e.g. https://www.google.com.ar/search?q=...&gl=ar; about 50 countries are supported that way).",
            "default": "us"
          },
          "languageCode": {
            "title": "Interface language (hl)",
            "type": "string",
            "description": "Google interface language, e.g. en, de, fr, es, pt-BR. It changes snippets, dates and labels and can change rankings. Leave empty to use the country's main language (English for the US, UK, India, ...)."
          },
          "location": {
            "title": "Exact location (optional)",
            "type": "string",
            "description": "Best effort: search as if you were in a city or region, using Google's canonical location name: \"Austin,Texas,United States\", \"Manchester,England,United Kingdom\", \"Munich,Bavaria,Germany\" (sent as Google's uule parameter). Google applies it on some requests only (local results on 3 of 7 test requests for \"plumber near me\"); the summary row's detectedLocation shows the location Google reported. Leave empty for the whole country."
          },
          "timePeriod": {
            "title": "Time period",
            "enum": [
              "any",
              "hour",
              "day",
              "week",
              "month",
              "year"
            ],
            "type": "string",
            "description": "Only results Google dates within this period (Google's Tools > Any time filter).",
            "default": "any"
          },
          "searchLanguage": {
            "title": "Only pages in language (lr)",
            "type": "string",
            "description": "Optional: only pages written in this language (Google's lr parameter), e.g. de, fr, en. Leave empty for all languages."
          },
          "includeSerpFeatures": {
            "title": "SERP summary row per page",
            "type": "boolean",
            "description": "Add one row per results page (type 'serp') with People also ask questions, related searches (\"People also search for\"), the AI Overview text and its sources, Top stories / posts, the list of SERP features Google showed and how many organic results and ads the page had. Charged as one result. Not output in monitoring mode.",
            "default": true
          },
          "includeAds": {
            "title": "Include ads",
            "type": "boolean",
            "description": "Also output Google's text ads (type 'ad'): placement (top/bottom), position, title, advertiser, displayed URL, domain, landing URL and description. Each ad is one result (no add-on fee). Ads are read from the page, never clicked.",
            "default": false
          },
          "maxItems": {
            "title": "Max rows",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many rows in total (organic results, ads and SERP summary rows of all searches). You pay per row, so this caps the cost.",
            "default": 1000
          },
          "safeSearch": {
            "title": "SafeSearch",
            "type": "boolean",
            "description": "Filter explicit results (Google's safe=active).",
            "default": false
          },
          "includeUnfilteredResults": {
            "title": "Include omitted similar results",
            "type": "boolean",
            "description": "Show the results Google hides as 'very similar to the ones already displayed' (filter=0).",
            "default": false
          },
          "onlyNewOrChanged": {
            "title": "Only new or changed items",
            "type": "boolean",
            "description": "Remember what earlier runs of this search returned and output only new items or items whose price/status changed. Use with a Schedule; unchanged items are not charged. For Google: a result is 'new' when its URL was not in earlier runs of this watch (same term, country and language) and 'changed' when its position moved; previousValues holds the old position. Ads and SERP summary rows are not output in this mode.",
            "default": false
          },
          "monitoringKey": {
            "title": "Monitoring key",
            "type": "string",
            "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input"
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Google results pages load only through Apify's Google SERP proxy (group GOOGLE_SERP), which Apify bills per results page: $0.0025 per page on the Free and Starter plans ($0.002 on Scale, $0.0017 on Business). The actor always uses it. Resolving Google's redirect links uses the run's own IP (free) and, as a fallback, Apify datacenter proxy.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "GOOGLE_SERP"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}