API Docs Unified API

Query By First Name
Query By Full Name
Query By Email Address
Get Country Of Origin
Obtenir des statistiques
Problem Details

Query by first name

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

Post
Required Credits: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <your authorization token>
link
JSON Payload
Domaine Type Required Description
first_name string Oui Nom faisant l’objet de la demande
country string Non ISO 3166 ALPHA-2 Country Code
link
locale string Non Browser Locale
ip string Non Valid IPv4 or IPv6 address
id string Non Max 50 chars. You can set this id to any alphanumeric value you want. As an example, you can set the id to your internal id of the dataset in your database. In an asynchronus environment this can help you to better connect the response to a previous request

Exemple

Query by first name only
play_arrow Test live with codepen.io 
{"first_name":"Sandra"}
Query by first name and country code
play_arrow Test live with codepen.io 
{"first_name":"Sandra","country":"US"}
Query by first name and browser locale
play_arrow Test live with codepen.io 
{"first_name":"Sandra","locale":"en_US"}
Query by first name and use an IP address for localization
play_arrow Test live with codepen.io 
{"first_name":"Sandra","ip":"54.201.16.177"}
Query multiple names in a single request
play_arrow Test live with codepen.io 
[{"first_name":"Sandra","country":"US"},{"first_name":"Jason","country":"US"}]
Réponse
{
    "input": {
        "first_name": "Sandra"
    },
    "details": {
        "credits_used": 1,
        "samples": 464,
        "country": null,
        "first_name_sanitized": "sandra",
        "duration": "436ms"
    },
    "result_found": true,
    "first_name": "Sandra",
    "probability": 0.85,
    "gender": "female"
}
Domaine Type Description
input array The submitted payload
details.credits_used int Quantité de crédits utilisés pour cette demande
details.samples int Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
details.country string The country we found
details.first_name_sanitized int Le nom après utilisation de notre normalisateur
details.duration int Temps nécessaire au serveur pour traiter la demande
result_found bool True if we were able to query a gender for the given name
first_name string The first name we used for genderization
probability string Cette valeur indique la fiabilité de notre base de données. Une valeur de 1 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
gender string Valeurs possibles : homme, femme, sexe inconnu

Query by full name - 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:

Post
Required Credits: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <your authorization token>
link
JSON Payload
Domaine Type Required Description
full_name string Oui Nom faisant l’objet de la demande
country string Non ISO 3166 ALPHA-2 Country Code
link
locale string Non Browser Locale
ip string Non Valid IPv4 or IPv6 address
id string Non Max 50 chars. You can set this id to any alphanumeric value you want. As an example, you can set the id to your internal id of the dataset in your database. In an asynchronus environment this can help you to better connect the response to a previous request

Exemple

Query by full name only
play_arrow Test live with codepen.io 
{"full_name":"Theresa Miller"}
Query by full name and country code
play_arrow Test live with codepen.io 
{"full_name":"Theresa Miller","country":"US"}
Query by full name and browser locale
play_arrow Test live with codepen.io 
{"full_name":"Thomas Johnson","locale":"en_US"}
Query by full name and use an IP address for localization
play_arrow Test live with codepen.io 
{"full_name":"Markus Stefan NonExistingLastName","ip":"54.201.16.177"}
Query multiple names in a single request
play_arrow Test live with codepen.io 
[{"full_name":"Theresa Miller"},{"full_name":"Thomas Johnson","country":"US"}]
Réponse
{
    "input": {
        "full_name": "Sandra"
    },
    "details": {
        "credits_used": 1,
        "samples": 464,
        "country": null,
        "full_name_sanitized": "sandra",
        "duration": "436ms"
    },
    "result_found": true,
    "full_name": "Sandra",
    "probability": 0.85,
    "gender": "female"
}
Domaine Type Description
input array The submitted payload
details.credits_used int Quantité de crédits utilisés pour cette demande
details.samples int Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
details.country string The country we found
details.full_name_sanitized int Le nom après utilisation de notre normalisateur
details.duration int Temps nécessaire au serveur pour traiter la demande
result_found bool True if we were able to query a gender for the given name
full_name string The full name we used for genderization
probability string Cette valeur indique la fiabilité de notre base de données. Une valeur de 1 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
gender string Valeurs possibles : homme, femme, sexe inconnu

Query by email address

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

Post
Required Credits: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <your authorization token>
link
JSON Payload
Domaine Type Required Description
email string Oui Nom faisant l’objet de la demande
country string Non ISO 3166 ALPHA-2 Country Code
link
locale string Non Browser Locale
ip string Non Valid IPv4 or IPv6 address
id string Non Max 50 chars. You can set this id to any alphanumeric value you want. As an example, you can set the id to your internal id of the dataset in your database. In an asynchronus environment this can help you to better connect the response to a previous request

Exemple

Query by email address only
play_arrow Test live with codepen.io 
{"email":"theresa.miller14@gmail.com"}
Query by email address and country code
play_arrow Test live with codepen.io 
{"email":"thomas.clarks@hotmail.com","country":"US"}
Query by email address and browser locale
play_arrow Test live with codepen.io 
{"email":"Thomas.j32@live.com","locale":"en_US"}
Query by email address and use an IP address for localization
play_arrow Test live with codepen.io 
{"email":"thomasfromnewyork@gmail.com","ip":"54.201.16.177"}
Query multiple names in a single request
play_arrow Test live with codepen.io 
[{"email":"thomas.clarks@hotmail.com","country":"US"},{"email":"theresa.miller14@gmail.com"}]
Réponse
{
    "input": {
        "email": "Sandra"
    },
    "details": {
        "credits_used": 1,
        "samples": 464,
        "country": null,
        "email_sanitized": "sandra",
        "duration": "436ms"
    },
    "result_found": true,
    "email": "Sandra",
    "probability": 0.85,
    "gender": "female"
}
Domaine Type Description
input array The submitted payload
details.credits_used int Quantité de crédits utilisés pour cette demande
details.samples int Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
details.country string The country we found
details.email_sanitized int Le nom après utilisation de notre normalisateur
details.duration int Temps nécessaire au serveur pour traiter la demande
result_found bool True if we were able to query a gender for the given name
email string The email address we used for genderization
probability string Cette valeur indique la fiabilité de notre base de données. Une valeur de 1 signifie que les résultats concernant votre demande d’identification de sexe sont précis à 100 %.
gender string Valeurs possibles : homme, femme, sexe inconnu

Get Country Of Origin

Get a name's country of origin:

Post
Required Credits: 2
URL
https://gender-api.com/v2/country-of-origin
Headers
Content-Type: application/json
Authorization: Bearer <your authorization token>
link
JSON Payload
Domaine Type Required Description
first_name string Oui First name to query
full_name string Non Full name to query. Can be provided instead of the first_name field
email string Non Email address to query. Can be provided instead of the first_name field
id string Non Max 50 chars. You can set this id to any alphanumeric value you want. As an example, you can set the id to your internal id of the dataset in your database. In an asynchronus environment this can help you to better connect the response to a previous request

Exemple

