geo-lead

Create a new GeoLead search based on geographic coordinates and search query.

Creates a bulk search that will generate leads from a specific geographic area. The search will find businesses or locations matching the provided query within the specified radius from the given coordinates. This is useful for location-based lead generation and market research.

post/v5.1/geo-lead

Request

  • Base URL: https://api.anymailfinder.com
  • URL: https://api.anymailfinder.com/v5.1/geo-lead
  • Auth: API key in header Authorization

Headers

x-webhook-urlstring

If provided, the result will be POSTed to this URL instead of waiting for the response.

Request body

file_namestring

A label to identify the geo lead search.

find_company_emailsboolean required

Whether to search for company emails. If false, only decision maker emails will be searched. Defaults to true.

find_decision_maker_categoriesstring[] required

Decision maker categories to search for. If not provided, defaults to ["ceo"]. If empty array [], no decision maker search will be performed. Valid categories: "ceo", "engineering", "finance", "hr", "it", "logistics", "marketing", "operations", "buyer", "sales".

latitudenumber required

The latitude coordinate for the search center point.

longitudenumber required

The longitude coordinate for the search center point.

querystring required

The search query to find businesses or locations within the specified radius.

radius_kmnumber required

The search radius in km from the center point.

result_limitnumber nullable

Optional limit on the number of leads to extract. If specified, the extraction will stop once this limit is reached.

Example request

{
  "file_name": "my_geo_lead_search",
  "find_company_emails": true,
  "find_decision_maker_categories": [
    "ceo"
  ],
  "latitude": 40.7127753,
  "longitude": -74.0059728,
  "query": "restaurants",
  "radius_km": 1,
  "result_limit": 100
}

Response

Created.

status'on_deck' | 'queued' | 'running' | 'paused' | 'completed' | 'deleted' | 'extraction_queued' | 'extraction_running' required

The current status of the GeoLead search:<br /> - "extraction_queued": The search for companies matching the specified criteria is queued and will start soon.<br /> - "extraction_running": The search for companies is in progress.<br /> - "queued": The search for emails of the found companies is queued and will start soon.<br /> - "running": The search for emails of the found companies is in progress.<br /> - "paused": The GeoLead search has been temporarily paused.<br /> - "completed": The GeoLead search has finished successfully.<br /> - "failed": The GeoLead search has failed. This indicates that an error occurred during processing and the operation could not complete.

created_atstring date-time required
credits_needednumber required
file_namestring required
find_company_emailsboolean required
find_decision_maker_categoriesstring[] required
idstring required
latitudenumber required
longitudenumber required
paidboolean required
querystring required
radius_kmnumber required
result_limitnumber nullable
started_running_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.