Project HermesHermes Docs
API ReferenceGoogle Maps Scraper

Create Run

Create an asynchronous Google Maps scraper run

Create Run

Create a Google Maps scraper run.

curl -X POST https://api.hermes.camie.ai/v1/google-maps-scraper/runs \
  -H "Authorization: Bearer hermes_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "searchStringsArray": ["coffee shop"],
    "locationQuery": "Lagos Nigeria",
    "countryCode": "ng",
    "language": "en",
    "maxCrawledPlacesPerSearch": 25,
    "website": "allPlaces",
    "scrapeContacts": false,
    "verifyEmails": false,
    "leadListId": 40
  }'

Request Body

FieldTypeRequiredDescription
searchStringsArraystring[]ConditionalSearch terms to run
locationQuerystringNoLocation text appended to each search
countryCodestringNoTwo-letter country code, default us
languagestringNoLanguage code, default en
maxCrawledPlacesPerSearchnumberNoPlaces to save per search, default 50
websitestringNoallPlaces, withWebsite, or withoutWebsite
placeMinimumStarsnumberNoMinimum rating
categoryFilterWordsstring[]NoCategory filter words
skipClosedPlacesbooleanNoSkip closed places
startUrlsstring[]ConditionalDirect Maps place URLs
placeIdsstring[]ConditionalDirect Google place IDs
scrapeContactsbooleanNoRun website enrichment after scraping
verifyEmailsbooleanNoVerify extracted emails
leadListIdnumberNoLead list to associate with the run

At least one of searchStringsArray, startUrls, or placeIds is required.

Response

{
  "success": true,
  "message": "Google Maps scraper run queued",
  "data": {
    "id": 5,
    "leadListId": 40,
    "provider": "maps_web_scraper",
    "status": "queued",
    "statusMessage": "Google Maps scraper run queued",
    "searchStrings": ["coffee shop"],
    "locationQuery": "Lagos Nigeria",
    "countryCode": "ng",
    "language": "en",
    "maxCrawledPlacesPerSearch": 25,
    "scrapeContacts": false,
    "verifyEmails": false,
    "totalQueries": 1,
    "processedQueries": 0,
    "totalItems": 0,
    "savedItems": 0,
    "enrichedItems": 0,
    "importedLeads": 0,
    "createdAt": "2026-06-13T03:50:00.000Z",
    "updatedAt": "2026-06-13T03:50:00.000Z"
  }
}

Poll Get Run until the status is terminal.

On this page