Query by first name
play_arrow Test live with codepen.io 
{"first_name":"Johann"}
Query by full name
play_arrow Test live with codepen.io 
{"full_name":"Theresa Miller"}
Query by email address
play_arrow Test live with codepen.io 
{"full_name":"sophia5342@gmail.com"}
Réponse
{
    "input": {
        "first_name": "Johann",
        "id": 12
    },
    "details": {
        "credits_used": 2,
        "duration": "414ms",
        "samples": 890,
        "country": null,
        "first_name_sanitized": "johann"
    },
    "result_found": true,
    "country_of_origin": [
        {
            "country_name": "Germany",
            "country": "DE",
            "probability": 0.52,
            "continental_region": "Europe",
            "statistical_region": "Western Europe"
        },
        {
            "country_name": "Austria",
            "country": "AT",
            "probability": 0.48,
            "continental_region": "Europe",
            "statistical_region": "Western Europe"
        }
    ],
    "first_name": "Johann",
    "probability": 0.9,
    "gender": "male"
}
Domaine Type Description
input array The submitted payload
details.credits_used int Quantité de crédits utilisés pour cette demande
details.samples int Nombre d’enregistrements trouvés dans notre base de données qui correspondent à votre demande
details.country string The country we found
details.first_name_sanitized int Le nom après utilisation de notre normalisateur
details.duration int Temps nécessaire au serveur pour traiter la demande
result_found bool True if we were able to query a gender for the given name
first_name string The first name we used for genderization
probability string This value (between 0 and 1) determines the reliability of our database. A value of 1 means that the results on your gender request are 100% accurate
gender string Valeurs possibles : homme, femme, sexe inconnu
country_of_origin array Top 25 countries of origin. See "Complete List Of Possible Countries" for a list of supported countries. Every record contains the fields country_name, country, probability, continental_region and statistical_region
Screenshot Interactive Map
Complete List Of Possible Countries
Country Code Country Name Statistical Region Continental Region
CN China Eastern Asia Asia
IN India Southern Asia Asia
US United States Northern America Americas
ID Indonesia South-eastern Asia Asia
BR Brazil South America Americas
PK Pakistan Southern Asia Asia
NG Nigeria Western Africa Africa
BD Bangladesh Southern Asia Asia
RU Russia Eastern Europe Europe
MX Mexico Central America Americas
JP Japan Eastern Asia Asia
ET Ethiopia Eastern Africa Africa
PH Philippines South-eastern Asia Asia
EG Egypt Northern Africa Africa
VN Vietnam South-eastern Asia Asia
DE Germany Western Europe Europe
CD Democratic Republic of the Congo Middle Africa Africa
IR Iran Southern Asia Asia
TR Turkey Western Asia Asia
TH Thailand South-eastern Asia Asia
GB United Kingdom Northern Europe Europe
FR France Western Europe Europe
IT Italy Southern Europe Europe
TZ Tanzania Eastern Africa Africa
ZA South Africa Southern Africa Africa
MM Myanmar South-eastern Asia Asia
KR South Korea Eastern Asia Asia
CO Colombia South America Americas
KE Kenya Eastern Africa Africa
ES Spain Southern Europe Europe
AR Argentina South America Americas
UA Ukraine Eastern Europe Europe
UG Uganda Eastern Africa Africa
DZ Algeria Northern Africa Africa
SD Sudan Northern Africa Africa
IQ Iraq Western Asia Asia
PL Poland Eastern Europe Europe
CA Canada Northern America Americas
MA Morocco Northern Africa Africa
AF Afghanistan Southern Asia Asia
SA Saudi Arabia Western Asia Asia
PE Peru South America Americas
VE Venezuela South America Americas
UZ Uzbekistan Central Asia Asia
MY Malaysia South-eastern Asia Asia
AO Angola Middle Africa Africa
MZ Mozambique Eastern Africa Africa
NP Nepal Southern Asia Asia
GH Ghana Western Africa Africa
YE Yemen Western Asia Asia
MG Madagascar Eastern Africa Africa
KP North Korea Eastern Asia Asia
AU Australia AustraliaandNew Zealand Oceania
CI Ivory Coast Western Africa Africa
CM Cameroon Middle Africa Africa
TW Taiwan Eastern Asia Asia
NE Niger Western Africa Africa
LK Sri Lanka Southern Asia Asia
RO Romania Eastern Europe Europe
BF Burkina Faso Western Africa Africa
MW Malawi Eastern Africa Africa
ML Mali Western Africa Africa
SY Syria Western Asia Asia
KZ Kazakhstan Central Asia Asia
CL Chile South America Americas
ZM Zambia Eastern Africa Africa
NL Netherlands Western Europe Europe
GT Guatemala Central America Americas
EC Ecuador South America Americas
ZW Zimbabwe Eastern Africa Africa
KH Cambodia South-eastern Asia Asia
SN Senegal Western Africa Africa
TD Chad Middle Africa Africa
SO Somalia Eastern Africa Africa
GN Guinea Western Africa Africa
SD Sudan Northern Africa Africa
RW Rwanda Eastern Africa Africa
TN Tunisia Northern Africa Africa
CU Cuba Caribbean Americas
BE Belgium Western Europe Europe
BJ Benin Western Africa Africa
GR Greece Southern Europe Europe
BO Bolivia South America Americas
HT Haiti Caribbean Americas
BI Burundi Eastern Africa Africa
DO Dominican Republic Caribbean Americas
CZ Czech Republic Eastern Europe Europe
PT Portugal Southern Europe Europe
SE Sweden Northern Europe Europe
AZ Azerbaijan Western Asia Asia
HU Hungary Eastern Europe Europe
JO Jordan Western Asia Asia
BY Belarus Eastern Europe Europe
AE United Arab Emirates Western Asia Asia
HN Honduras Central America Americas
TJ Tajikistan Central Asia Asia
RS Serbia Southern Europe Europe
AT Austria Western Europe Europe
CH Switzerland Western Europe Europe
IL Israel Western Asia Asia
PG Papua New Guinea Melanesia Oceania
TG Togo Western Africa Africa
SL Sierra Leone Western Africa Africa
HK Hong Kong Eastern Asia Asia
BG Bulgaria Eastern Europe Europe
LA Laos South-eastern Asia Asia
PY Paraguay South America Americas
SV El Salvador Central America Americas
LY Libya Northern Africa Africa
NI Nicaragua Central America Americas
LB Lebanon Western Asia Asia
KG Kyrgyzstan Central Asia Asia
TM Turkmenistan Central Asia Asia
DK Denmark Northern Europe Europe
SG Singapore South-eastern Asia Asia
FI Finland Northern Europe Europe
SK Slovakia Eastern Europe Europe
NO Norway Northern Europe Europe
CG Congo Middle Africa Africa
ER Eritrea Eastern Africa Africa
PS Palestine Western Asia Asia
CR Costa Rica Central America Americas
IE Ireland Northern Europe Europe
LR Liberia Western Africa Africa
NZ New Zealand AustraliaandNew Zealand Oceania
CF Central African Republic Middle Africa Africa
OM Oman Western Asia Asia
MR Mauritania Western Africa Africa
HR Croatia Southern Europe Europe
KW Kuwait Western Asia Asia
PA Panama Central America Americas
MD Moldova Eastern Europe Europe
GE Georgia Western Asia Asia
PR Puerto Rico Caribbean Americas
BA Bosnia and Herzegovina Southern Europe Europe
UY Uruguay South America Americas
MN Mongolia Eastern Asia Asia
AM Armenia Western Asia Asia
AL Albania Southern Europe Europe
JM Jamaica Caribbean Americas
LT Lithuania Northern Europe Europe
QA Qatar Western Asia Asia
NA Namibia Southern Africa Africa
BW Botswana Southern Africa Africa
LS Lesotho Southern Africa Africa
GM The Gambia Western Africa Africa
MK Republic of Macedonia Southern Europe Europe
SI Slovenia Southern Europe Europe
GA Gabon Middle Africa Africa
LV Latvia Northern Europe Europe
GW Guinea-Bissau Western Africa Africa
BH Bahrain Western Asia Asia
TT Trinidad and Tobago Caribbean Americas
SZ Swaziland Southern Africa Africa
EE Estonia Northern Europe Europe
TL East Timor South-eastern Asia Asia
GQ Equatorial Guinea Middle Africa Africa
MU Mauritius Eastern Africa Africa
CY Cyprus Western Asia Asia
DJ Djibouti Eastern Africa Africa
FJ Fiji Melanesia Oceania
RE Réunion Eastern Africa Africa
KM Comoros Eastern Africa Africa
BT Bhutan Southern Asia Asia
GY Guyana South America Americas
ME Montenegro Southern Europe Europe
MO Macau Eastern Asia Asia
SB Solomon Islands Melanesia Oceania
LU Luxembourg Western Europe Europe
SR Suriname South America Americas
EH Western Sahara Northern Africa Africa
CV Cape Verde Western Africa Africa
GP Guadeloupe Caribbean Americas
MV Maldives Southern Asia Asia
MT Malta Southern Europe Europe
BN Brunei South-eastern Asia Asia
BS Bahamas Caribbean Americas
MQ Martinique Caribbean Americas
BZ Belize Central America Americas
IS Iceland Northern Europe Europe
BB Barbados Caribbean Americas
PF French Polynesia Polynesia Oceania
GF French Guiana South America Americas
NC New Caledonia Melanesia Oceania
VU Vanuatu Melanesia Oceania
YT Mayotte Eastern Africa Africa
ST Sao Tome and Principe Middle Africa Africa
WS Samoa Polynesia Oceania
LC Saint Lucia Caribbean Americas
JE Guernsey and Jersey Northern Europe Europe
GU Guam Micronesia Oceania
CW Curaçao Caribbean Americas
KI Kiribati Micronesia Oceania
VC Saint Vincent and the Grenadines Caribbean Americas
TO Tonga Polynesia Oceania
GD Grenada Caribbean Americas
FM Federated States of Micronesia Micronesia Oceania
AW Aruba Caribbean Americas
VI United States Virgin Islands Caribbean Americas
AG Antigua and Barbuda Caribbean Americas
SC Seychelles Eastern Africa Africa
IM Isle of Man Northern Europe Europe
AD Andorra Southern Europe Europe
DM Dominica Caribbean Americas
KY Cayman Islands Caribbean Americas
BM Bermuda Northern America Americas
GL Greenland Northern America Americas
AS American Samoa Polynesia Oceania
KN Saint Kitts and Nevis Caribbean Americas
MP Northern Mariana Islands Micronesia Oceania
MH Marshall Islands Micronesia Oceania
FO Faroe Islands Northern Europe Europe
SX Sint Maarten Caribbean Americas
MC Monaco Western Europe Europe
LI Liechtenstein Western Europe Europe
TC Turks and Caicos Islands Caribbean Americas
GI Gibraltar Southern Europe Europe
SM San Marino Southern Europe Europe
VG British Virgin Islands Caribbean Americas
BQ Caribbean Netherlands Caribbean Americas
PW Palau Micronesia Oceania
CK Cook Islands Polynesia Oceania
AI Anguilla Caribbean Americas
WF Wallis and Futuna Polynesia Oceania
NR Nauru Micronesia Oceania
TV Tuvalu Polynesia Oceania
PM Saint Pierre and Miquelon Northern America Americas
MS Montserrat Caribbean Americas
SH Saint Helena Ascension and Tristan da Cunha Western Africa Africa
FK Falkland Islands South America Americas
NU Niue Polynesia Oceania
TK Tokelau Polynesia Oceania
VA Vatican City Southern Europe Europe

