Documentação da API Unified API v2.0

API v1.0

Nós também oferecemos outra versão de API com pontos de extremidade que são mais fáceis de integrar. Se você é um iniciante na implementação de APIs, pode mudar para o nosso ponto de extremidade v1.0.
Ver API v1.0

OpenAPI

Veja nossa documentação da API no Swagger

Postman

Importe nossa definição de API para o Postman
Consultar por primeiro nome
Consulta por Nome Completo
Consulta por endereço de e-mail
Obter País de Origem
Obter Estatísticas
Códigos de erro

Consulta por primeiro nome

Esta é a maneira mais fácil de consultar o gênero de um nome. Cada resposta é codificada em JSON:

Post
Solicitações necessárias: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <o seu token de autorização>
link
JSON Payload
Campo Tipo Publicação Descrição
first_name string Sim Nome a ser consultado
country string Não Código do país em conformidade com o ISO 3166 ALPHA-2
link
locale string Não Localidade do navegador
ip string Não Endereço IPv4 ou IPv6 válido
id string Não Máximo de 50 caracteres. Você pode definir este ID com qualquer valor alfanumérico que desejar. Como exemplo, você pode definir o ID como seu ID interno do conjunto de dados em seu banco de dados. Em um ambiente assíncrono, isso pode ajudá-lo a conectar a resposta a uma solicitação anterior

Exemplos

Consulta por somente o primeiro nome
play_arrow Teste ao vivo com codepen.io 
{"first_name":"Sandra"}
Consulta por primeiro nome e código do país
play_arrow Teste ao vivo com codepen.io 
{"first_name":"Sandra","country":"US"}
Consulta por primeiro nome e localidade do navegador
play_arrow Teste ao vivo com codepen.io 
{"first_name":"Sandra","locale":"en_US"}
Consulta por primeiro nome e usa um endereço de IP para localização
play_arrow Teste ao vivo com codepen.io 
{"first_name":"Sandra","ip":"54.201.16.177"}
Consulte vários nomes em uma única solicitação
play_arrow Teste ao vivo com codepen.io 
[{"first_name":"Sandra","country":"US"},{"first_name":"Jason","country":"US"}]
Resposta
{
    "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"
}
Campo Tipo Descrição
input object Carga útil submetida
details.credits_used int A quantidade de solicitações usadas para esta consulta
details.samples int Número de registros encontrados em nosso banco de dados correspondentes à sua solicitação
details.country string O país que encontramos
details.first_name_sanitized string O nome depois de aplicarmos nosso normalizador
details.duration string Tempo que o servidor precisou para processar a solicitação
result_found bool Verdadeiro se pudermos consultar um gênero para o nome dado
first_name string O primeiro nome que usamos para determinação de gênero
probability float Esse valor (entre 0 e 1) determina a confiabilidade do nosso banco de dados. Um valor de 1 significa que os resultados de sua solicitação de gênero são 100% precisos.
gender string Possíveis valores: masculino, feminino, desconhecido

Consulta por nome completo - DIVIDIR NOME E SOBRENOME

Se você usar um campo combinado para nome e sobrenome em sua página, use esta API para extrair as partes:

Post
Solicitações necessárias: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <o seu token de autorização>
link
JSON Payload
Campo Tipo Publicação Descrição
full_name string Sim Nome a ser consultado
country string Não Código do país em conformidade com o ISO 3166 ALPHA-2
link
locale string Não Localidade do navegador
ip string Não Endereço IPv4 ou IPv6 válido
id string Não Máximo de 50 caracteres. Você pode definir este ID com qualquer valor alfanumérico que desejar. Como exemplo, você pode definir o ID como seu ID interno do conjunto de dados em seu banco de dados. Em um ambiente assíncrono, isso pode ajudá-lo a conectar a resposta a uma solicitação anterior

Exemplos

