Skip to main content
1 credit per place returned

Method

services.googleMaps.scrape(params)

Input

Search Parameters

searchStringsArray
string[]
required
Array of search terms to find places. Each term runs as a separate search.Examples: ["grocery store", "pizza restaurant", "dentist"]

Location Parameters

Specify the search location using either city/state/country OR lat/lng coordinates.
city
string
City name to search in (e.g., "Austin", "San Francisco")
state
string
State or province to search in (e.g., "Texas", "California")
countryCode
string
Two-letter country code (e.g., "us", "uk", "ca", "de")
lat
string
Latitude coordinate for geolocation search. Overrides city/state/country when provided.
lng
string
Longitude coordinate for geolocation search. Overrides city/state/country when provided.
zoom
number
Zoom level affecting search radius (1-21). Higher values = smaller search area.
  • 1-5: Country/continent level
  • 10-12: City level
  • 15-17: Neighborhood level
  • 18-21: Street level

Limits

Maximum number of places to return per search term

Filters

minStarRating
number
Minimum star rating filter (1-5). Only places with this rating or higher will be returned.
website
string
default:"allPlaces"
Filter places by website presence:
  • "withWebsite" - Only places that have a website
  • "withoutWebsite" - Only places without a website
  • "allPlaces" - No filtering by website
skipClosedPlaces
boolean
default:false
Skip places that are permanently or temporarily closed

Language

language
string
default:"en"
Language code for results (e.g., "en", "es", "fr", "de")

Pagination

datasetListParams
object
Pagination options for result set
datasetListParams.limit
number
Maximum number of results to return
datasetListParams.offset
number
Number of results to skip (for pagination)

Output

Returns an array of places with the following fields:
title
string
Place name
placeId
string
Google Maps place ID
url
string
Google Maps URL
address
string
Full address
city
string
City
state
string
State/province
phone
string
Phone number
website
string
Website URL
rating
number
Star rating (1-5)
reviewsCount
number
Total reviews
categoryName
string
Primary category
openingHours
array
Hours by day

Examples

const places = await services.googleMaps.scrape({
   searchStringsArray: ["coffee shops"],
   city: "Austin",
   state: "Texas",
   countryCode: "us",
   maxCrawledPlacesPerSearch: 20
});

return places.map(p => ({ name: p.title, rating: p.rating, website: p.website }));

High-Rated Places with Websites

const places = await services.googleMaps.scrape({
   searchStringsArray: ["italian restaurant", "sushi restaurant"],
   city: "New York",
   state: "New York",
   countryCode: "us",
   minStarRating: 4,
   website: "withWebsite",
   skipClosedPlaces: true,
   maxCrawledPlacesPerSearch: 50
});

return places;
const places = await services.googleMaps.scrape({
   searchStringsArray: ["gym", "fitness center"],
   lat: "30.2672",
   lng: "-97.7431",
   zoom: 14,
   maxCrawledPlacesPerSearch: 30
});

return places;