Základní použití

GenderAPI vám umožňuje určit pohlaví osoby na základě různých typů vstupních dat. Můžete analyzovat křestní jména přímo, nebo extrahovat jména z e-mailových adres a uživatelských jmen. Zde je, jak můžete začít:

1. Pohlaví podle jména

Pošlete křestní jméno na následující endpoint: 

https://api.genderapi.io/api

Příklad: 

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

Můžete také přidat volitelné parametry:

  • country: Zadejte dvoupísmenný kód země ( ISO 3166-1 alpha-2 ) pro zvýšení přesnosti předpovědi. Například: country=TR pro Turecko.
  • askToAI: Pokud nastavíte na true, API požádá AI model o určení pohlaví v případě, že jméno nebylo nalezeno v databázi.
  • forceToGenderize: Pokud nastavíte na true, API se pokusí určit pohlaví i pro vstupy, které nevypadají jako reálná lidská jména, např. přezdívky nebo fantazijní jména jako sparkling unicorn nebo mystic warrior. To může být užitečné při analýze uživatelských jmen, ale výsledky nemusí být tak přesné. Poznámka: Tento parametr není dostupný u endpointu pro e-mail.

Příklad s parametry: 

curl "https://api.genderapi.io/api?name=sparkling%20unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

2. Pohlaví podle e-mailové adresy

Tento endpoint použijte, pokud máte pouze e-mailovou adresu: 

https://api.genderapi.io/api/email

Příklad: 

curl "https://api.genderapi.io/api/email?email=alice.smith@example.com&country=TR&askToAI=true&key=YOUR_API_KEY"

Poznámka: Parametr forceToGenderize není pro endpoint e-mailu dostupný, protože tento endpoint nejdříve interně extrahuje jméno.


3. Pohlaví podle uživatelského jména

Pro uživatelská jména nebo přezdívky použijte: 

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

Příklad: 

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

Parametr forceToGenderize je zde obzvláště užitečný, protože uživatelská jména často obsahují slova nebo pojmy, které nejsou klasickými jmény. Tento parametr nutí API pokusit se určit pohlaví i v případě netypického vstupu.

Všechny metody podporují jednoduché i hromadné požadavky. Pro více informací navštivte konkrétní sekce v levém menu.


✅ Odpověď API

Příklad JSON odpovědi pro všechny endpointy: 

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "michael.smith@example.com",
  "name": "Michael",
  "gender": "male",
  "country": "US",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

Pole odpovědi

Pole Typ Popis
status Boolean true, pokud byl požadavek úspěšný. Pokud false, zkontrolujte chyby.
used_credits Integer Počet kreditů použitých pro tento požadavek.
remaining_credits Integer Zbývající kredity na vašem účtu po tomto požadavku.
expires Integer (timestamp) Datum vypršení balíčku jako UNIX timestamp (sekundy).
q String Váš vstupní dotaz (jméno, e-mail nebo uživatelské jméno).
name String Nalezené nebo extrahované křestní jméno.
gender Enum[String] Předpovězené pohlaví. Možné hodnoty: male, female, nebo null.
country Enum[String] Nejpravděpodobnější kód země (např. US, DE).
total_names Integer Počet vzorků použitých pro predikci.
probability Integer Pravděpodobnost v procentech pro predikci pohlaví (např. 50-100).
duration String Doba zpracování požadavku (např. 4ms).
Upozornění: Pokud vaše vstupní hodnoty obsahují mezery nebo speciální znaky (např. sparkling unicorn), vždy je před odesláním GET požadavku správně URL-enkódujte. Jinak může požadavek selhat nebo mohou být ostatní parametry chybně interpretovány vaším programovacím jazykem nebo HTTP knihovnou. 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
měli byste použít: 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
Nebo použijte vhodnou funkci pro URL-enkódování ve svém programovacím jazyce.