Consulta somente por nome completo
play_arrow Teste ao vivo com codepen.io 
{"full_name":"Theresa Miller"}
Consulta por nome completo e código do país
play_arrow Teste ao vivo com codepen.io 
{"full_name":"Theresa Miller","country":"US"}
Consulta por nome completo e localidade do navegador
play_arrow Teste ao vivo com codepen.io 
{"full_name":"Thomas Johnson","locale":"en_US"}
Consulta por nome completo e usa um endereço IP para localização
play_arrow Teste ao vivo com codepen.io 
{"full_name":"Markus Stefan NonExistingLastName","ip":"54.201.16.177"}
Consulte vários nomes em uma única solicitação
play_arrow Teste ao vivo com codepen.io 
[{"full_name":"Theresa Miller"},{"full_name":"Thomas Johnson","country":"US"}]
Resposta
{
    "input": {
        "full_name": "Theresa Miller"
    },
    "details": {
    "credits_used": 1,
        "duration": "33ms",
        "samples": 8961,
        "country": null,
        "first_name_sanitized": "theresa"
    },
    "result_found": true,
    "last_name": "Miller",
    "first_name": "Theresa",
    "probability": 0.98,
    "gender": "female"
}
Campo Tipo Descrição
input object Carga útil submetida
details.credits_used int A quantidade de solicitações usadas para esta consulta
details.samples int Número de registros encontrados em nosso banco de dados correspondentes à sua solicitação
details.country string O país que encontramos
details.full_name_sanitized int O nome depois de aplicarmos nosso normalizador
details.duration string Tempo que o servidor precisou para processar a solicitação
result_found bool Verdadeiro se pudermos consultar um gênero para o nome dado
full_name string O nome completo que usamos para a determinação do gênero
probability float Esse valor (entre 0 e 1) determina a confiabilidade do nosso banco de dados. Um valor de 1 significa que os resultados de sua solicitação de gênero são 100% precisos.
gender string Possíveis valores: masculino, feminino, desconhecido

Consulta por endereço de e-mail

Também é possível consultar o gênero usando um endereço de e-mail contendo um endereço de e-mail:

Post
Solicitações necessárias: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <o seu token de autorização>
link
JSON Payload
Campo Tipo Publicação Descrição
email string Sim Endereço de email para consulta
country string Não Código do país em conformidade com o ISO 3166 ALPHA-2
link
locale string Não Localidade do navegador
ip string Não Endereço IPv4 ou IPv6 válido
id string Não Máximo de 50 caracteres. Você pode definir este ID com qualquer valor alfanumérico que desejar. Como exemplo, você pode definir o ID como seu ID interno do conjunto de dados em seu banco de dados. Em um ambiente assíncrono, isso pode ajudá-lo a conectar a resposta a uma solicitação anterior

Exemplos

Consulta apenas por endereço de email
play_arrow Teste ao vivo com codepen.io 
{"email":"theresa.miller14@gmail.com"}
Consulta por endereço de email e código do país
play_arrow Teste ao vivo com codepen.io 
{"email":"thomas.clarks@hotmail.com","country":"US"}
Consulta por endereço de email e localidade do navegador
play_arrow Teste ao vivo com codepen.io 
{"email":"Thomas.j32@live.com","locale":"en_US"}
Consulta por endereço de email e uso de um endereço IP para localização
play_arrow Teste ao vivo com codepen.io 
{"email":"thomasfromnewyork@gmail.com","ip":"54.201.16.177"}
Consulte vários nomes em uma única solicitação
play_arrow Teste ao vivo com codepen.io 
[{"email":"thomas.clarks@hotmail.com","country":"US"},{"email":"theresa.miller14@gmail.com"}]
Resposta
{
    "input": {
        "email": "theresa.miller14@gmail.com"
    },
    "details": {
        "credits_used": 1,
        "duration": "12ms",
        "samples": 8961,
        "country": null,
        "first_name_sanitized": "theresa"
    },
    "result_found": true,
    "last_name": "Miller",
    "first_name": "Theresa",
    "probability": 0.98,
    "gender": "female"
}
Campo Tipo Descrição
input object Carga útil submetida
details.credits_used int A quantidade de solicitações usadas para esta consulta
details.samples int Número de registros encontrados em nosso banco de dados correspondentes à sua solicitação
details.country string O país que encontramos
details.email_sanitized int O nome depois de aplicarmos nosso normalizador
details.duration string Tempo que o servidor precisou para processar a solicitação
result_found bool Verdadeiro se pudermos consultar um gênero para o nome dado
email string O endereço de e-mail que utilizamos para a atribuição de gênero
probability float Esse valor (entre 0 e 1) determina a confiabilidade do nosso banco de dados. Um valor de 1 significa que os resultados de sua solicitação de gênero são 100% precisos.
gender string Possíveis valores: masculino, feminino, desconhecido

