Przegląd zapytania
Od adresu e-mail do prognozy
GenderAPI analizuje lokalną część adresu, wyodrębnia najbardziej prawdopodobne imię i wykorzystuje je do prognozy płci. Dodaj kontekst kraju, jeśli znasz region użytkownika.
anna.kowalska@example.comAnnafemale · 97%Wymagane nagłówki HTTP
Autoryzuj zapytanie
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYTreść JSON zapytania
Parametry
| Parametr | Typ | Status | Opis |
|---|---|---|---|
email | string | Wymagany | Adres e-mail do analizy. GenderAPI najpierw wyodrębnia najbardziej prawdopodobne imię, a następnie wykonuje prognozę. |
country | string | Opcjonalny | Kod kraju ISO 3166-1 alpha-2, na przykład PL lub US, dodający kontekst regionalny. |
askToAI | boolean | Opcjonalny | Wartość true uruchamia wsparcie AI, jeśli wyodrębnionego imienia nie znaleziono w bazie danych. |
askToAI jest oceniane po wyodrębnieniu imienia i tylko wtedy, gdy imienia nie ma w bazie danych. Endpoint e-mail nie obsługuje forceToGenderize.
Przykłady kodu
Wyślij zapytanie e-mail
curl -X POST "https://api.genderapi.io/api/email" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"email":"anna.kowalska@example.com","country":"PL","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: "anna.kowalska@example.com", country: "PL", 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": "anna.kowalska@example.com", "country": "PL", "askToAI": True}
)
print(response.json())Odpowiedź 200
Wyodrębnione imię i prognoza
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "anna.kowalska@example.com",
"name": "Anna",
"gender": "female",
"country": "PL",
"total_names": 10345,
"probability": 97,
"duration": "5ms"
}Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
status | boolean | Informuje, czy zapytanie zakończyło się powodzeniem. |
used_credits | integer | Liczba kredytów wykorzystanych przez zapytanie. |
remaining_credits | integer | Liczba kredytów dostępnych po zapytaniu. |
expires | integer | Czas wygaśnięcia pakietu jako znacznik UNIX. |
q | string | Oryginalny adres e-mail przesłany w zapytaniu. |
name | string | Imię wyodrębnione z adresu e-mail. |
gender | string | null | Przewidywana wartość: male, female albo null. |
country | string | Kod kraju uwzględniony w prognozie. |
total_names | integer | Liczba próbek wspierających prognozę. |
probability | integer | Poziom pewności prognozy w procentach. |
duration | string | Czas przetwarzania po stronie serwera. |
Użyj pełnego i prawidłowego adresu e-mail
Wyodrębnianie zależy od budowy adresu. Skrzynki ogólne, aliasy i części lokalne bez rozpoznawalnego imienia mogą nie zwrócić wyniku. Przed użyciem prognozy sprawdź name, gender i probability. Zapytania e-mail nie są zapisywane.
Następny przewodnik