Skip to content

Free, open-source Google Maps scraper for lead generation (Python, no API key, no Docker). Exports name, phone, email, website, rating and Instagram/Facebook/LinkedIn/TikTok/YouTube/X links to CSV. 100 places with emails in 44 s; --grid beats Google's 120 cap. MX email check, ad-pixel detection. Skill for Claude Code, Codex and Cursor.

2.6 KB
Raw Blame
# Local config for the kit. Copy it to ".env" and edit only what you need:  cp .env.example .env
#
# No API key is required. The engine listens on 127.0.0.1 only, so other machines cannot reach it,
# and it refuses requests whose Host or Origin is not localhost (web pages in your browser).

# Port the engine serves on, with or without Docker. Default: 8080. Change this line (do not add a
# second one) if 8080 is already taken, then start the engine again (python3 scripts/engine.py
# restart, or docker compose up -d). The engine, compose and the scripts all read it from this file.
SCRAPER_PORT=8080

# Full URL of the engine's API. Default: unset, so the scripts use http://localhost:<SCRAPER_PORT>.
# Set it only if the engine runs somewhere else. When set, the scripts ignore SCRAPER_PORT.
# scrape.py then talks to that engine; engine.py start/stop/status/jobs manage one on this machine only.
# SCRAPER_BASE_URL=http://localhost:8080

# A second copy of the kit on the same machine (your fork next to the original, a test clone):
# change SCRAPER_PORT above to a free port. That is all scripts/engine.py needs: each copy keeps its
# own .engine/ folder. With Docker, also give the copy its own Compose project name, or
# "docker compose up -d" takes over the other copy's container ("docker compose ls" lists the
# names in use; your initials or the folder name work well):
# COMPOSE_PROJECT_NAME=gmaps-kit-mj

# Optional key. When set, the engine answers only requests with this value in an X-API-Key header,
# and the scripts send it. Default: blank, which is right for local use. The web UI asks for it.
SCRAPER_API_KEY=

# Window mode. Default: unset, so Chrome runs headless. Headless, the engine sends Chrome's own user
# agent with HeadlessChrome replaced by Chrome, so Google returns review counts, the week's hours and
# reviews. Set it to 0 and restart the engine (python3 scripts/engine.py restart) to run Chrome as a
# normal window placed off-screen instead, with its user agent unchanged. A window needs a display
# and an installed Chrome, Chromium, Edge or Brave (the downloaded headless shell cannot open one);
# on macOS a second Chrome icon shows in the Dock and the window may take focus when a job starts.
# Not used in Docker, where Chrome is always headless.
# SCRAPER_HEADLESS=0

# Update notice. Default: on. `python3 scripts/engine.py status` and the web UI ask GitHub's public
# releases endpoint once a day whether a newer kit is out (nothing about you in the request) and say
# so; nothing updates itself. Set 1 to turn the check off (the web UI's check is in your browser and
# is not affected by this file).
# SCRAPER_NO_UPDATE_CHECK=1