{ "openapi": "3.0.1", "info": { "title": "Google Maps Scraper | Places & Contacts", "description": "Search Google Maps or resolve place IDs and URLs. Export business details, ratings and hours, with optional reviews and website contacts; coverage limits documented.", "version": "91.5", "x-build-id": "VmydobLg5NpEWCNUf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/danthedataman~google-maps-place-atlas/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-danthedataman-google-maps-place-atlas", "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/danthedataman~google-maps-place-atlas/runs": { "post": { "operationId": "runs-sync-danthedataman-google-maps-place-atlas", "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/danthedataman~google-maps-place-atlas/run-sync": { "post": { "operationId": "run-sync-danthedataman-google-maps-place-atlas", "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": "Search terms", "type": "array", "description": "Search terms or place_id: identifiers. Required for search work; omitted terms can use categoryFilterWords. startUrls takes priority.", "items": { "type": "string" } }, "locationQuery": { "title": "Search location", "type": "string", "description": "Free-text area. Takes priority over structured location and GeoJSON." }, "locationQueries": { "title": "Multiple search locations", "type": "array", "description": "Search every term in each area. A nonempty locationQuery overrides this list.", "items": { "type": "string" } }, "placeIds": { "title": "Place IDs", "type": "array", "description": "Resolve public Google Place IDs independently of searches.", "items": { "type": "string" } }, "startUrls": { "title": "Google Maps URLs", "type": "array", "description": "Place, CID, share/short-link or search URLs. URL work takes priority over search terms. Supplied userData is returned unchanged as inputUserData on the first delivered base place.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "customGeolocation": { "title": "GeoJSON search area", "type": "object", "description": "Point, MultiPoint, Polygon (with holes), MultiPolygon, LineString, MultiLineString, Feature or FeatureCollection. Coordinates are longitude then latitude. Point/line radiusKm defaults to 8 km. Free-text location overrides this." }, "radiusKm": { "title": "Point/line radius (km)", "minimum": 0.001, "maximum": 20000, "type": "number", "description": "Radius for Point and line corridor inputs without their own radiusKm." }, "countryCode": { "title": "Country code", "type": "string", "description": "Two-letter country code for structured location and the Google interface region." }, "state": { "title": "State", "type": "string", "description": "Structured area; used when free-text/GeoJSON locations are absent." }, "county": { "title": "County", "type": "string", "description": "Structured county; verified against Google's returned area labels when available." }, "city": { "title": "City", "type": "string", "description": "Structured city. Do not combine with postalCode." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Structured postal area. Use with countryCode and without city." }, "language": { "title": "Interface language", "type": "string", "description": "Google interface language; languages overrides this when supplied.", "default": "en" }, "languages": { "title": "Multiple interface languages", "type": "array", "description": "Read every supplied language; an explicit empty list requests no work. Additional languages discover new places, keeping one row per Place ID across the whole run.", "items": { "type": "string" } }, "maxCrawledPlacesPerSearch": { "title": "Maximum places per search", "minimum": 0, "type": "integer", "description": "Delivered place cap per source and language. Omitted means unlimited; explicit zero means no work." }, "categoryFilterWords": { "title": "Category filters", "type": "array", "description": "OR across entries; all words in each entry must match a returned category. Supplies search terms if searchStringsArray is omitted.", "items": { "type": "string" } }, "searchMatching": { "title": "Search-name matching", "enum": [ "all", "only_includes", "only_exact" ], "type": "string", "description": "Keep all returned names, names including the term, or exact names.", "default": "all" }, "placeMinimumStars": { "title": "Minimum stars", "enum": [ "", "two", "twoAndHalf", "three", "threeAndHalf", "four", "fourAndHalf" ], "type": "string", "description": "Minimum Google rating. Empty disables the filter.", "default": "" }, "website": { "title": "Website filter", "enum": [ "allPlaces", "withWebsite", "withoutWebsite" ], "type": "string", "description": "Filter by presence of a business website.", "default": "allPlaces" }, "skipClosedPlaces": { "title": "Skip closed places", "type": "boolean", "description": "Skip places carrying a recognized permanent or temporary closure marker.", "default": false }, "geoStrictMatch": { "title": "Verify geographic location", "type": "boolean", "description": "Filter explicit geometry and structured areas using returned coordinates/address labels.", "default": true }, "keepUnverifiedLocations": { "title": "Keep unverifiable locations", "type": "boolean", "description": "When geographic verification is requested, retain records lacking the required coordinates or area labels.", "default": false }, "skipPlacesNotMatchingSearch": { "title": "Verify search words", "type": "boolean", "description": "Require each search word in the returned name/categories; this is lexical matching, not an AI relevance classifier.", "default": false }, "scrapePlaceDetailPage": { "title": "Include place details", "type": "boolean", "description": "Read the place's identity-confirmed detail response for hours, attributes and public business information." }, "extractPlaceDetails": { "title": "Place details alias", "type": "boolean", "description": "Vortex-compatible alias used only when scrapePlaceDetailPage is omitted." }, "maxReviews": { "title": "Maximum reviews per place", "minimum": 0, "type": "integer", "description": "Zero disables reviews; 99999 or more requests paging to the available terminal page. Reviews are separately billed artifacts." }, "maxReviewsPerPlace": { "title": "Review cap alias", "minimum": 0, "type": "integer", "description": "Vortex-compatible alias used only when maxReviews is omitted." }, "reviewsSort": { "title": "Review sort", "enum": [ "newest", "mostRelevant", "highestRanking", "lowestRanking", "most_relevant", "highest", "lowest" ], "type": "string", "description": "Google review sort; reviewsStartDate forces newest.", "default": "newest" }, "reviewsStartDate": { "title": "Reviews since", "type": "string", "description": "ISO date/time or relative value such as 3 days. Relative months are 30 days and years 365 days." }, "reviewsFilterString": { "title": "Review text filter", "type": "string", "description": "Case-insensitive substring in full original review text. May require scanning additional pages." }, "reviewsOrigin": { "title": "Review origin", "enum": [ "all", "google" ], "type": "string", "description": "Include all origins returned by Google, or only Google-origin records.", "default": "all" }, "scrapeReviewsPersonalData": { "title": "Reviewer personal fields", "type": "boolean", "description": "Disable to remove reviewer names, IDs, URLs, photos, profile counts and the review URL; the review ID and text remain." }, "personalData": { "title": "Reviewer personal fields alias", "type": "boolean", "description": "Compass Reviews-compatible alias used only when scrapeReviewsPersonalData is omitted." }, "scrapeContacts": { "title": "Website contacts", "type": "boolean", "description": "Read the business website and up to five linked contact/about/legal pages. Published contacts only; separate contact event." }, "extractContactsFromWebsite": { "title": "Website contacts alias", "type": "boolean", "description": "Contact-extractor alias used only when scrapeContacts is omitted." }, "scrapeTableReservationProvider": { "title": "Reservation links", "type": "boolean", "description": "Include public reservation links already returned in details; no reservation action is invoked.", "default": true }, "scrapeOrderOnline": { "title": "Online-order links", "type": "boolean", "description": "Include public Google food-order links returned in details; no order action is invoked.", "default": true }, "scrapeDirectories": { "title": "Directory businesses", "type": "boolean", "description": "Resolve the returned businesses inside malls/directories; source-dependent and potentially many additional requests.", "default": false }, "maxRunSeconds": { "title": "Run time budget (seconds)", "minimum": 0, "type": "integer", "description": "Stop source work when this budget expires; zero disables the budget. Unfinished work is recorded in ERRORS.", "default": 0 }, "maxRetriesPerRequest": { "title": "Total attempts per request", "minimum": 1, "maximum": 20, "type": "integer", "description": "Total attempts, including the first. Retry transport failures, 403/408/429/5xx and unreadable answers using fresh sessions.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify datacenter first. Explicit useApifyProxy:false uses direct egress. Residential groups are used only when explicitly configured.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }