DOCS API

UTILISATION SIMPLE

Constitue la manière la plus simple de faire une demande d’identification de sexe. Chaque réponse est encodée au format JSON :

Demande
GET https://gender-api.com/get?name=Diana&key=<your private server key>
Domaine Type Description
name String Nom faisant l’objet de la demande
key String Votre clé privée de serveur
Réponse
{"name":"diana","name_sanitized":"Diana","gender":"female","samples":523,"accuracy":93,"duration":"41ms","credits_used":1}
Domaine Type Description
name String Nom fourni en minuscules
name_sanitized String Le nom après utilisation de notre normalisateur
gender String Valeurs possibles : homme, femme, sexe inconnu
samples Integer Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
accuracy Integer Cette valeur indique la fiabilité de notre base de données. Une valeur de 100 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
duration String Temps nécessaire au serveur pour traiter la demande
credits_used Integer Quantité de crédits utilisés pour cette demande

LOCALISATION

Augmentez la précision de votre demande en localisant cette dernière :

Demande
Exemple Italie
GET https://gender-api.com/get?name=Andrea&country=IT&key=<your private server key>
Demande
Exemple Allemagne
GET https://gender-api.com/get?name=Andrea&country=DE&key=<your private server key>
Domaine Type Description
name String Nom faisant l’objet de la demande
country String Code pays ISO 3166 ALPHA-2
key String Votre clé privée de serveur
Réponse
Exemple Italie
//In Italy, Andrea is male. 
{"name":"andrea","name_sanitized":"Andrea","country":"IT","gender":"male","samples":1068,"accuracy":95,"duration":"15ms","credits_used":1}
Réponse
Exemple Allemagne
//In Germany, Andrea is female. 
{"name":"andrea","name_sanitized":"Andrea","country":"DE","gender":"female","samples":4089,"accuracy":85,"duration":"33ms","credits_used":1}
Domaine Type Description
name String Nom fourni en minuscules
name_sanitized String Le nom après utilisation de notre normalisateur
country String Code pays fourni
gender String Valeurs possibles : homme, femme, sexe inconnu
samples Integer Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
accuracy Integer Cette valeur indique la fiabilité de notre base de données. Une valeur de 100 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
duration String Temps nécessaire au serveur pour traiter la demande
credits_used Integer Quantité de crédits utilisés pour cette demande

Codes pays valides :

AD
Andorra
AE
United Arab Emirates
AF
Afghanistan
AL
Albania
AM
Armenia
AO
Angola
AR
Argentina
AT
Austria
AU
Australia
AZ
Azerbaijan
BA
Bosnia and Herzegovina
BB
Barbados
BD
Bangladesh
BE
Belgium
BF
Burkina Faso
BG
Bulgaria
BH
Bahrain
BI
Burundi
BJ
Benin
BN
Brunei
BO
Bolivia
BR
Brazil
BS
Bahamas
BW
Botswana
BY
Belarus
CA
Canada
CD
Congo - Kinshasa
CG
Congo - Brazzaville
CH
Switzerland
CI
Côte d’Ivoire
CL
Chile
CM
Cameroon
CN
China
CO
Colombia
CR
Costa Rica
CU
Cuba
CV
Cape Verde
CY
Cyprus
CZ
Czech Republic
DE
Germany
DJ
Djibouti
DK
Denmark
DO
Dominican Republic
DZ
Algeria
EC
Ecuador
EE
Estonia
EG
Egypt
ES
Spain
ET
Ethiopia
FI
Finland
FJ
Fiji
FR
France
GA
Gabon
GB
United Kingdom
GE
Georgia
GF
French Guiana
GH
Ghana
GI
Gibraltar
GM
Gambia
GN
Guinea
GP
Guadeloupe
GQ
Equatorial Guinea
GR
Greece
GT
Guatemala
GY
Guyana
HK
Hong Kong SAR China
HN
Honduras
HR
Croatia
HT
Haiti
HU
Hungary
ID
Indonesia
IE
Ireland
IL
Israel
IN
India
IQ
Iraq
IR
Iran
IS
Iceland
IT
Italy
JE
Jersey
JM
Jamaica
JO
Jordan
JP
Japan
KE
Kenya
KG
Kyrgyzstan
KH
Cambodia
KM
Comoros
KR
South Korea
KW
Kuwait
KZ
Kazakhstan
LA
Laos
LB
Lebanon
LK
Sri Lanka
LR
Liberia
LS
Lesotho
LT
Lithuania
LU
Luxembourg
LV
Latvia
LY
Libya
MA
Morocco
MC
Monaco
MD
Moldova
ME
Montenegro
MG
Madagascar
MK
Macedonia
ML
Mali
MM
Myanmar [Burma]
MN
Mongolia
MQ
Martinique
MR
Mauritania
MT
Malta
MU
Mauritius
MV
Maldives
MW
Malawi
MX
Mexico
MY
Malaysia
MZ
Mozambique
NA
Namibia
NC
New Caledonia
NE
Niger
NG
Nigeria
NI
Nicaragua
NL
Netherlands
NO
Norway
NP
Nepal
NZ
New Zealand
OM
Oman
PA
Panama
PE
Peru
PF
French Polynesia
PG
Papua New Guinea
PH
Philippines
PK
Pakistan
PL
Poland
PR
Puerto Rico
PS
Palestinian Territories
PT
Portugal
PY
Paraguay
QA
Qatar
RE
Réunion
RO
Romania
RS
Serbia
RU
Russia
RW
Rwanda
SA
Saudi Arabia
SC
Seychelles
SD
Sudan
SE
Sweden
SG
Singapore
SH
Saint Helena
SI
Slovenia
SK
Slovakia
SL
Sierra Leone
SN
Senegal
SO
Somalia
SV
El Salvador
SY
Syria
SZ
Swaziland
TD
Chad
TG
Togo
TH
Thailand
TJ
Tajikistan
TM
Turkmenistan
TN
Tunisia
TR
Turkey
TT
Trinidad and Tobago
TW
Taiwan
TZ
Tanzania
UA
Ukraine
UG
Uganda
US
United States
UY
Uruguay
UZ
Uzbekistan
VE
Venezuela
VN
Vietnam
YE
Yemen
ZA
South Africa
ZM
Zambia
ZW
Zimbabwe