Obter País de Origem

Obter o país de origem de um nome:

Post
Solicitações necessárias: 2
URL
https://gender-api.com/v2/country-of-origin
Headers
Content-Type: application/json
Authorization: Bearer <o seu token de autorização>
link
JSON Payload
Campo Tipo Publicação Descrição
first_name string Sim Primeiro nome a pesquisar
full_name string Não Nome completo a pesquisar. Pode ser fornecido em vez do campo primeiro_nome
email string Não Endereço de e-mail a pesquisar. Pode ser fornecido em vez do campo primeiro_nome
id string Não Máximo de 50 caracteres. Você pode definir este ID com qualquer valor alfanumérico que desejar. Como exemplo, você pode definir o ID como seu ID interno do conjunto de dados em seu banco de dados. Em um ambiente assíncrono, isso pode ajudá-lo a conectar a resposta a uma solicitação anterior

Exemplos

Consulta por primeiro nome
play_arrow Teste ao vivo com codepen.io 
{"first_name":"Johann"}
Consulta por nome completo
play_arrow Teste ao vivo com codepen.io 
{"full_name":"Theresa Miller"}
Consulta por endereço de e-mail
play_arrow Teste ao vivo com codepen.io 
{"full_name":"sophia5342@gmail.com"}
Resposta
{
    "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",
    "language_of_origin": "Germanic",
    "meaning": "Johann is the German variation of the name John, which means 'God is gracious'. It was frequently used in the Middle Ages across Europe, particularly as a name for religious figures.",
    "ethnicity": {
        "id": "GERMANIC",
        "name": "Germanic (German, Austrian, Swiss)",
        "distribution": [
            {
                "id": "GERMANIC",
                "name": "Germanic (German, Austrian, Swiss)",
                "percentage": 90
            },
            {
                "id": "DUTCH",
                "name": "Dutch",
                "percentage": 5
            },
            {
                "id": "FRENCH",
                "name": "French",
                "percentage": 5
            }
        ]
    }
 }
