Vue d’ensemble
De l’adresse e-mail à l’estimation
GenderAPI analyse la partie locale de l’adresse, extrait le prénom le plus probable et l’utilise pour estimer le genre. Ajoutez le pays lorsque vous connaissez la région de la personne.
emilie.dupont@example.comEmiliefemale · 97%En-têtes HTTP obligatoires
Autorisez la requête
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYCorps JSON de la requête
Paramètres
| Paramètre | Type | Statut | Description |
|---|---|---|---|
email | string | Obligatoire | Adresse e-mail à analyser. GenderAPI extrait d’abord le prénom le plus probable, puis réalise l’estimation. |
country | string | Facultatif | Code pays ISO 3166-1 alpha-2, par exemple FR, BE ou CA, pour apporter un contexte régional. |
askToAI | boolean | Facultatif | Si true, utilise l’assistance IA lorsque le prénom extrait ne produit aucun résultat dans la base de données. |
askToAI est évalué après l’extraction du prénom et uniquement si celui-ci est absent de la base de données. L’endpoint e-mail ne prend pas en charge forceToGenderize.
Exemples de code
Envoyez une requête par e-mail
curl -X POST "https://api.genderapi.io/api/email" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"email":"emilie.dupont@example.com","country":"FR","askToAI":true}'const response = await fetch("https://api.genderapi.io/api/email", {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
body: JSON.stringify({ email: "emilie.dupont@example.com", country: "FR", askToAI: true })
});
const data = await response.json();import requests
response = requests.post(
"https://api.genderapi.io/api/email",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"email": "emilie.dupont@example.com", "country": "FR", "askToAI": True}
)
print(response.json())Réponse 200
Prénom extrait et estimation
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "emilie.dupont@example.com",
"name": "Emilie",
"gender": "female",
"country": "FR",
"total_names": 10345,
"probability": 97,
"duration": "5ms"
}Champs de la réponse
| Champ | Type | Description |
|---|---|---|
status | boolean | Indique si la requête a été traitée correctement. |
used_credits | integer | Crédits consommés par la requête. |
remaining_credits | integer | Crédits disponibles après la requête. |
expires | integer | Date d’expiration du pack sous forme d’horodatage UNIX. |
q | string | Adresse e-mail transmise à l’origine dans la requête. |
name | string | Prénom extrait de l’adresse e-mail. |
gender | string | null | Valeur estimée : male, female ou null. |
country | string | Code pays pris en compte pour l’estimation. |
total_names | integer | Nombre d’échantillons sur lesquels repose l’estimation. |
probability | integer | Niveau de confiance de l’estimation, exprimé en pourcentage. |
duration | string | Temps de traitement côté serveur. |
Utilisez une adresse e-mail complète et valide
L’extraction dépend de la structure de l’adresse. Les boîtes génériques, les alias ou les parties locales sans prénom reconnaissable peuvent ne produire aucun résultat. Vérifiez name, gender et probability avant d’utiliser l’estimation. Les requêtes par e-mail ne sont pas enregistrées.
Guide suivant