Obter Gênero por E-mail – Requisição Única
O endpoint Get Gender by Email permite determinar o gênero de uma pessoa analisando seu endereço de e-mail.
Todos os parâmetros são enviados via requisição POST em formato JSON.
É necessário autenticar-se utilizando o método Bearer token no cabeçalho Authorization.
URL da Requisição
POST https://api.genderapi.io/api/email
Cabeçalhos HTTP obrigatórios
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Parâmetros do Body da Requisição
Parâmetro |
Tipo |
Obrigatório |
Descrição |
email |
String |
Sim |
O endereço de e-mail a ser analisado. A API irá extrair o provável primeiro nome antes de determinar o gênero.
|
country |
String |
Não |
Um código de país com duas letras (ISO 3166-1 alpha-2) para melhorar a precisão da predição.
Exemplo: TR para Turquia.
|
askToAI |
Boolean |
Não |
Se definido como true , a API irá pedir para um modelo de IA determinar o gênero caso o nome extraído não seja encontrado no banco de dados.
|
Exemplos de Requisição
Exemplo cURL
curl -X POST "https://api.genderapi.io/api/email" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"email": "michael.smith@example.com", "country": "US", "askToAI": true}'
Exemplo PHP cURL
<?php
$url = "https://api.genderapi.io/api/email";
$data = array(
"email" => "michael.smith@example.com",
"country" => "US",
"askToAI" => true
);
$payload = json_encode($data);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
"Content-Type: application/json",
"Authorization": "Bearer YOUR_API_KEY"
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
Exemplo JavaScript fetch
fetch("https://api.genderapi.io/api/email", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({
email: "michael.smith@example.com",
country: "US",
askToAI: true
})
})
.then(response => response.json())
.then(data => console.log(data));
Exemplo Python requests
import requests
url = "https://api.genderapi.io/api/email"
payload = {
"email": "michael.smith@example.com",
"country": "US",
"askToAI": True
}
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
Exemplo de resposta JSON
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "michael.smith@example.com",
"name": "Michael",
"gender": "male",
"country": "US",
"total_names": 10345,
"probability": 97,
"duration": "5ms"
}
Campos da Resposta
Campo |
Tipo |
Descrição |
status |
Boolean |
Indica se a requisição foi bem-sucedida. |
used_credits |
Integer |
Número de créditos consumidos para esta requisição. |
remaining_credits |
Integer |
Créditos restantes em sua conta após esta requisição. |
expires |
Integer (timestamp) |
Data de expiração do pacote como timestamp UNIX. |
q |
String |
Sua consulta enviada (o e-mail enviado). |
name |
String |
O primeiro nome extraído do e-mail. |
gender |
Enum[String] |
Gênero previsto. Possíveis valores: male , female ou null . |
country |
String |
Código do país considerado na predição. |
total_names |
Integer |
Número de amostras utilizadas para esta predição. |
probability |
Integer |
Percentual de confiança da predição de gênero. |
duration |
String |
Tempo de processamento da requisição (por exemplo, 5ms ). |