{ "openapi": "3.0.1", "info": { "title": "Google Maps Scraper", "description": "Scrape Google Maps business listings by search term and location. Extract names, addresses, phone numbers, websites, emails, opening hours, ratings, reviews, categories, coordinates and place IDs. Covers whole cities, states and countries. No API key needed. Results stream in live.", "version": "0.0", "x-build-id": "FrLwUNhIZ2B4lLS8F" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/calm_builder~google-maps-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-calm_builder-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/calm_builder~google-maps-scraper/runs": { "post": { "operationId": "runs-sync-calm_builder-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/calm_builder~google-maps-scraper/run-sync": { "post": { "operationId": "run-sync-calm_builder-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": { "searchStringsArray": { "title": "What to search for", "type": "array", "description": "Enter one search term per row, exactly as you would type it into Google Maps — `dentist`, `coffee shop`, `plumber`, or a brand name like `Starbucks`.\n\nEach term is searched across the whole location you set below.", "items": { "type": "string" } }, "locationQuery": { "title": "Where to search", "type": "string", "description": "A city, region or country — `Jersey City, New Jersey`, `Manhattan, New York`, `Malta`.\n\nKeep it simple: `City, Country` reads better than `Neighbourhood, City, State, Country`. Large areas work — set a place limit and results are taken from across the whole area, not just one corner. For exhaustive coverage of a dense area, run it city by city.\n\nThis is all most runs need. If the name is ambiguous, or you want an exact boundary, use **Precise area** at the bottom instead." }, "countryCode": { "title": "Search from this country", "enum": [ "", "af", "al", "dz", "as", "ad", "ao", "ai", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "ba", "bw", "br", "io", "vg", "bn", "bg", "bf", "bi", "kh", "cm", "ca", "cv", "bq", "ky", "cf", "td", "cl", "cn", "cx", "cc", "co", "km", "cg", "cd", "ck", "cr", "hr", "cu", "cw", "cy", "cz", "ci", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "sz", "et", "fk", "fo", "fj", "fi", "fr", "gf", "pf", "tf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gg", "gn", "gw", "gy", "ht", "hn", "hk", "hu", "is", "in", "id", "ir", "iq", "ie", "im", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "xk", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mo", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nc", "nz", "ni", "ne", "ng", "nu", "nf", "kp", "mk", "mp", "no", "om", "pk", "pw", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "ro", "ru", "rw", "re", "ws", "sm", "cq", "sa", "sn", "rs", "sc", "sl", "sg", "sx", "sk", "si", "sb", "so", "za", "gs", "kr", "ss", "es", "lk", "bl", "sh", "kn", "lc", "mf", "pm", "vc", "sd", "sr", "sj", "se", "ch", "sy", "st", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tm", "tc", "tv", "tr", "vi", "ug", "ua", "ae", "gb", "us", "uy", "uz", "vu", "va", "ve", "vn", "wf", "eh", "ye", "zm", "zw", "ax" ], "type": "string", "description": "Google shows different results depending on where you are searching from. This sets that country — it decides the address format, the currency prices are quoted in, the spelling variant, and which nearby places Google treats as relevant.\n\n**Set automatically** picks the country of the location you entered above, which is right for almost every run. Change it only when you want to see an area the way someone in a different country would.", "default": "" }, "maxCrawledPlacesPerSearch": { "title": "Places per search term", "minimum": 1, "type": "integer", "description": "How many places to collect for each search term. Leave empty to collect everything in the area.\n\nLarger areas hold more places than you might expect — a city can return thousands for a common term. On a large area such as a country, this is also what decides how much of the map gets searched." }, "searchMatching": { "title": "How strictly to match the name", "enum": [ "all", "includes", "exact" ], "type": "string", "description": "Google decides for itself what is relevant to your term, which is usually what you want — but not when you are after one specific business.\n\n- **Anything relevant** — everything Google returns, including similar businesses nearby.\n- **Name contains the term** — searching `Starbucks` gives you Starbucks, not the café next door.\n- **Name matches exactly** — strictest, for a single chain and nothing else.\n\nFree.", "default": "all" }, "language": { "title": "Language", "enum": [ "af", "sq", "am", "ar", "hy", "az", "bn", "eu", "be", "bs", "bg", "my", "ca", "zh-CN", "zh-TW", "hr", "cs", "da", "nl", "en", "et", "fil", "fi", "fr", "gl", "ka", "de", "el", "gu", "iw", "hi", "hu", "is", "id", "it", "ja", "kn", "kk", "km", "ko", "ky", "lo", "lv", "lt", "mk", "ms", "ml", "mr", "mn", "ne", "no", "fa", "pl", "pt", "pa", "ro", "ru", "sr", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "tr", "uk", "ur", "uz", "vi", "zu" ], "type": "string", "description": "The language Google answers in. Place names, categories, opening-hours text, service options and review translations all come back in this language.\n\nReviews keep their original text as well, so a review written in Spanish stays in Spanish and is also translated into the language you pick here.", "default": "en" }, "categoryFilterWords": { "title": "…are in one of these categories", "type": "array", "description": "Every place on Google Maps carries a category — `Dentist`, `Coffee shop`, `Italian restaurant`, `Law firm`. This keeps only the places whose category matches one of the words you enter here.\n\nIt is the fix for a search that pulls in the wrong kind of business: searching `coffee` also returns bakeries, bookshops and restaurants, so adding `coffee shop` here removes them. Matching ignores case and matches part of the category, so `restaurant` keeps `Italian restaurant` and `Seafood restaurant` too.\n\nLeave it empty to keep every category. This filter is free, and places it removes are never charged.", "items": { "type": "string" } }, "placeMinimumStars": { "title": "…are rated at least", "enum": [ "", "2", "2.5", "3", "3.5", "4", "4.5" ], "type": "string", "description": "Keep only places at or above this rating. Places with no rating yet are dropped once you set one.\n\nFree.", "default": "" }, "minimumReviews": { "title": "…have at least this many reviews", "minimum": 0, "type": "integer", "description": "Drop thin listings. A business with two reviews is often dormant, duplicated or somebody's spare room, and on a lead list those are the rows you delete by hand.\n\n`10` is a good cut-off for an established business, `50` for a busy one. Leave at `0` to keep everything.\n\nPlaces whose review count Google does not return are kept. Free.", "default": 0 }, "website": { "title": "…have a website (or do not)", "enum": [ "", "withWebsite", "withoutWebsite" ], "type": "string", "description": "Keep only places that have a website, or only those that do not.\n\nPlaces **without** a website are the usual target for web design and marketing outreach; places **with** one pair well with **Website contact details** below.\n\nThis filter is free.", "default": "" }, "skipClosedPlaces": { "title": "…are still open", "type": "boolean", "description": "Leave out anything Google marks as permanently or temporarily closed.\n\nOn by default — closed businesses are rarely what anyone is after. Free.", "default": true }, "scrapePlaceDetails": { "title": "Full place details ($)", "type": "boolean", "description": "Open every place to collect everything Google holds about it: description, price level, service options and amenities, review keywords, rating breakdown, popular times, plus code, menu and booking links, and hotel or fuel details where they apply.\n\nWith this off you still get the core fields — name, address, phone, website, opening hours, rating, review count, categories and coordinates.", "default": true }, "scrapeContacts": { "title": "Website contact details ($)", "type": "boolean", "description": "Visit each place's website and pull the contact details that are not on Google Maps: email addresses, extra phone numbers, social media profiles and postal addresses.\n\nUseful for building outreach lists, since most listings show a website but no email. Places without a website are skipped and never charged.", "default": false }, "maxReviews": { "title": "Reviews per place ($)", "minimum": 0, "type": "integer", "description": "How many reviews to collect for each place. Leave at `0` to skip reviews entirely.\n\nEach review comes with its text, star rating, date, reviewer name and profile, owner reply, photos and the per-category ratings such as food, service and atmosphere.\n\nReviews are saved to their own **Reviews** table, one row per review, and are also included inside each place record.", "default": 0 }, "reviewsSort": { "title": "Sort reviews by", "enum": [ "newest", "mostRelevant", "highestRanking", "lowestRanking" ], "type": "string", "description": "Which reviews you get when you ask for fewer than a place has.", "default": "newest" }, "reviewsStartDate": { "title": "Only reviews newer than", "type": "string", "description": "Skip anything older. Use a date such as `2026-01-31`, or a period counted back from now such as `7 days`, `3 months` or `1 year`.\n\nWorks best with **Newest first**, where collecting stops as soon as the reviews get too old." }, "reviewsFilterString": { "title": "Only reviews mentioning", "type": "string", "description": "Keep only reviews containing this word or phrase — `parking`, `gluten free`, `rude staff`.\n\nLeave empty to keep them all. This filter is free." }, "scrapeReviewsPersonalData": { "title": "Include reviewer details", "type": "boolean", "description": "Keep the reviewer's name, photo and profile link on each review.\n\nTurn this off to get the review text, rating and date with the reviewer anonymised — useful when your data policy limits what personal information you may store.\n\nThis option is free.", "default": true }, "maxImages": { "title": "Photos per place ($)", "minimum": 0, "type": "integer", "description": "How many photos to collect for each place, from its Google Maps gallery. Leave at `0` to skip photos.\n\nYou always get the main listing photo for free, with or without this.", "default": 0 }, "startUrls": { "title": "Google Maps links", "type": "array", "description": "Collect specific places instead of searching. Paste Google Maps links to individual places, or search and directions links copied from your browser.\n\nCan be combined with a search above, or used on its own.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "placeIds": { "title": "Place IDs", "type": "array", "description": "Google place IDs, one per row — for example `ChIJdw_prS5DIjkRim7FRjjIswU`.\n\nHandy for refreshing a list you collected earlier, since a place ID never changes.", "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "Used instead of **Where to search**. Enter the city on its own — for example `Pittsburgh`, not `Pittsburgh, PA, USA`." }, "state": { "title": "State or region", "type": "string", "description": "Used instead of **Where to search**, together with the city. For example `Massachusetts` — worth setting where city names repeat across regions." }, "county": { "title": "County or district", "type": "string", "description": "Used instead of **Where to search**. For example `New York County`. The equivalent area is used elsewhere, such as a district or département." }, "postalCode": { "title": "Postcode", "type": "string", "description": "One postcode at a time — for example `10001`. Set the country above; do not combine it with a city.\n\nOnly places inside the postcode are kept. Neighbouring ones are dropped before they are collected, so they cost you nothing." }, "postalCodeRadiusKm": { "title": "Postcode radius", "minimum": 1, "maximum": 25, "type": "integer", "description": "Used with **Postcode** only. How far around the centre of the postcode to look, in kilometres.\n\nRaise it for a rural postcode that covers a lot of ground, lower it for a dense city one.", "default": 3 }, "customGeolocation": { "title": "Custom area", "type": "object", "description": "Draw the area yourself as GeoJSON, when no city, county or postcode matches the shape you need — a delivery zone, a sales territory, a stretch of coastline.\n\nTakes a `Polygon` or `MultiPolygon`. Coordinates are `[longitude, latitude]`, in that order. Overrides every other location field." } } }, "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 } } } } } } } } } }