Overview
Contact Extractor works by extracting contact data from a website URL using web scraping techniques. It returns the contact emails, phone numbers, and places found on the website.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl -X POST https://api.apiverve.com/v1/contactextractor \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"url": "https://en.wikipedia.org/wiki/Email_address",
"limit": -1
}'const res = await fetch('https://api.apiverve.com/v1/contactextractor', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"url": "https://en.wikipedia.org/wiki/Email_address",
"limit": -1
}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.apiverve.com/v1/contactextractor",
headers={"x-api-key": "your_api_key_here"},
json={
"url": "https://en.wikipedia.org/wiki/Email_address",
"limit": -1
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"url": "https://en.wikipedia.org/wiki/Email_address",
"limit": -1
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/contactextractor", body)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
urlRequired | string | The URL of the web page to extract contact data from url |
limitRequiredPremium | number | Limits the number of found contact details found on the page. Set -1 for unlimited default 5 |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"url": "https://en.wikipedia.org/wiki/Email_address",
"emails": [
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]"
],
"phones": [],
"places": [
"China",
"Japan",
"Russia",
"Rajasthan",
"India"
],
"emailCount": 27,
"phoneCount": 0,
"placeCount": 5,
"uniqueDomains": [
"example.com",
"example.org",
"s.example",
"EasierReading.org",
"pobox.com"
]
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
url | string | "https://en.wikipedia.org/wiki/Email_address" | |
emails | array | [[email protected], ...] | |
phones | array | [] | |
places | array | [China, ...] | |
emailCount | number | 27 | Total number of email addresses found |
phoneCount | number | 0 | Total number of phone numbers found |
placeCount | number | 5 | Total number of places/locations found |
uniqueDomainsPremium | array | [example.com, ...] | List of unique email domains found (e.g., example.com, company.org) |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Lead Generation
- Use the Contact Extractor API to extract contact data for lead generation. Use the data to identify potential customers and prospects
- Marketing Research
- Conduct marketing research by using the Contact Extractor API to extract contact data. Use the data to analyze market trends, customer preferences, and competitor information
- Business Development
- Support business development efforts by using the Contact Extractor API to extract contact data. Use the data to build contact lists, reach out to new clients, and expand your network
- Data Enrichment
- Enrich your data by using the Contact Extractor API to extract contact data. Use the data to enhance your existing database with up-to-date contact information
Other ways to use Contact Extractor
Set up Contact Extractor on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Data Scraping: