Documentation pour développeurs

Documentation de Gender API

Estimez le genre à partir d’un prénom, d’un nom complet, d’un e-mail ou d’un nom d’utilisateur avec des requêtes REST simples et des réponses JSON structurées.

REST + JSONRequêtes GETUnique et multipleContexte de pays

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.

Authentification

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.

Consulter le guide d’authentification →
Ressources API lisibles par machine

Utilisez le contrat GenderAPI actuel au format OpenAPI, Swagger ou Postman.

GET

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/api
cURL
curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

Paramètres facultatifs

ParamètreTypeDescription
countrystringCode pays à deux lettres, par exemple FR ou US.
askToAIbooleanAvec true, utilise le support IA lorsque le nom n’est pas présent dans la base.
forceToGenderizebooleanTente une estimation pour des entrées inhabituelles qui peuvent ne pas ressembler à des noms de personnes.
À utiliser avec discernement : les estimations forcées pour des noms fictifs, alias ou entrées peu significatives peuvent être moins précises.
GET

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/email
cURL
curl "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.
GET

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/username
cURL
curl "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.

200 OK
{
  "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

ChampTypeDescription
statusbooleanIndique si la requête a abouti.
used_creditsintegerCrédits consommés par cette requête.
remaining_creditsintegerCrédits encore disponibles après la requête.
expiresintegerDate d’expiration du pack au format UNIX.
qstringNom, e-mail ou identifiant envoyé dans la requête.
namestringNom normalisé ou extrait de l’entrée.
genderstringGenre estimé : male, female ou "null".
countrystringCode pays ISO 3166-1 alpha-2 le plus probable.
total_namesintegerNombre d’enregistrements de noms soutenant l’estimation.
probabilityintegerNiveau de confiance exprimé en pourcentage.
durationstringDuré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

Choisissez le guide adapté

Requêtes sur les nomsExemples uniques et multiples →Bibliothèques clientesChoisissez votre langage →Gestion des erreursÉtats et codes d’erreur →