Email API
Email Pattern
Discover the most common email address patterns used by a company domain, with usage percentages.
POST
$0.01/call/v1/email/formatUsage
const res = await fetch('https://api.yepapi.com/v1/email/format', {
method: 'POST',
headers: {
'x-api-key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ domain: 'stripe.com' }),
});
const { data } = await res.json();
console.log(data);curl -X POST https://api.yepapi.com/v1/email/format \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domain": "stripe.com"}'Request Body
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
domain | string | Yes | Domain to detect email patterns for (e.g., stripe.com) | — |
Response
{
"data": {
"patterns": [
{
"pattern": "{last}",
"percentage": 2
},
{
"pattern": "{first}.{last}",
"percentage": 9
},
{
"pattern": "{f}{l}",
"percentage": 2
},
{
"pattern": "{first}",
"percentage": 64
},
{
"pattern": "{f}{last}",
"percentage": 23
}
]
},
"ok": true
}Response Fields
| Field | Type | Description |
|---|---|---|
ok | boolean | Whether the request succeeded |
data.patterns | object[] | Email patterns detected on the domain |
data.patterns[].pattern | string | Pattern template — {first} = first name, {last} = last name, {f} / {l} = initials (e.g., {first}.{last} → [email protected]) |
data.patterns[].percentage | number | Share of addresses on the domain using this pattern (0–100) |
Under the Hood
Use the highest-percentage pattern to construct likely addresses, then confirm them with the Email Verifier before sending.