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.

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
{"email":"theresa.miller14@gmail.com"}
Consulta por endereço de email e código do país
{"email":"thomas.clarks@hotmail.com","country":"US"}
Consulta por endereço de email e localidade do navegador
{"email":"Thomas.j32@live.com","locale":"en_US"}
Consulta por endereço de email e uso de um endereço IP para localização
{"email":"thomasfromnewyork@gmail.com","ip":"54.201.16.177"}
Consulte vários nomes em uma única solicitação
[{"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
Este produto inclui dados GeoLite2 criados pela MaxMind, disponíveis em http://www.maxmind.com.
Bate-papo