Zjištění pohlaví podle uživatelského jména – Jednotlivý požadavek

Endpoint pro zjištění pohlaví podle uživatelského jména umožňuje určit pohlaví osoby na základě uživatelského jména nebo přezdívky. Všechny parametry musí být odeslány jako POST požadavek ve formátu JSON. Požadavek musíte ověřit pomocí Bearer tokenu v hlavičce Authorization.

URL požadavku

POST https://api.genderapi.io/api/username

Povinné HTTP hlavičky

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Parametry těla požadavku

Parametr	Typ	Povinné	Popis
username	Řetězec	Ano	Uživatelské jméno nebo přezdívka k analýze. Může to být handle ze sociálních sítí, zobrazované jméno nebo alias. Může obsahovat i nesmyslná slova, fantasy výrazy nebo značky.
country	Řetězec	Ne	Dvoupísmenný kód země pro zvýšení přesnosti predikce (ISO 3166-1 alpha-2). Například použijte `TR` pro Turecko.
askToAI	Boolean	Ne	Pokud nastavíte na `true`, API požádá AI model o určení pohlaví v případě, že jméno není nalezeno v databázi.
forceToGenderize	Boolean	Ne	Pokud nastavíte na `true`, API se pokusí určit pohlaví i u uživatelských jmen, která se nepodobají skutečným lidským jménům (například fantasy výrazy nebo přezdívky jako `sparkling_unicorn`).

Příklady požadavků

Příklad 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}'

Příklad 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;
?>

Příklad 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));

Příklad 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())

Příklad JSON odpovědi

{
  "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"
}

Pole odpovědi

Pole	Typ	Popis
status	Boolean	Označuje, zda byl požadavek úspěšný.
used_credits	Integer	Počet kreditů použitých pro tento požadavek.
remaining_credits	Integer	Počet zbývajících kreditů na vašem účtu po tomto požadavku.
expires	Integer (timestamp)	Datum expirace vašeho plánu jako UNIX timestamp.
q	Řetězec	Vámi zadaný dotaz (uživatelské jméno).
name	Řetězec	Jméno extrahované z uživatelského jména.
gender	Enum[String]	Předpokládané pohlaví. Možné hodnoty: `male`, `female` nebo `null`.
country	Řetězec	Kód země použitý při predikci.
total_names	Integer	Počet vzorků jmen použitých pro tuto predikci.
probability	Integer	Skóre důvěry v predikci pohlaví (v procentech).
duration	Řetězec	Doba zpracování požadavku (např. `6ms`).