Obtenir des statistiques

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

Post
URL
https://gender-api.com/v2/statistic
Headers
Content-Type: application/json
Authorization: Bearer <your authorization token>
link
Réponse
{
    "is_limit_reached": false,
    "remaining_credits": 24999,
    "details": {
        "credits_used": 0,
        "duration": "83ms"
    },
    "usage_last_month": {
        "date": "2018-03",
        "credits_used": 25
    }
}
Domaine Type Description
is_limit_reached bool Renvoie la valeur « vrai » s’il ne reste plus de demandes
remaining_credits int Number of credits left
details.credits_used int Quantité de crédits utilisés pour cette demande
details.duration int Temps nécessaire au serveur pour traiter la demande
usage_last_month.date string Last month's date
usage_last_month.credits_used int Credits that you have used over the last month

Problem Details

endpoint-not-found
Status endpoint-not-found
HTTP Status Code 404
Description API endpoint not found
limit-exceeded
Status limit-exceeded
HTTP Status Code 401
Description Limit exceeded. Thank you for using our service. Please consider to buy more credits.
parameter-first-name-invalid
Status parameter-first-name-invalid
HTTP Status Code 400
Description The "first_name" parameter is invalid. The parameter can only be a string with a length from 1 to 50 chars.
parameter-full-name-invalid
Status parameter-full-name-invalid
HTTP Status Code 400
Description The "full_name" parameter is invalid. The parameter can only be a string with a length from 3 to 100 chars.
parameter-email-invalid
Status parameter-email-invalid
HTTP Status Code 400
Description The "email" parameter is invalid. The parameter can only be a string with a length from 3 to 100 chars and must be a valid email address.
key-parameter-missing
Status key-parameter-missing
HTTP Status Code 400
Description The "key" parameter is not set. Please create an account to fetch an API key.
invalid-key
Status invalid-key
HTTP Status Code 400
Description Invalid API key. You can find your personal API key in your account.
invalid-country-code
Status invalid-country-code
HTTP Status Code 400
Description The given country code is not valid. You can find a list of valid country codes in our API docs.
invalid-ip-address
Status invalid-ip-address
HTTP Status Code 400
Description The given ip address is not valid. Please provide either a valid IPv4 or an IPv6 address.
generic-error
Status generic-error
HTTP Status Code 400
Description
invalid-json
Status invalid-json
HTTP Status Code 400
Description
invalid-locale
Status invalid-locale
HTTP Status Code 400
Description The given locale is not valid. You can find a list of valid country codes in our API docs.
invalid-id
Status invalid-id
HTTP Status Code 400
Description The given id is not valid. An id can be either an integer or a string with 50 chars at max.
mandatory-parameter-missing
Status mandatory-parameter-missing
HTTP Status Code 400
Description Mandatory parameter missing. Either first_name, full_name or email must be set.
content-type-missing
Status content-type-missing
HTTP Status Code 400
Description Content-Type missing. Please add a "Content-Type: application/json" to your API call.
missing-json
Status missing-json
HTTP Status Code 400
Description We weren't able to find a json body in your API call. Please make sure the body is sent with a POST request to our API endpoint.
too-many-queries
Status too-many-queries
HTTP Status Code 400
Description Too many queries in a single API call.
authorization-header-missing
Status authorization-header-missing
HTTP Status Code 400
Description Your query misses the "Authorization" header with the bearer token.
invalid-auth-token
Status invalid-auth-token
HTTP Status Code 400
Description Invalid authentication token provided. Please log in to your account to find a list of valid tokens or to create a new one.
email-invalid
Status email-invalid
HTTP Status Code 400
Description Invalid or empty email address given.
password-invalid
Status password-invalid
HTTP Status Code 400
Description Invalid credentials given. Login failed.
label-invalid
Status label-invalid
HTTP Status Code 400
Description Invalid label given. A label must be a string between 2 and 30 chars.
Ce produit comprend des données GeoLite2 créées par MaxMind, disponibles auprès de http://www.maxmind.com.
We use cookies and similar technologies to recognize your repeat visits and preferences, as well as to measure the effectiveness of campaigns and analyze traffic.
You can learn more about which cookies we use or edit them here.
DENY I ACCEPT