Campo Tipo Descrição
input object Carga útil submetida
details.credits_used int A quantidade de solicitações usadas para esta consulta
details.samples int Número de registros encontrados em nosso banco de dados correspondentes à sua solicitação
details.country string O país que encontramos
details.first_name_sanitized string O nome depois de aplicarmos nosso normalizador
details.duration string Tempo que o servidor precisou para processar a solicitação
result_found bool Verdadeiro se pudermos consultar um gênero para o nome dado
country_of_origin_map_url string URL para um mapa interativo sobre este nome
first_name string O primeiro nome que usamos para determinação de gênero
probability float Este valor (entre 0 e 1) determina a confiabilidade do nosso banco de dados. Um valor de 1 significa que os resultados da sua solicitação de gênero são 100% precisos
gender string Possíveis valores: masculino, feminino, desconhecido
country_of_origin object Principais 25 países de origem. Veja "Lista Completa dos Possíveis Países" para uma lista dos países suportados. Cada registro contém os campos country_name, country, probability, continental_region e statistical_region
language_of_origin string O idioma de origem desse nome
meaning string Uma breve descrição do significado desse nome
ethnicity object O campo de etnia fornece detalhes sobre o principal grupo étnico associado ao nome, assim como a distribuição do nome entre vários grupos étnicos
ethnicity.id string O campo id contém um identificador para o principal grupo étnico determinado. Veja "Lista Completa de Possíveis Grupos Étnicos" para uma lista completa de possíveis grupos étnicos
ethnicity.name string O campo de nome contém o nome do grupo étnico principal determinado. Veja "Lista Completa De Possíveis Grupos Étnicos" para uma lista completa de possíveis grupos étnicos
ethnicity.distribution array O campo Distribution contém informações sobre a proporção do nome dentro de diferentes grupos étnicos. Cada entrada de array contém os campos id (string), name (string) e percentage (float). Veja "Lista Completa De Possíveis Grupos Étnicos" para uma lista completa de valores possíveis
Captura de tela do Mapa Interativo
Lista completa de possíveis países
Código do país Nome do país Região estatística Região continental
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
Lista Completa De Possíveis Grupos Étnicos
ID Nome
GERMANIC Germanic (German, Austrian, Swiss)
SCANDINAVIAN Scandinavian (Swedish, Norwegian, Danish, Finnish)
ENGLISH English
DUTCH Dutch
HUNGARIAN Hungarian
ESTONIAN Estonian
LATVIAN Latvian
LITHUANIAN Lithuanian
SLOVENIAN Slovenian
CROATIAN Croatian
SERBIAN Serbian
BOSNIAN Bosnian
MACEDONIAN Macedonian
BULGARIAN Bulgarian
ROMANIAN Romanian
POLISH Polish
SLOVAK Slovak
CZECH Czech
RUSSIAN Russian
UKRAINIAN Ukrainian
BELARUSIAN Belarusian
ICELANDIC Icelandic
FAROESE Faroese
SCOTTISH Scottish
IRISH Irish
WELSH Welsh
ITALIAN Italian
SPANISH Spanish
PORTUGUESE Portuguese
FRENCH French
GREEK Greek
TURKISH Turkish
ARMENIAN Armenian
GEORGIAN Georgian
ALBANIAN Albanian
KURDISH Kurdish
PERSIAN Persian
ARAB Arab (Various Arabic-speaking countries)
HEBREW Hebrew
INDIAN Indian
PAKISTANI Pakistani
BANGLADESHI Bangladeshi
SRI_LANKAN Sri Lankan
NEPALI Nepali
BHUTANESE Bhutanese
TIBETAN Tibetan
CHINESE Chinese
JAPANESE Japanese
KOREAN Korean
VIETNAMESE Vietnamese
THAI Thai
MALAYSIAN Malaysian
INDONESIAN Indonesian
FILIPINO Filipino
AUSTRALIAN_ABORIGINAL Australian Aboriginal
MAORI Maori (New Zealand)
NATIVE_AMERICAN Native American (various tribes in North and South America)
INUIT Inuit (Arctic regions)
AFRICAN African ethnic groups (various countries and tribes)
PACIFIC_ISLANDER Pacific Islander (various islands and cultures)

Obter Estatísticas

Com esta chamada você pode obter algumas estatísticas da sua conta:

Obter/pegar/conseguir/obtenha
URL
https://gender-api.com/v2/statistic
Headers
Content-Type: application/json
Authorization: Bearer <o seu token de autorização>
link
Resposta
{
    "is_limit_reached": false,
    "remaining_credits": 24999,
    "details": {
        "credits_used": 0,
        "duration": "83ms"
    },
    "usage_last_month": {
        "date": "2018-03",
        "credits_used": 25
    }
}
Campo Tipo Descrição
is_limit_reached bool Retorna verdadeiro se não houver mais solicitações permitidas
remaining_credits int Número de solicitações restantes
details.credits_used int A quantidade de solicitações usadas para esta consulta
details.duration string Tempo que o servidor precisou para processar a solicitação
usage_last_month.date string Data do último mês
usage_last_month.credits_used int Solicitações que você usou no último mês

Códigos de erro

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 requests.
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 1 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.
too-many-queries-api-key
Status too-many-queries-api-key
HTTP Status Code 400
Description Too many queries in a single API call. Your API key is limited to 3 lookups per request.
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. Login failed. Please also check your account that third-party app access is not restricted.: https://gender-api.com/de/account/password
label-invalid
Status label-invalid
HTTP Status Code 400
Description Invalid label given. A label must be a string between 2 and 30 chars.
email-account-not-found
Status email-account-not-found
HTTP Status Code 400
Description No Gender-API.com account found. Please create a free account first, to sign-in with Google or try to login with an existing username or password.
invalid-list-of-names
Status invalid-list-of-names
HTTP Status Code 400
Description Invalid list of names. Expected array of strings.
Este produto inclui dados GeoLite2 criados pela MaxMind, disponíveis em http://www.maxmind.com.
Bate-papo