Skip to main content
POST
local.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
keywords
string[]
required

Business types to search, e.g. plumbers. Up to 3.

Required array length: 1 - 3 elements
Required string length: 1 - 128
cities
string[]
required

Cities ("Austin", "Austin, TX", "Toronto") or US ZIP codes ("78704"). Up to 3.

Required array length: 1 - 3 elements
Required string length: 1 - 128
country
string

Two-letter country code for all the cities, e.g. CA for Toronto. Default US; US ZIP codes need US.

Pattern: ^[A-Z]{2}$
dryRun
boolean

True to resolve the searches and return the exact cost for free, without running anything. Default false: the paid run happens.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.