Utilisation de Base

GenderAPI vous permet de déterminer le genre d’une personne en utilisant différents types de données en entrée. Vous pouvez analyser directement des prénoms ou extraire des noms depuis des adresses email et des noms d’utilisateur. Voici comment démarrer :

1. Genre à partir d’un Prénom

Envoyez un prénom à l’endpoint suivant : 

https://api.genderapi.io/api

Exemple : 

curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

Vous pouvez également ajouter des paramètres optionnels :

  • country : Passez un code pays à deux lettres ( ISO 3166-1 alpha-2 ) pour améliorer la précision de la prédiction. Par exemple : country=TR pour la Turquie.
  • askToAI : Si défini sur true, l’API interrogera un modèle d’IA pour déterminer le genre lorsque le prénom n’est pas trouvé dans la base de données.
  • forceToGenderize : Si défini sur true, l’API tentera de deviner le genre même pour des entrées qui ne ressemblent pas à de vrais prénoms, comme des pseudonymes ou des noms fantaisistes tels que sparkling unicorn ou mystic warrior. Cela peut être utile pour l’analyse des noms d’utilisateur, mais les résultats peuvent être moins précis. Remarque : Ce paramètre n’est pas disponible sur l’endpoint email.

Exemple avec paramètres : 

curl "https://api.genderapi.io/api?name=sparkling%20unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

2. Genre à partir d’une Adresse Email

Utilisez cet endpoint si vous disposez uniquement d’une adresse email : 

https://api.genderapi.io/api/email

Exemple : 

curl "https://api.genderapi.io/api/email?email=alice.smith@example.com&country=TR&askToAI=true&key=YOUR_API_KEY"

Remarque : Le paramètre forceToGenderize n’est pas disponible pour l’endpoint email car celui-ci extrait d’abord le prénom en interne.


3. Genre à partir d’un Nom d’Utilisateur

Pour les noms d’utilisateur ou les pseudonymes, utilisez : 

https://api.genderapi.io/api/username

Exemple : 

curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

Le paramètre forceToGenderize est particulièrement utile ici car les noms d’utilisateur contiennent souvent des mots qui ne sont pas des prénoms ou des termes fantaisistes. Cela force l’API à tenter une prédiction du genre même si l’entrée ne correspond pas à un prénom humain typique.

Toutes les méthodes prennent en charge des requêtes uniques ou multiples. Pour plus de détails, consultez les sections spécifiques dans le menu de navigation à gauche.


✅ Réponse de l’API

Exemple de réponse JSON pour tous les endpoints : 

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "michael.smith@example.com",
  "name": "Michael",
  "gender": "male",
  "country": "US",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

Champs de la Réponse

Champ Type Description
status Boolean true si la requête a réussi. Vérifiez les erreurs si false.
used_credits Integer Nombre de crédits utilisés pour cette requête.
remaining_credits Integer Crédits restants sur votre compte après cette requête.
expires Integer (timestamp) Date d’expiration du forfait sous forme de timestamp UNIX (en secondes).
q String Votre requête en entrée (prénom, email ou nom d’utilisateur).
name String Le prénom trouvé ou extrait.
gender Enum[String] Genre prédit. Valeurs possibles : male, female ou null.
country Enum[String] Code pays le plus probable (par ex. US ou DE).
total_names Integer Nombre d’exemples utilisés pour la prédiction.
probability Integer Pourcentage de probabilité de la prédiction de genre (par ex. 50-100).
duration String Durée de traitement de la requête (par ex. 4ms).
Attention : Si vos valeurs d’entrée contiennent des espaces ou des caractères spéciaux (par ex. sparkling unicorn), pensez toujours à les encoder en URL avant d’effectuer des requêtes GET. Sinon, la requête peut échouer ou d’autres paramètres pourraient être mal interprétés par votre langage de programmation ou la bibliothèque HTTP que vous utilisez. 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
vous devez utiliser : 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
ou appliquer les fonctions d’URL-encoding appropriées dans votre langage de programmation.