Skip to main content
POST
geo.address.businesses.list

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
countryCode
string
default:US

ISO two- or three-letter country code.

Required string length: 1 - 3
Pattern: ^[A-Z]{2,3}$
address
string

Full US address; send this, components or ref.

Required string length: 1 - 512
components
object

US address components.

ref
string

The ref returned by an address row from geo.address.suggest or an address lookup.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
limit
integer
default:100

Names to return, at most 1000.

Required range: 1 <= x <= 1000

Response

The result

modified
boolean
required

False if unchanged.

record
object
required

Matched address and a short-lived handle for a later lookup.

results
object[]
required

Business names and detail handles.

Maximum array length: 1000
truncated
boolean
required

More names exist than returned.