LOCALISATION - PAYS SELON ADRESSE IP

Choisissez le pays de votre client en fonction de son adresse IP :

Demande
Exemple avec une adresse IP aux États-Unis
GET https://gender-api.com/get?name=john&ip=54.201.16.177&key=<your private server key>
Demande
Exemple avec une adresse IP en Allemagne
GET https://gender-api.com/get?name=tanja&ip=178.27.177.23&key=<your private server key>
Domaine Type Description
name String Nom faisant l’objet de la demande
ip String Adresse IP valide
key String Votre clé privée de serveur
Réponse
Exemple avec une adresse IP aux États-Unis
{"name":"john","name_sanitized":"John","country":"US","gender":"male","samples":9991,"accuracy":99,"duration":"44ms","credits_used":1}
Réponse
Exemple avec une adresse IP en Allemagne
{"name":"tanja","name_sanitized":"Tanja","country":"DE","gender":"female","samples":143,"accuracy":97,"duration":"508ms","credits_used":1}
Domaine Type Description
name String Nom fourni en minuscules
name_sanitized String Le nom après utilisation de notre normalisateur
country String Code pays fourni
gender String Valeurs possibles : homme, femme, sexe inconnu
samples Integer Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
accuracy Integer Cette valeur indique la fiabilité de notre base de données. Une valeur de 100 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
duration String Temps nécessaire au serveur pour traiter la demande
credits_used Integer Quantité de crédits utilisés pour cette demande

Gender-API.com comprend des données GeoLite2 créées par MaxMind, disponibles auprès de http://www.maxmind.com.

LOCALISATION - PAYS SELON LANGUE / PARAMÈTRES RÉGIONAUX DU NAVIGATEUR

Choisissez le pays de votre client en fonction des paramètres régionaux définis dans son navigateur :

Demande
Exemple avec des paramètres régionaux américains
GET https://gender-api.com/get?name=john&locale=en_US&key=<your private server key>
Demande
Exemple avec des paramètres régionaux allemands
GET https://gender-api.com/get?name=tanja&locale=de_DE&key=<your private server key>
Domaine Type Description
name String Nom faisant l’objet de la demande
locale String Browser locale
key String Votre clé privée de serveur
Réponse
Exemple avec des paramètres régionaux américains
{"name":"john","name_sanitized":"John","country":"US","gender":"male","samples":991,"accuracy":99,"duration":"47ms","credits_used":1}
Réponse
Exemple avec des paramètres régionaux allemands
{"name":"tanja","name_sanitized":"Tanja","country":"DE","gender":"female","samples":143,"accuracy":97,"duration":"99ms","credits_used":1}
Domaine Type Description
name String Nom fourni en minuscules
name_sanitized String Le nom après utilisation de notre normalisateur
country String Code pays fourni
gender String Valeurs possibles : homme, femme, sexe inconnu
samples Integer Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
accuracy Integer Cette valeur indique la fiabilité de notre base de données. Une valeur de 100 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
duration String Temps nécessaire au serveur pour traiter la demande
credits_used Integer Quantité de crédits utilisés pour cette demande

