Using the API

Filters

The independent filters an order can turn on, and how each one changes what is delivered.

A scrape searches an area and delivers the businesses that pass the order's filters. Every filter is independent of the others, and an absent filter is off. The filters object goes in the body of estimate_scrape and create_scrape.

{
  "websitePresence": "any",
  "phoneTypeFilter": "mobile",
  "findOwner": true
}

Each filter that is on adds to the price of a delivered lead. get_pricing answers every rate, and estimate_scrape answers the exact price per lead for one order. With no filter on, an order delivers every business it finds, including those that publish no phone number, which is the cheapest thing Leadity sells.

The filters

Field	Values	Delivers
`websitePresence`	`any`, `has`, `none`	Every business, only those with a website, or only those without one. Required.
`phoneTypeFilter`	`off`, `with_phone`, `mobile`, `landline`, `voip`	`with_phone` delivers only businesses that publish a number. `mobile`, `landline` and `voip` deliver only numbers of that line type, checked against the numbering registers.
`findOwner`	`true`, `false`	Only businesses whose owner's name was found and confirmed, with the name in the file.
`emailFinder`	`off`, `require`, `require_verified`	Only businesses whose own website publishes an email address; the second also verifies the address.
`nicheMatch`	`true`, `false`	Only businesses whose own main Google category is a niche you ordered.
`minGoogleReviews`	`0` or a floor from `get_pricing`	Only businesses whose listing shows at least that many reviews.
`reviews`	`{ minReviews, maxReviews }`	Walks each delivered business's Google reviews into a second file. Charged per review.

A mobile number is promised only when phoneTypeFilter is mobile. With the phone filter off, a lead is a business record that may carry a landline or no number at all.

Rules worth knowing

One filter can switch another off. With websitePresence set to none there is no site to read, so emailFinder steps down to off. The estimate echoes the filters as the order will really run them, so check its answer rather than your request.
A niche can refuse the owner lookup. findOwnerBlockedBy in the estimate names any niche that does not allow it, and list_niches marks each niche with findOwner. Such an order is refused with niche_unavailable rather than silently delivered without names.
Your usual set is one call away. get_scrape_defaults answers the filters the account saved in the app.