Skip to main content
POST
Search local listings (Google Maps)

Authorizations

Authorization
string
header
required

Workspace API key. Create one via the dashboard or POST /v1/auth/keys.

Headers

Idempotency-Key
string

Deduplicates BOTH the response and the credit deduction: it becomes the ledger reference, so a retried call cannot be charged twice. Max 255 characters.

Body

application/json
query
string
required

What to search for, e.g. 'dentist'.

location
string
required

REQUIRED, not defaulted: Maps results are location-scoped, so a query without one returns whatever Google infers from the datacentre the run happened in — a result the caller cannot reproduce. E.g. 'Austin, Texas'.

limit
number
default:20

1-100. Above 100, Maps itself stops paginating.

Response

OK.

data
object[]
credits_used
number

3x what the provider run actually cost, empty results included. A failed run is never billed.

credits_remaining
number
provider
enum<string>

Which vendor answered. Named because this primitive has two, and provenance is the subject.

Available options:
apify_google_maps,
dataforseo
mock
boolean

Present and true only when the response came from fixtures.