Gender-API.com comprend des données GeoLite2 créées par MaxMind, disponibles auprès de http://www.maxmind.com.

DEMANDE PORTANT SUR PLUSIEURS NOMS

Il est parfois nécessaire de combiner plusieurs noms dans le cadre d’une demande :

Demande
Sans code pays
GET https://gender-api.com/get?name=lisa;jess;thomas&multi=true&key=<your private server key>
Demande
Avec code pays
GET https://gender-api.com/get?name=anna;jack;stephen&country=DE;US;CA&multi=true&key=<your private server key>
Domaine Type Description
name String Liste de noms faisant l’objet de la demande, séparés par des points-virgules
country String Liste de codes pays séparés par des points-virgules. Les codes pays doivent figurer dans le même ordre que les noms. Si un seul code pays est fourni, il sera utilisé pour tous les noms.
multi Boolean (true|false) Indique à l'API de renvoyer le résultat sous forme de tableau
key String Votre clé privée de serveur
Réponse
Sans code pays
{"name":"lisa;jess;thomas","result":[
{"name":"lisa","name_sanitized":"Lisa","country":"","gender":"female","samples":806,"accuracy":98},
{"name":"jess","name_sanitized":"Jess","country":"","gender":"female","samples":28,"accuracy":75},
{"name":"thomas","name_sanitized":"Thomas","country":"","gender":"male","samples":2239,"accuracy":99}],
"country":"","duration":"425ms","credits_used":3}
Réponse
Avec code pays
{"name":"anna;jack;stephen","result":[
{"name":"anna","name_sanitized":"Anna","country":"DE","gender":"female","samples":1245,"accuracy":98},
{"name":"jack","name_sanitized":"Jack","country":"US","gender":"male","samples":667,"accuracy":90},
{"name":"stephen","name_sanitized":"Stephen","country":"CA","gender":"male","samples":77,"accuracy":82}],
"country":"DE;US;CA","duration":"668ms","credits_used":3}
Domaine Type Description
name String Noms fournis en minuscules. Le nombre maximal de noms est limité à 100.
result Array Voir la réponse sous "Utilisation simple"
country String Liste de codes pays fournie
duration String Temps nécessaire au serveur pour traiter la demande
credits_used Integer Quantité de crédits utilisés pour cette demande

Remarque : si une demande porte sur plusieurs noms, chaque nom est décompté comme formant une seule demande.

ADRESSE ÉLECTRONIQUE

Vous pouvez également faire une demande relative au sexe d’une personne sur la base d’une adresse électronique contenant un prénom :

Demande
Sans code pays
GET https://gender-api.com/get?email=markus.johnson@gmail.com&key=<your private server key>
Demande
Avec code pays
GET https://gender-api.com/get?email=jack.meyer@gmail.com&country=US&key=<your private server key>
Domaine Type Description
name String Nom faisant l’objet de la demande
email String Email address
key String Votre clé privée de serveur
Réponse
Sans code pays
{"email":"markus.johnson@gmail.com","last_name":"Johnson","first_name":"Markus","mail_provider":"gmail","name":"markus","name_sanitized":"Markus","country":"","gender":"male","samples":150,"accuracy":99,"duration":"669ms","credits_used":1}
Réponse
Avec code pays
{"email":"jack.meyer@gmail.com","last_name":"Meyer","first_name":"Jack","mail_provider":"gmail","name":"jack","name_sanitized":"Jack","country":"US","gender":"male","samples":667,"accuracy":90,"duration":"1011ms","credits_used":1}
Domaine Type Description
email String L’adresse électronique fournie
last_name String Le nom trouvé
first_name String Le prénom trouvé
mail_provider String Nom du fournisseur de messagerie
name String Prénom trouvé en minuscules
name_sanitized String Le nom après utilisation de notre normalisateur
country String Code pays fourni
gender String Valeurs possibles : homme, femme, sexe inconnu
samples Integer Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
accuracy Integer Cette valeur indique la fiabilité de notre base de données. Une valeur de 100 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
duration String Temps nécessaire au serveur pour traiter la demande
credits_used Integer Quantité de crédits utilisés pour cette demande

