Skip to main content
POST
geo.businesses.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
query
string
required

Business name keywords; prefix matching in any word order.

Required string length: 1 - 128
locality
string

US city.

Required string length: 1 - 64
region
string

US state.

Required string length: 1 - 32
postalCode
string

US postal code.

Required string length: 1 - 16
limit
integer
default:100

At most 1000 business names, without paging.

Required range: 1 <= x <= 1000

Response

The result

results
object[]
required

Business names and detail handles.

Maximum array length: 1000
truncated
boolean
required

More matches may exist; refine the query.