Obtener género por nombre de usuario - Solicitud única
El endpoint Get Gender by Username te permite determinar el género de una persona
analizando un nombre de usuario o apodo. Todos los parámetros se envían mediante una solicitud POST en formato JSON.
Debes autenticarte utilizando el método de token Bearer en el encabezado Authorization.
URL de solicitud
POST https://api.genderapi.io/api/username
Encabezados HTTP requeridos
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Parámetros en el cuerpo de la solicitud (Request Body)
Parámetro |
Tipo |
Requerido |
Descripción |
username |
String |
Sí |
El nombre de usuario o apodo a analizar. Puede ser un handle de redes sociales, nombre de pantalla o alias.
Puede contener palabras que no sean nombres reales, como términos de fantasía o referencias a marcas.
|
country |
String |
No |
Un código de país de dos letras (ISO 3166-1 alpha-2)
para mejorar la precisión de la predicción. Ejemplo: TR para Turquía.
|
askToAI |
Boolean |
No |
Si se establece en true , la API consultará un modelo de IA para determinar el género
si el nombre extraído no se encuentra en la base de datos.
|
forceToGenderize |
Boolean |
No |
Si se establece en true , la API intentará adivinar un género incluso para nombres de usuario
que no parecen nombres humanos reales, como términos de fantasía o apodos (por ejemplo, sparkling_unicorn ).
|
Ejemplos de solicitudes
Ejemplo con cURL
curl -X POST "https://api.genderapi.io/api/username" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"username": "sparkling_unicorn", "country": "US", "askToAI": true, "forceToGenderize": true}'
Ejemplo con PHP cURL
<?php
$url = "https://api.genderapi.io/api/username";
$data = array(
"username" => "sparkling_unicorn",
"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;
?>
Ejemplo con JavaScript fetch
fetch("https://api.genderapi.io/api/username", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({
username: "sparkling_unicorn",
country: "US",
askToAI: true,
forceToGenderize: true
})
})
.then(response => response.json())
.then(data => console.log(data));
Ejemplo con Python requests
import requests
url = "https://api.genderapi.io/api/username"
payload = {
"username": "sparkling_unicorn",
"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())
Ejemplo de respuesta JSON
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "sparkling_unicorn",
"name": "Sparkling",
"gender": "female",
"country": "US",
"total_names": 9876,
"probability": 92,
"duration": "6ms"
}
Campos en la respuesta
Campo |
Tipo |
Descripción |
status |
Boolean |
Indica si la solicitud fue exitosa. |
used_credits |
Integer |
Número de créditos consumidos en esta solicitud. |
remaining_credits |
Integer |
Créditos restantes en tu cuenta después de esta solicitud. |
expires |
Integer (timestamp) |
Fecha de vencimiento del paquete en formato UNIX timestamp. |
q |
String |
Tu consulta enviada (el username enviado). |
name |
String |
El primer nombre extraído del username. |
gender |
Enum[String] |
Género predicho. Valores posibles: male , female o null . |
country |
String |
Código de país considerado durante la predicción. |
total_names |
Integer |
Cantidad de muestras usadas para esta predicción. |
probability |
Integer |
Porcentaje de confianza en la predicción de género. |
duration |
String |
Tiempo que tomó procesar la solicitud (p. ej. 6ms ). |