SÉPARER LE PRÉNOM DU NOM

Si vous utilisez un champ combiné pour le prénom et le nom sur votre page, utilisez cette API pour extraire les différentes parties :

Demande
Sans code pays
GET https://gender-api.com/get?split=theresa%20miller&key=<your private server key>
Demande
Avec code pays
GET https://gender-api.com/get?split=tim%20johnson&country=US&key=<your private server key>
Demande
Mode strict activé
GET https://gender-api.com/get?split=markus%20stefan%20nonExistingLastName&strict=true&key=<your private server key>
Domaine Type Description
split String Nom complet
country String Code pays ISO 3166 ALPHA-2
strict Boolean (true|false) Lorsque le mode strict est activé, nous renvoyons la valeur « null » dans le champ « nom » (last_name) si le nom ne peut pas être trouvé dans notre base de données. Lorsque le mode strict est désactivé, nous essayons d'extraire le nom même s’il ne peut pas être trouvé dans notre base de données.
key String Votre clé privée de serveur
Réponse
Sans code pays
{"last_name":"Miller","first_name":"Theresa","strict":false,"name":"theresa","name_sanitized":"Theresa","country":"","gender":"female","samples":70,"accuracy":74,"duration":"56ms","credits_used":1}
Réponse
Avec code pays
{"last_name":"Johnson","first_name":"Tim","strict":false,"name":"tim","name_sanitized":"Tim","country":"US","gender":"male","samples":7,"accuracy":100,"duration":"58ms","credits_used":1}
Réponse
Mode strict activé
{"last_name":"","first_name":"Markus Stefan","strict":true,"name":"markus","name_sanitized":"Markus","country":"","gender":"male","samples":150,"accuracy":99,"duration":"85ms","credits_used":1}
Domaine Type Description
last_name String Le nom trouvé
first_name String Le prénom trouvé
strict Boolean Valeur « vrai » si le mode strict est activé
name String Prénom trouvé en minuscules
name_sanitized String Le nom après utilisation de notre normalisateur
country String Code pays fourni
gender String Valeurs possibles : homme, femme, sexe inconnu
samples Integer Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
accuracy Integer Cette valeur indique la fiabilité de notre base de données. Une valeur de 100 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
duration String Temps nécessaire au serveur pour traiter la demande
credits_used Integer Quantité de crédits utilisés pour cette demande

Indiquez les noms de vos clients dans le formulaire « First Name, Last Name » (« Prénom, Nom ») ; cela accroît la précision de notre réponse.

OBTENIR LES STATISTIQUES

Avec cet appel, vous pouvez mettre des statistiques sur votre compte :

Demande
GET https://gender-api.com/get-stats?&key=<your private server key>
Domaine Type Description
key String Votre clé privée de serveur
Réponse
{"key":"yourkey","is_limit_reached":false,"remaining_requests":43566,"amount_month_start":90000,"amount_month_bought":100000,"duration":"37ms"}
Domaine Type Description
key String Votre clé privée de serveur
is_limit_reached Boolean Renvoie la valeur « vrai » s’il ne reste plus de demandes
remaining_requests Integer Compte les demandes restantes
amount_month_start Integer Demandes restantes au début du mois
amount_month_bought Integer Demandes achetées au cours du mois en cours
duration String Temps nécessaire au serveur pour traiter la demande

CODES D’ERREUR

Réponse
Error Example Message
{"errno":30,"errmsg":"limit reached"}
errno (numéro d’erreur) errmsg (message d’erreur) Description
10 invalid country code Voir "Codes pays valides"
11 number of country codes not equal to number of names Le nombre de noms ne correspond pas au nombre de codes pays
20 name not set Aucun nom n’a été reçu par le serveur
21 too many names Seulement 100 noms sont autorisés à la fois
30 limit reached Nombre maximum de demandes atteint
40 invalid or missing key Votre clé de serveur n’a pas été trouvée dans notre base de données
500 unknown error Erreur interne du serveur
Ce produit comprend des données GeoLite2 créées par MaxMind, disponibles auprès de http://www.maxmind.com.
Nous utilisons des « cookies » afin de vous garantir la meilleure expérience possible sur notre site Web. Si vous continuez à utiliser ce site, nous supposerons que vous nous autorisez à utiliser ces « cookies ».
OK !