Vue d’ensemble de la requête groupée
Traitez jusqu’à 100 prénoms
Envoyez un tableau data et recevez un résultat par enregistrement. Ajoutez l’id de votre système afin de relier chaque estimation à sa source de façon fiable.
askToAI et forceToGenderize ne sont pas disponibles. Pour les alphabets non latins ou les entrées nécessitant l’IA, utilisez l’endpoint de prénom individuel.
En-têtes HTTP obligatoires
Autorisez la requête groupée
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYCorps JSON de la requête
Paramètres
| Champ | Type | Statut | Description |
|---|---|---|---|
data | object[] | Obligatoire | Tableau contenant de 1 à 100 enregistrements de prénoms. |
data[].name | string | Obligatoire | Prénom à analyser. |
data[].country | string | Facultatif | Code pays ISO 3166-1 alpha-2. Si aucun résultat national n’existe, le résultat global est utilisé. |
data[].id | string | integer | Facultatif | Identifiant de votre enregistrement, renvoyé sans modification pour relier chaque résultat à son entrée. |
Si aucune correspondance n’existe pour le pays transmis, GenderAPI renvoie le résultat global disponible. Utilisez des codes ISO 3166-1 alpha-2 comme FR, DE ou US.
Charge utile de la requête
Construisez le tableau data
{
"data": [
{ "name": "Camille", "country": "FR", "id": "123" },
{ "name": "Andrea", "country": "IT", "id": "456" },
{ "name": "James", "country": "US", "id": "789" }
]
}Exemples de code
Envoyez une requête avec plusieurs prénoms
curl -X POST "https://api.genderapi.io/api/name/multi/country" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"data":[{"name":"Camille","country":"FR","id":"123"},{"name":"Andrea","country":"IT","id":"456"}]}'const data = [
{ name: "Camille", country: "FR", id: "123" },
{ name: "Andrea", country: "IT", id: "456" }
];
const response = await fetch("https://api.genderapi.io/api/name/multi/country", {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
body: JSON.stringify({ data })
});Réponse 200
Rapprochez les résultats de vos enregistrements
{
"status": true,
"used_credits": 2,
"remaining_credits": 7265,
"expires": 1717069765,
"names": [
{ "name": "camille", "q": "Camille", "gender": "female", "country": "FR", "total_names": 644, "probability": 88, "id": "123" },
{ "name": "andrea", "q": "Andrea", "gender": "male", "country": "IT", "total_names": 13537, "probability": 98, "id": "456" }
],
"duration": "5ms"
}Champs de la réponse
| Champ | Type | Description |
|---|---|---|
status | boolean | Indique si la requête groupée a été traitée correctement. |
used_credits | integer | Crédits consommés par tous les prénoms envoyés. |
remaining_credits | integer | Crédits disponibles après la requête. |
expires | integer | Date d’expiration du pack sous forme d’horodatage UNIX. |
names | object[] | Collection ordonnée des résultats d’estimation. |
names[].name | string | Prénom normalisé utilisé pour l’estimation. |
names[].q | string | Prénom transmis à l’origine dans la requête. |
names[].gender | string | null | Valeur estimée : male, female ou null. |
names[].country | string | Code pays pris en compte pour ce résultat. |
names[].total_names | integer | Nombre d’échantillons sur lesquels repose le résultat. |
names[].probability | integer | Niveau de confiance de l’estimation, exprimé en pourcentage. |
names[].id | string | integer | Identifiant d’entrée renvoyé pour rapprocher les enregistrements. |
duration | string | Temps total de traitement côté serveur. |
Limitez chaque requête à 100 enregistrements
Validez le tableau avant l’envoi et utilisez un id unique pour rapprocher les données sans ambiguïté. Découpez les jeux de données plus importants en lots de 100 prénoms maximum.
Guide suivant