Gender API
Alterar idioma22
EntrarComeçar grátis
Menu

Documentação para desenvolvedores

Documentação da Gender API

Identifique gênero por primeiro nome, nome completo, endereço de e-mail ou username com solicitações REST simples e respostas JSON estruturadas.

REST + JSONSolicitações GETIndividual e em loteContexto de país

Uso básico

Faça sua primeira solicitação à Gender API

Envie um valor e receba o gênero estimado, a probabilidade, o país e as informações de consumo. Comece com um nome e use o endpoint específico de e-mail ou username quando esse for o dado disponível.

Autenticação

Adicione sua chave de API pelo parâmetro de consulta key. Mantenha as chaves de produção no servidor; nunca exponha uma chave privada no código do navegador ou em um repositório público.

Leia o guia de autenticação →
Recursos de API legíveis por máquina

Use o contrato atual da GenderAPI no formato OpenAPI, Swagger ou Postman.

OpenAPI JSONOpenAPI YAMLAbrir a referência interativa do Swagger →Baixar a coleção do Postman →
GET

Gênero pelo nome

Primeiro nome ou nome completo

Use o endpoint base quando a entrada for um primeiro nome ou nome completo.

https://api.genderapi.io/api
cURL
curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

Parâmetros opcionais

ParâmetroTipoDescrição
countrystringCódigo de país de duas letras, como BR ou US.
askToAIbooleanQuando definido como true, aciona a IA como alternativa se o nome não for encontrado no banco de dados.
forceToGenderizebooleanTenta gerar uma estimativa para entradas incomuns que podem não parecer nomes de pessoas.
Use com cuidado: estimativas forçadas para nomes fictícios, apelidos ou entradas com pouco sinal podem ser menos precisas.
GET

Gênero pelo e-mail

Endereço de e-mail

O endpoint de e-mail extrai um nome provável do endereço antes de realizar a identificação de gênero.

https://api.genderapi.io/api/email
cURL
curl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=BR&askToAI=true&key=YOUR_API_KEY"
forceToGenderize não está disponível neste endpoint porque o nome é extraído internamente.
GET

Gênero pelo username

Username em rede social

Use este endpoint para usernames, identificadores e apelidos que possam conter um nome reconhecível.

https://api.genderapi.io/api/username
cURL
curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

Resposta JSON

Entenda a resposta da GenderAPI

Os três endpoints usam a mesma estrutura principal de resposta.

200 OK
{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "Alice",
  "name": "alice",
  "gender": "female",
  "country": "US",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

Campos da resposta

CampoTipoDescrição
statusbooleanIndica se a solicitação foi concluída com sucesso.
used_creditsintegerCréditos consumidos por esta solicitação.
remaining_creditsintegerCréditos restantes após a solicitação.
expiresintegerData de expiração do pacote em formato de timestamp UNIX.
qstringA consulta original de nome, e-mail ou username.
namestringO primeiro nome normalizado ou extraído.
genderstringGênero estimado: male, female ou "null".
countrystringCódigo de país ISO 3166-1 alfa-2 mais provável.
total_namesintegerQuantidade de registros de nomes usados na estimativa.
probabilityintegerProbabilidade da estimativa em porcentagem.
durationstringTempo de processamento da solicitação no servidor.

Sempre codifique os valores de entrada para URL

Espaços e caracteres especiais devem ser codificados pelo seu cliente HTTP. Por exemplo, use sparkling%20unicorn em vez de um espaço sem codificação.

Continue a integração

Escolha o guia para seu fluxo de trabalho

Solicitações por nomeExemplos individuais e em lote →Bibliotecas clienteUse sua linguagem preferida →Tratamento de errosReferência de status e erros →