Start a scrape
mapsdata_start_scrapeStart scraping Google Maps businesses and their emails. Returns IMMEDIATELY with a job id; the scrape itself takes 5 minutes to several hours.
Before calling this, confirm the category with mapsdata_search_categories and the region with mapsdata_list_regions. Those two mistakes are the overwhelming majority of rejections.
This consumes the user's monthly lead allowance. Set dry_run to check a request against every rule without spending anything.
min_reviews, max_reviews and max_emails_per_company are optional. Pass them when the user asks for them. The response reports the filters that apply, including the default email cap.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | An exact Google Maps category, e.g. 'Plumber'. Verify it with mapsdata_search_categories first. | |
| cities | No | Named cities instead of whole regions. | |
| states | No | Full region names, e.g. ['Texas']. Not abbreviations. Use this or cities, not both. | |
| country | No | us | |
| dry_run | No | Validate against every rule and return the plan WITHOUT starting a scrape or spending quota. | |
| list_name | No | Label for the list. Defaults to the query. | |
| limit_basis | No | What total_limit counts. 'emails' stops once that many leads WITH an email are found; leads without one are still delivered and never billed. 'rows' stops at that many leads of any kind. Omit it for the organization's default, which is 'emails' unless the organization used the API before this option launched. | |
| max_reviews | No | Skip businesses with more Google reviews. Omit it for no maximum. 0 keeps ONLY businesses with no reviews. | |
| min_reviews | No | Skip businesses with fewer Google reviews. Defaults to 0, no minimum. | |
| total_limit | Yes | How many leads to scrape, in the unit limit_basis sets. Read max_rows_this_scrape from mapsdata_get_usage first: a larger request is reduced to the allowance left this cycle, not rejected. | |
| max_emails_per_company | No | Most emails kept per business. Defaults to 5 when omitted. |