{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Maps Scraper - User friendly",
    "version": "0.1",
    "x-build-id": "Hb7PFb72XHgGmEees"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/data_ops_main~easy-google-maps-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-data_ops_main-easy-google-maps-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/data_ops_main~easy-google-maps-scraper/runs": {
      "post": {
        "operationId": "runs-sync-data_ops_main-easy-google-maps-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/data_ops_main~easy-google-maps-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-data_ops_main-easy-google-maps-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": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "What to look for on Google Maps, e.g. 'coffee shop', 'dentist', 'hotel'. Add as many as you like — each one is searched across every location.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Free-text place to search in, e.g. 'San Francisco, California, USA' or 'Camden, London'. Resolved automatically to a map area — you never need to draw a polygon."
          },
          "maxPlacesPerSearch": {
            "title": "Max places per search term",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Upper bound on results returned for each search term (across all locations and map tiles). Keep this modest for your first run so it stays cheap.",
            "default": 50
          },
          "preset": {
            "title": "Preset",
            "enum": [
              "none",
              "lead-generation",
              "review-analysis",
              "quick-scan"
            ],
            "type": "string",
            "description": "Optional one-click configuration. A preset only fills fields you have left at their default — anything you set yourself always wins.",
            "default": "none"
          },
          "locations": {
            "title": "Multiple locations",
            "type": "array",
            "description": "Search several locations in one run and get a single merged, de-duplicated dataset. No paid orchestrator needed. Used in addition to the single 'Location' field above.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country",
            "type": "string",
            "description": "Structured location part. Combined with state/city/postal code into a single location query."
          },
          "state": {
            "title": "State / region",
            "type": "string",
            "description": "Structured location part."
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "Structured location part."
          },
          "postalCode": {
            "title": "Postal / ZIP code",
            "type": "string",
            "description": "Structured location part."
          },
          "startUrls": {
            "title": "Google Maps URLs",
            "type": "array",
            "description": "Direct Google Maps URLs — a search results URL, a place URL, or a shortened goo.gl/maps link. Scraped as-is in addition to any search terms.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "placeIds": {
            "title": "Place IDs / CIDs",
            "type": "array",
            "description": "Scrape specific places directly by Google place ID (ChIJ...) or numeric CID. One per line.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "customGeolocation": {
            "title": "Custom geolocation (advanced override)",
            "type": "object",
            "description": "Optional GeoJSON Polygon/MultiPolygon, or an object {\"type\":\"circle\",\"coordinates\":[lng,lat],\"radiusKm\":5}. Overrides automatic location resolution. Leave empty to let the actor resolve and tile the area for you."
          },
          "maxTotalPlaces": {
            "title": "Max total places (hard cap)",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Absolute ceiling on dataset size for the whole run, no matter how many search terms or locations are supplied. Protects you from a runaway bill.",
            "default": 1000
          },
          "language": {
            "title": "Results language",
            "type": "string",
            "description": "Two-letter language code used for Google Maps content (hl parameter).",
            "default": "en"
          },
          "regionCode": {
            "title": "Region / country bias",
            "type": "string",
            "description": "Two-letter country code used to bias results (gl parameter), e.g. 'us', 'gb', 'de'.",
            "default": "us"
          },
          "maxReviews": {
            "title": "Max reviews per place",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Reviews to scrape per place. 0 = skip reviews entirely (fastest, cheapest). Reviews contain reviewer names, which are personal data — see the compliance section below.",
            "default": 0
          },
          "reviewsSort": {
            "title": "Reviews sort order",
            "enum": [
              "newest",
              "mostRelevant",
              "highestRanking",
              "lowestRanking"
            ],
            "type": "string",
            "description": "Order in which reviews are fetched.",
            "default": "newest"
          },
          "scrapeContactDetails": {
            "title": "Enrich with contact details",
            "type": "boolean",
            "description": "Visit each place's website and extract emails, extra phone numbers and social media profiles (Facebook, Instagram, LinkedIn, X/Twitter, YouTube, TikTok). Bundled at no extra charge. Emails and social profiles can be personal data — requires the personal-data opt-in below.",
            "default": false
          },
          "maxEnrichmentPagesPerSite": {
            "title": "Max pages to scan per website",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "When enriching, how many pages of each website to scan (home page plus likely 'contact' pages).",
            "default": 3
          },
          "incrementalMode": {
            "title": "Incremental / delta mode",
            "type": "boolean",
            "description": "Remember which places were seen on previous runs (stored in a named key-value store). Lets the actor detect new, changed and closed places between runs.",
            "default": false
          },
          "onlyNewOrChanged": {
            "title": "Output only new or changed places",
            "type": "boolean",
            "description": "When incremental mode is on, push only places that are new or whose key fields changed since the last run. Unchanged places are skipped.",
            "default": false
          },
          "stateStoreName": {
            "title": "State store name",
            "type": "string",
            "description": "Name of the named key-value store used to persist incremental state. Use the same name across runs of the same monitoring job. Leave empty to auto-name it per actor.",
            "default": ""
          },
          "scrapePersonalData": {
            "title": "I have a lawful basis to scrape personal data",
            "type": "boolean",
            "description": "Master opt-in for personal data: reviewer names/IDs, scraped emails and social profiles. When OFF, those fields are omitted even if reviews/enrichment are enabled. You are responsible for compliance with Google's Terms and applicable law (GDPR/CCPA). See the README.",
            "default": false
          },
          "listingMode": {
            "title": "Listing mode",
            "enum": [
              "auto",
              "http",
              "browser"
            ],
            "type": "string",
            "description": "'auto' (recommended) tries a cheap HTTP request first and automatically falls back to a headless browser if HTTP returns nothing. 'http' forces HTTP only — fastest, but depends on Google's frequently-rotated internal format, so treat it as experimental. 'browser' forces the headless Chromium path, which is the most robust.",
            "default": "auto"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum parallel requests.",
            "default": 10
          },
          "maxRequestRetries": {
            "title": "Max request retries",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "How many times to retry a blocked or failed request before giving up on it.",
            "default": 5
          },
          "minTileResultsToSubdivide": {
            "title": "Tile subdivision threshold",
            "minimum": 20,
            "maximum": 120,
            "type": "integer",
            "description": "A map tile is split into 4 sub-tiles when it returns at least this many results (i.e. it likely hit Google's per-view cap). Lower = more thorough but more requests.",
            "default": 100
          },
          "maxTileDepth": {
            "title": "Max tile subdivision depth",
            "minimum": 0,
            "maximum": 7,
            "type": "integer",
            "description": "How many times a tile may be recursively quartered. Each level multiplies coverage and cost. 4 is plenty for a city.",
            "default": 4
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Google Maps blocks datacenter IPs aggressively — RESIDENTIAL proxy is strongly recommended and is the default.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}