Utilisation de base
Effectuez votre première requête Gender API
Envoyez une valeur et recevez le genre estimé, la probabilité, le pays et les informations de consommation. Commencez par un nom ou choisissez l’endpoint e-mail ou identifiant selon vos données.
Ajoutez votre clé API avec le paramètre de requête key. Conservez les clés de production côté serveur ; ne publiez jamais une clé privée dans le navigateur ou un dépôt public.
Utilisez le contrat GenderAPI actuel au format OpenAPI, Swagger ou Postman.
Genre à partir du nom
Prénom ou nom complet
Utilisez l’endpoint principal lorsque l’entrée est un prénom ou un nom complet.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"Paramètres facultatifs
| Paramètre | Type | Description |
|---|---|---|
country | string | Code pays à deux lettres, par exemple FR ou US. |
askToAI | boolean | Avec true, utilise le support IA lorsque le nom n’est pas présent dans la base. |
forceToGenderize | boolean | Tente une estimation pour des entrées inhabituelles qui peuvent ne pas ressembler à des noms de personnes. |
Genre à partir de l’e-mail
Adresse e-mail
L’endpoint e-mail extrait d’abord le nom probable de l’adresse, puis effectue l’estimation.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=alice.martin%40example.com&country=FR&askToAI=true&key=YOUR_API_KEY"forceToGenderize n’est pas disponible pour cet endpoint, car le nom est extrait en interne.Genre à partir de l’identifiant
Nom d’utilisateur ou alias
Utilisez cet endpoint pour des identifiants ou alias susceptibles de contenir un prénom reconnaissable.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=FR&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"Réponse JSON
Interprétez la réponse de GenderAPI
Les trois endpoints partagent la même structure de réponse de base.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "alice",
"gender": "female",
"country": "FR",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Champs de réponse
| Champ | Type | Description |
|---|---|---|
status | boolean | Indique si la requête a abouti. |
used_credits | integer | Crédits consommés par cette requête. |
remaining_credits | integer | Crédits encore disponibles après la requête. |
expires | integer | Date d’expiration du pack au format UNIX. |
q | string | Nom, e-mail ou identifiant envoyé dans la requête. |
name | string | Nom normalisé ou extrait de l’entrée. |
gender | string | Genre estimé : male, female ou "null". |
country | string | Code pays ISO 3166-1 alpha-2 le plus probable. |
total_names | integer | Nombre d’enregistrements de noms soutenant l’estimation. |
probability | integer | Niveau de confiance exprimé en pourcentage. |
duration | string | Durée du traitement côté serveur. |
Encodez toujours les valeurs dans l’URL
Votre client HTTP doit encoder les espaces et caractères spéciaux. Utilisez par exemple sparkling%20unicorn plutôt qu’un espace non encodé.
Poursuivez l’intégration