Pobierz płeć na podstawie e-maila – pojedyncze zapytanie
Endpoint Get Gender by Email pozwala określić płeć osoby na podstawie analizy jej adresu e-mail.
Wszystkie parametry są wysyłane jako JSON w żądaniu POST.
Musisz się uwierzytelnić za pomocą metody Bearer token w nagłówku Authorization.
URL żądania
POST https://api.genderapi.io/api/email
Wymagane nagłówki HTTP
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Parametry ciała żądania
Parametr |
Typ |
Wymagane |
Opis |
email |
String |
Tak |
Adres e-mail do analizy. API wyodrębni prawdopodobne imię przed określeniem płci.
|
country |
String |
Nie |
Dwuliterowy kod kraju (ISO 3166-1 alpha-2) dla poprawy dokładności przewidywania.
Przykład: TR dla Turcji.
|
askToAI |
Boolean |
Nie |
Jeśli ustawione na true , API poprosi model AI o określenie płci, jeśli wyodrębnione imię nie zostanie znalezione w bazie danych.
|
Przykłady żądań
Przykład cURL
curl -X POST "https://api.genderapi.io/api/email" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"email": "michael.smith@example.com", "country": "US", "askToAI": true}'
Przykład PHP cURL
<?php
$url = "https://api.genderapi.io/api/email";
$data = array(
"email" => "michael.smith@example.com",
"country" => "US",
"askToAI" => 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;
?>
Przykład JavaScript fetch
fetch("https://api.genderapi.io/api/email", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({
email: "michael.smith@example.com",
country: "US",
askToAI: true
})
})
.then(response => response.json())
.then(data => console.log(data));
Przykład Python requests
import requests
url = "https://api.genderapi.io/api/email"
payload = {
"email": "michael.smith@example.com",
"country": "US",
"askToAI": True
}
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
Przykładowa odpowiedź JSON
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "michael.smith@example.com",
"name": "Michael",
"gender": "male",
"country": "US",
"total_names": 10345,
"probability": 97,
"duration": "5ms"
}
Pola odpowiedzi
Pole |
Typ |
Opis |
status |
Boolean |
Określa, czy żądanie się powiodło. |
used_credits |
Integer |
Liczba kredytów zużytych dla tego żądania. |
remaining_credits |
Integer |
Pozostałe kredyty na Twoim koncie po tym żądaniu. |
expires |
Integer (timestamp) |
Data wygaśnięcia pakietu jako znacznik czasu UNIX. |
q |
String |
Twoje zapytanie wejściowe (wysłany e-mail). |
name |
String |
Wyodrębnione imię z adresu e-mail. |
gender |
Enum[String] |
Przewidziana płeć. Możliwe wartości: male , female lub null . |
country |
String |
Kod kraju użyty do przewidywania. |
total_names |
Integer |
Liczba próbek użytych do tej prognozy. |
probability |
Integer |
Procent pewności prognozy płci. |
duration |
String |
Czas potrzebny do przetworzenia żądania (np. 5ms ). |