Hämta kön via e-post – Enkel förfrågan
Slutpunkten Get Gender by Email låter dig avgöra en persons kön genom att analysera deras e-postadress.
Alla parametrar skickas som JSON i en POST-förfrågan.
Du måste autentisera dig genom att använda Bearer-token-metoden i Authorization-headern.
Begär URL
POST https://api.genderapi.io/api/email
Nödvändiga HTTP-headrar
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Body-parametrar för förfrågan
Parameter |
Typ |
Obligatorisk |
Beskrivning |
email |
String |
Ja |
E-postadressen att analysera. API:n kommer att extrahera det troliga förnamnet innan könet avgörs.
|
country |
String |
Nej |
En tvåbokstavs landskod (ISO 3166-1 alpha-2) för att förbättra noggrannheten i förutsägelsen.
Exempel: TR för Turkiet.
|
askToAI |
Boolean |
Nej |
Om satt till true kommer API:n att fråga en AI-modell om könet om det extraherade namnet inte finns i databasen.
|
Exempel på förfrågningar
cURL-exempel
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}'
PHP cURL-exempel
<?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;
?>
JavaScript fetch-exempel
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));
Python requests-exempel
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())
Exempel på JSON-svar
{
"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"
}
Svarsfält
Fält |
Typ |
Beskrivning |
status |
Boolean |
Anger om förfrågan lyckades. |
used_credits |
Integer |
Antal krediter som förbrukats för denna förfrågan. |
remaining_credits |
Integer |
Kvarvarande krediter på ditt konto efter denna förfrågan. |
expires |
Integer (timestamp) |
Paketets utgångsdatum som UNIX timestamp. |
q |
String |
Ditt inskickade värde (skickad e-postadress). |
name |
String |
Förnamnet som extraherats från e-postadressen. |
gender |
Enum[String] |
Förutspått kön. Möjliga värden: male , female eller null . |
country |
String |
Landskod som användes i förutsägelsen. |
total_names |
Integer |
Antal exempel som använts för denna förutsägelse. |
probability |
Integer |
Procentuell säkerhet för könsförutsägelsen. |
duration |
String |
Tiden det tog att behandla förfrågan (t.ex. 5ms ). |