Documentación para desarrolladores

Documentación de Gender API

Detecta el género a partir de un nombre, nombre completo, email o nombre de usuario mediante solicitudes REST sencillas y respuestas JSON estructuradas.

REST + JSONSolicitudes GETIndividual y por lotesContexto por país

Uso básico

Haz tu primera solicitud a Gender API

Envía un valor y recibe el género estimado, la probabilidad, el país y la información de consumo. Empieza con un nombre o elige el endpoint específico para email o usuario según tus datos.

Autenticación

Añade tu clave API con el parámetro de consulta key. Guarda las claves de producción en el servidor; no expongas una clave privada en el navegador ni en un repositorio público.

Consultar la guía de autenticación →
Recursos de API legibles por máquina

Utiliza el contrato actual de GenderAPI en formato OpenAPI, Swagger o Postman.

GET

Género por nombre

Nombre o nombre completo

Utiliza el endpoint principal cuando la entrada sea un nombre o un nombre completo.

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

Parámetros opcionales

ParámetroTipoDescripción
countrystringCódigo de país de dos letras, como ES o US.
askToAIbooleanSi es true, recurre al soporte de IA cuando el nombre no aparece en la base de datos.
forceToGenderizebooleanIntenta generar una estimación para entradas poco habituales que podrían no parecer nombres de persona.
Utilízalo con criterio: las estimaciones forzadas para nombres ficticios, alias o entradas con poca señal pueden ser menos precisas.
GET

Género por email

Dirección de email

El endpoint de email extrae primero el nombre probable de la dirección y después realiza la detección de género.

https://api.genderapi.io/api/email
cURL
curl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=ES&askToAI=true&key=YOUR_API_KEY"
forceToGenderize no está disponible en este endpoint porque el nombre se extrae internamente.
GET

Género por usuario

Nombre de usuario o alias

Utiliza este endpoint para nombres de usuario, identificadores y alias que puedan contener un nombre reconocible.

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

Respuesta JSON

Interpreta la respuesta de GenderAPI

Los tres endpoints comparten la misma estructura básica de respuesta.

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

Campos de respuesta

CampoTipoDescripción
statusbooleanIndica si la solicitud se ha completado correctamente.
used_creditsintegerCréditos consumidos por esta solicitud.
remaining_creditsintegerCréditos disponibles después de la solicitud.
expiresintegerFecha de vencimiento del paquete como marca de tiempo UNIX.
qstringNombre, email o nombre de usuario enviado originalmente.
namestringNombre normalizado o extraído de la entrada.
genderstringGénero estimado: male, female o "null".
countrystringCódigo de país ISO 3166-1 alfa-2 más probable.
total_namesintegerNúmero de registros de nombres utilizados en la estimación.
probabilityintegerNivel de confianza de la estimación expresado en porcentaje.
durationstringTiempo de procesamiento de la solicitud en el servidor.

Codifica siempre los valores de entrada en la URL

Tu cliente HTTP debe codificar los espacios y caracteres especiales. Por ejemplo, utiliza sparkling%20unicorn en lugar de incluir un espacio sin codificar.

Sigue desarrollando

Elige la guía adecuada para tu integración

Solicitudes por nombreEjemplos individuales y por lotes →Bibliotecas clienteElige tu lenguaje de programación →Gestión de erroresReferencia de estados y errores →