Přehled požadavku
Od e-mailové adresy k odhadu
GenderAPI analyzuje lokální část adresy, extrahuje nejpravděpodobnější křestní jméno a použije je k odhadu pohlaví. Pokud znáte region uživatele, přidejte kontext země.
tereza.novakova@example.comTerezafemale · 97%Povinné HTTP hlavičky
Autorizujte požadavek
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYTělo požadavku JSON
Parametry
| Parametr | Typ | Požadavek | Popis |
|---|---|---|---|
email | string | Povinné | E-mailová adresa k analýze. GenderAPI před odhadem extrahuje nejpravděpodobnější křestní jméno. |
country | string | Volitelné | Kód země ISO 3166-1 alpha-2, například CZ nebo US, pro regionální kontext. |
askToAI | boolean | Volitelné | Při hodnotě true použije podporu AI, pokud extrahované jméno nemá výsledek v databázi. |
Parametr askToAI se vyhodnotí po extrakci jména a pouze tehdy, když extrahované jméno není v databázi. E-mailový endpoint nepřijímá parametr forceToGenderize.
Příklady kódu
Odešlete e-mailový požadavek
curl -X POST "https://api.genderapi.io/api/email" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"email":"tereza.novakova@example.com","country":"CZ","askToAI":true}'const response = await fetch("https://api.genderapi.io/api/email", {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
body: JSON.stringify({ email: "tereza.novakova@example.com", country: "CZ", askToAI: true })
});
const data = await response.json();import requests
response = requests.post(
"https://api.genderapi.io/api/email",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"email": "tereza.novakova@example.com", "country": "CZ", "askToAI": True}
)
print(response.json())Odpověď 200
Extrahované jméno a odhad
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "tereza.novakova@example.com",
"name": "Tereza",
"gender": "female",
"country": "CZ",
"total_names": 10345,
"probability": 97,
"duration": "5ms"
}Pole odpovědi
| Pole | Typ | Popis |
|---|---|---|
status | boolean | Určuje, zda byl požadavek úspěšně zpracován. |
used_credits | integer | Počet kreditů spotřebovaných požadavkem. |
remaining_credits | integer | Počet kreditů dostupných po požadavku. |
expires | integer | Čas vypršení balíčku jako časové razítko UNIX. |
q | string | Původní e-mail odeslaný v požadavku. |
name | string | Křestní jméno extrahované z e-mailové adresy. |
gender | string | null | Odhadovaná hodnota: male, female nebo null. |
country | string | Kód země zohledněný při odhadu. |
total_names | integer | Počet vzorků podporujících odhad. |
probability | integer | Míra spolehlivosti odhadu v procentech. |
duration | string | Doba zpracování na serveru. |
Používejte platnou a úplnou e-mailovou adresu
Extrakce jména závisí na struktuře adresy. Obecné schránky, aliasy nebo lokální části bez rozpoznatelného jména nemusí vrátit výsledek. Před použitím odhadu zkontrolujte name, gender aprobability.
Další průvodce