{ "openapi": "3.0.1", "info": { "title": "Google Maps Scraper — Rank Tracking & Market Intelligence", "description": "Scrapes Google Maps and returns a market intelligence read: saturation, underserved areas, competitor movers, geo-grid rank, Share of Local Voice, and tracked market history. Replaces a monthly local-SEO subscription for agencies, franchises, and investors. Pay-per-event.", "version": "1.0", "x-build-id": "1jvay9A5PkY9XN7zv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ryanclinton~google-maps-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ryanclinton-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/ryanclinton~google-maps-scraper/runs": { "post": { "operationId": "runs-sync-ryanclinton-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/ryanclinton~google-maps-scraper/run-sync": { "post": { "operationId": "run-sync-ryanclinton-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", "required": [ "searchTerms", "location" ], "properties": { "searchTerms": { "title": "Category or keywords", "type": "array", "description": "What to search for on Google Maps, e.g. [\"dentist\"] or [\"coffee shop\", \"cafe\"]. In geo_grid mode these are the keywords to rank for.", "default": [ "dentist" ], "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "City, area, or postcode to center the market read around, e.g. \"Austin, TX\" or \"BT9 6AA\".", "default": "Austin, TX" }, "coordinates": { "title": "Center coordinates (optional)", "type": "string", "description": "Optional. Center the market read on exact coordinates as \"lat,lng\", e.g. \"30.27,-97.74\". Overrides the location text when set." }, "mode": { "title": "Mode", "enum": [ "market", "competitors", "geo_grid", "places", "watchlist", "replay" ], "type": "string", "description": "market (default): whole-category saturation, gaps, competitor analysis. competitors: track a focal business and who is gaining around it. geo_grid: local rank tracker — where a business ranks across a grid with Share of Local Voice. places: per-business intelligence. watchlist: what changed since the last run. replay: a business's full history.", "default": "market" }, "rankBy": { "title": "Rank results by", "enum": [ "opportunity", "competitivePosition", "momentum", "rating", "reviews", "recency" ], "type": "string", "description": "How to order businesses in the output. opportunity (default) and competitivePosition and momentum are reads no plain Maps scraper ships.", "default": "opportunity" }, "outputProfile": { "title": "Output profile", "enum": [ "signals", "compat", "minimal" ], "type": "string", "description": "signals (default) = full market intelligence on top of every business. compat = exact field set of the leading Maps scraper for drop-in migration and raw ingestion. minimal = name, rating, reviews, location only.", "default": "signals" }, "intent": { "title": "What's the job?", "enum": [ "assess_market", "track_competitors", "site_selection", "monitor_client" ], "type": "string", "description": "Optional shortcut: pick your job and the actor sets a sensible mode, ranking, and output pack for you. Leave blank to control them yourself below." }, "outputPack": { "title": "Output pack", "enum": [ "agency_audit", "client_monitor", "site_selection", "franchise_rollout", "investor_scan", "raw_compat" ], "type": "string", "description": "A branded preset that decides which views lead, how deep the review sample goes, and whether change-tracking is on. Tuned for a specific buyer." }, "focalBusiness": { "title": "Focal business", "type": "string", "description": "For competitors / geo_grid mode: the business you're tracking. A name (\"Smile Dental Austin\"), a Google Maps place URL, or a place ID (ChIJ...)." }, "places": { "title": "Places (URLs / IDs / names)", "type": "array", "description": "For places / replay mode: a list of business names, Google Maps place URLs, place IDs, or feature IDs to return intelligence for.", "items": { "type": "string" } }, "grid": { "title": "Geo-grid settings", "type": "object", "description": "For geo_grid mode: { \"size\": 5, \"spacingMeters\": 800, \"rankDepth\": 20 } lays a 5x5 grid 800m apart and checks the top 20 results at each point.", "default": { "size": 5, "spacingMeters": 800, "rankDepth": 20 } }, "area": { "title": "Area (polygon / circle)", "type": "object", "description": "Optional. A polygon, multipolygon, or circle to read a market wider than a single map screen returns. e.g. { \"type\": \"circle\", \"center\": [-97.74, 30.27], \"radiusMeters\": 4000 }.", "default": {} }, "filters": { "title": "Filters", "type": "object", "description": "Optional. { \"minStars\": 3.5, \"hasWebsite\": true, \"skipClosed\": true, \"category\": \"...\", \"priceBracket\": [\"$$\"] }.", "default": {} }, "alerts": { "title": "Alerts", "type": "object", "description": "Optional. { \"minOpportunityScore\": 60, \"newCompetitorAlert\": true, \"ratingDropAlert\": true, \"severity\": \"medium\" } controls which changes are flagged as market cards.", "default": {} }, "watchlistName": { "title": "Watchlist name", "type": "string", "description": "Name a watchlist to track this market over time. Re-running with the same name returns what changed since last run: new competitors, closures, rating moves, rank changes. The agency-retainer feed, automated." }, "reportFrequency": { "title": "Recurring report", "enum": [ "weekly", "monthly", "quarterly" ], "type": "string", "description": "Emit a recurring market brief (movers, new entrants, closures, ranking changes). Pair with an Apify schedule to deliver it weekly/monthly/quarterly." }, "enableMarketMemory": { "title": "Build market history", "type": "boolean", "description": "When on (default), every run records a timestamped snapshot of the businesses and market it touches, so openings, closures, and rating trajectory accumulate over time — the history Maps throws away. Turn off to opt out of contributing to and reading from market history.", "default": true }, "limits": { "title": "Limits", "type": "object", "description": "Optional. { \"maxPlaces\": 120, \"maxReviewsPerPlace\": 20, \"reviewSamplePlaces\": 12 } bound how much each run scrapes.", "default": {} }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code for Maps results (default en).", "default": "en" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy configuration. Residential is recommended for reliable Maps access.", "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 } } } } } } } } } }