Obter Gênero por Nome – Solicitação Única
O endpoint Obter Gênero por Nome permite determinar o gênero de um único primeiro nome. Todos os parâmetros são enviados em uma solicitação POST como JSON. Você deve autenticar usando o método Bearer token no cabeçalho Authorization.
URL da Solicitação
POST https://api.genderapi.io/api
Cabeçalhos HTTP Obrigatórios
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Parâmetros do Corpo da Solicitação
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
name | String | Sim | O primeiro nome que você deseja analisar. Deve ser uma única palavra, sem títulos ou prefixos adicionais. |
country | String | Não |
Um código de país de duas letras (ISO 3166-1 alpha-2) para melhorar a precisão da previsão.
Exemplo: TR para Turquia.
|
askToAI | Boolean | Não |
Se definido como true , a API consultará um modelo de IA caso o nome não seja encontrado no banco de dados.
|
forceToGenderize | Boolean | Não |
Se definido como true , a API tentará adivinhar o gênero mesmo para entradas que não sejam nomes típicos de pessoas,
como apelidos ou termos fantasiosos (ex: sparkling unicorn ).
|
Exemplos de Solicitação
Exemplo cURL
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name": "Alice", "country": "US", "askToAI": true, "forceToGenderize": true}'
Exemplo PHP cURL
<?php
$url = "https://api.genderapi.io/api";
$data = array(
"name" => "Alice",
"country" => "US",
"askToAI" => true,
"forceToGenderize" => 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", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({
name: "Alice",
country: "US",
askToAI: true,
forceToGenderize: true
})
})
.then(response => response.json())
.then(data => console.log(data));
Exemplo Python requests
import requests
url = "https://api.genderapi.io/api"
payload = {
"name": "Alice",
"country": "US",
"askToAI": True,
"forceToGenderize": 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": "Alice",
"name": "Alice",
"gender": "female",
"country": "US",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}
Campos da Resposta
Campo | Tipo | Descrição |
---|---|---|
status | Boolean | Indica se a solicitação foi bem-sucedida. |
used_credits | Integer | Número de créditos utilizados nesta solicitação. |
remaining_credits | Integer | Créditos restantes em sua conta após esta solicitação. |
expires | Integer (timestamp) | Data de expiração do pacote como um timestamp UNIX. |
q | String | Sua consulta de entrada (o nome enviado). |
name | String | O nome analisado ou extraído. |
gender | Enum[String] | Gênero previsto. Valores possíveis: male , female ou null . |
country | String | Código do país considerado durante a previsão. |
total_names | Integer | Número de amostras utilizadas nesta previsão. |
probability | Integer | Porcentagem de confiança para a previsão de gênero. |
duration | String | Tempo de processamento da solicitação (ex: 4ms ). |
Aviso:
Sempre garanta que valores de entrada como nomes não contenham caracteres inesperados.
Se você planeja usar caracteres especiais ou espaços, utilize o encoding JSON correto para evitar erros.