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
Este produto inclui dados GeoLite2 criados pela MaxMind, disponíveis em http://www.maxmind.com.
Bate-papo