API reference · Google Maps

google-maps/bulk/reviews

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APIAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDgoogle-maps/bulk/reviews

Input Schema

9 parameters · 0 required · 9 optional

Parameter	Type	Required	Description
`language`	string	Optional	Results details will show in this language. · Options: en, af, az, id, ms, bs, ca, cs, da, de, et, es, es-419, eu, fil, fr, gl, hr, zu, is, it, sw, lv, lt, hu, nl, no, uz, pl, pt-BR, pt-PT, ro, sq, sk, sl, fi, sv, vi, tr, el, bg, ky, kk, mk, mn, ru, sr, uk, ka, hy, iw, ur, ar, fa, am, ne, hi, mr, bn, pa, gu, ta, te, kn, ml, si, th, lo, my, km, ko, ja, zh-CN, zh-TW · Default: "en" enafazidmsbscacsdadeeteses-419eufilfrglhrzuisitswlvlthunlnouzplpt-BRpt-PTrosqskslfisvvitrelbgkykkmkmnrusrukkahyiwurarfaamnehimrbnpagutateknmlsithlomykmkojazh-CNzh-TW
`placeIds`	string[]	Optional	List of place IDs. You can add place IDs one by one or upload a list using the Bulk edit option.
`startUrls`	array	Optional	List of URLs to be crawled. They can be search URLs, place URLs or review detail URLs. Valid Google Maps place URLs must contain one of the following subpaths: /maps/search, /maps/place or /maps/reviews. This feature also supports uncommon URL formats such as: google.com/maps?cid=***.
`maxReviews`	integer	Optional	Max number of reviews per place to scrape. If you want to scrape all reviews, remove the prefilled value. · Min: 1 · Max: 9007199254740991 · Default: 10000000
`reviewsSort`	string	Optional	Define how reviews should be sorted. · Options: newest, mostRelevant, highestRanking, lowestRanking · Default: "newest" newestmostRelevanthighestRankinglowestRanking
`personalData`	boolean	Optional	This setting allows you to get personal data about the reviewer (their ID, name, URL, and photo URL) and about review (URL). Note: review ID (reviewId) is always included regardless of this setting. Personal data is protected by the GDPR in the European Union and by other regulations around the world. You should not scrape personal data unless you have a legitimate reason to do so. If you're unsure whether your reason is legitimate, consult your lawyers. · Default: true
`reviewsOrigin`	string	Optional	Select whether you want all reviews (from Google, Tripadvisor, etc.) or only reviews from Google · Options: all, google · Default: "all" allgoogle
`reviewsStartDate`	string	Optional	Either absolute date (e.g. `2024-05-03`) or relative date from now into the past (e.g. `8 days`, `3 months`). JSON input also supports adding time in both absolute (ISO standard, e.g. `2024-05-03T20:00:00`) and relative (e.g. `3 hours`) formats. Absolute time is always interpreted in the UTC timezone, not your local timezone - please convert accordingly. Supported relative date & time units: `minutes`, `hours`, `days`, `weeks`, `months`, `years`. Heads up: If this parameter is specified, you must choose the 'Newest' sort by value. The reason for this is that with this parameter entered, the actor stops scraping reviews as soon as it finds the first review that's older than the specified date. If the sorting is not set to 'Newest', it might encounter a review older than the specified date before it reaches the desired review count and not scrape the desired amount of reviews.
`reviewsFilterString`	string	Optional	If you enter keywords, only reviews containing those keywords will be scraped. Leave it blank to scrape all reviews. · Default: ""

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "google-maps/bulk/reviews",
  "language": "en",
  "maxReviews": 10000000,
  "reviewsSort": "newest",
  "personalData": true,
  "reviewsOrigin": "all",
  "reviewsFilterString": "",
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Google Maps Reviews