gmaps-scraper: Instructions file for Codex

AGENTS.md

gmaps-scraper AGENTS.md is an instructions file for Codex, OpenCode from nick-choudhary/gmaps-scraper. It costs 2,208 tokens per session, scanned A, original, MIT.

Repository guidance for gmaps-scraper, a Python library that collects Google Maps business data through HTTP requests rather than browser automation or an official API key.

In plain words
What is it for?
Searching for businesses, collecting results by location, retrieving place details, and optionally finding contact information from business websites.
Why use it?
It gives agents the supported commands and a quick health check, helping them avoid unsupported scraping methods and investigate broken tests or imports first.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

This is nick-choudhary/gmaps-scraper's own configuration. It tells Codex and OpenCode how to work on gmaps-scraper itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything gmaps-scraper configures →

Reuse

Borrowing it

Nothing to install: this file belongs to nick-choudhary/gmaps-scraper. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/nick-choudhary/gmaps-scraper/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/nick-choudhary/gmaps-scraper

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for gmaps-scraper AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/nick-choudhary/gmaps-scraper/agents-md.svg)](https://agentmods.dev/instructions/nick-choudhary/gmaps-scraper/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/nick-choudhary/gmaps-scraper/agents-md"><img src="https://agentmods.dev/badge/instructions/nick-choudhary/gmaps-scraper/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 2,208 This file is loaded in full into every session.
When invoked 2,208 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.02208 $0.02208
Opus 5 $0.01104 $0.01104
Sonnet 5 $0.00442 $0.00442
Haiku 4.5 $0.00221 $0.00221

Measured 6d ago against content hash df7defe7cab8, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

gmaps-scraper AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 180 lines

How it starts

The opening of the file, as written. The whole thing — 180 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md — gmaps-scraper

Guide for AI agents (Claude, Cursor, Copilot, etc.) working on this codebase. Read this first before making any changes.

What This Project Is

A Python library that scrapes Google Maps business data using reverse-engineered internal APIs. No official API key. No browser automation. Pure HTTP with the pb= protobuf URL parameter protocol.

If you're an AI agent and a user asks you to:

  • "Find coffee shops in Austin" → use gmaps search "coffee shops in Austin"
  • "Comprehensively scrape chiropractors in Atlanta" → use gmaps collect "chiropractors" --location "Atlanta, Georgia" -o atlanta.json
  • "Scrape at most 20 business websites for contacts" → add --max-contacts 20
  • Use gmaps grid ... --bbox ... only when an advanced caller already has an exact boundary.
  • "Get details for this place" → use gmaps place ChIJ... --enrich
  • "Modify the scraper" → read the sections below

Before You Start

Quick Health Check

cd gmaps-scraper
python -m pytest tests/ -q          # should show 266 passed
python -c "import gmaps; print('OK')" # should print OK

If tests fail or import breaks, stop and investigate before making changes.

Understand the Architecture (2-minute read)

GMapsClient (client.py)          ← entry point, 3 modes
  ├── CookieSession (_auth/)     ← NID/AEC/SOCS consent flow
  ├── HTTPTransport (transport.py) ← UA rotation, jitter, retries
  ├── SearchAPI (_search.py)     ← Phase 1 search + Phase 2 details
  │     ├── places()             ← /search?tbm=map
  │     ├── place_details()      ← /maps/preview/place
  │     └── grid_search()        ← grid subdivision for area coverage
  └── Parser (rpc/parser.py)     ← 58 fields → 8 grouped JSON objects

Three operating modes:

  1. Default: Fast search only (~15 fields, no login)
  2. Enrich: GMapsClient(enrich=True) → search + place details (~30 fields)
  3. Login: GMapsClient(enrich=True, login_cookies="...") → full data (~40 fields)

Read the full file on GitHub · 180 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 6d ago First seen · 180 lines · 2,208 tokens per session scan A df7defe7cab8

Subscribe to this mod's changes

gmaps-scraper AGENTS.md is an instructions file published in the GitHub repository nick-choudhary/gmaps-scraper (3 stars, last pushed 1mo ago), licensed MIT. It adds 2,208 tokens to every session, about $0.0110 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens