Essencial
Jobs de scraping
Um job de scraping roda uma busca em mapas (Google, Bing ou Apple) e extrai todas as empresas correspondentes.
Creating a job requires an active subscription (or trial) and available credits. The job starts in pending and moves through running to completed or failed.
Create a job
POST/v1/scrape-jobs
Request body
| Field | Type | Description |
|---|---|---|
| provider | string? | Map source: "google" (default), "bing", or "apple". |
| keyword | string | Required. The search query, e.g. "design agencies". |
| location | string? | Optional location to bias the search, e.g. "New York, NY". |
| lang | string? | Optional language code (default "en"). |
| options.maxResults | number? | Cap on extracted leads (default 200). |
| options.enrichEmail | boolean? | Enrich each lead with emails from its website (paid plans). |
| options.enrichSocials | boolean? | Enrich each lead with social profiles (paid plans). |
Job object
| Field | Type | Description |
|---|---|---|
| id | string | Job id — use it to poll, read leads, or export. |
| provider | string | Map source the job ran against: google · bing · apple. |
| status | string | pending · running · completed · failed · canceled. |
| keyword | string | The search query. |
| location | string | null | The search location. |
| language | string | The language code used. |
| maxResults | number | null | The configured result cap. |
| resultCount | number | Number of leads extracted (once completed). |
| error | string | null | Failure reason, if the job failed. |
| createdAt | string | ISO 8601 timestamp. |
Read & manage jobs
GET/v1/scrape-jobs
GET/v1/scrape-jobs/:id
DELETE/v1/scrape-jobs/:id
GET /v1/scrape-jobs returns { "data": [ job, ... ] }. Only failed jobs can be deleted.
cURL — create
curl https://api.mapleads.ai/v1/scrape-jobs \
-X POST \
-H "Authorization: Bearer mapleads_xxx" \
-H "Content-Type: application/json" \
-d '{"provider":"bing","keyword":"coffee shops","location":"Brooklyn"}'