Oversikt over forespørselen
Fra e-postadresse til prediksjon
GenderAPI analyserer den lokale delen av adressen, henter ut det mest sannsynlige fornavnet og bruker navnet i kjønnsprediksjonen. Legg til landkontekst når du kjenner brukerens region.
michael.smith@example.comMichaelmale · 97%Påkrevde HTTP-headere
Autoriser forespørselen
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYJSON-body for forespørselen
Parametere
| Parameter | Type | Krav | Beskrivelse |
|---|---|---|---|
email | string | Påkrevd | E-postadressen som skal analyseres. GenderAPI henter ut det mest sannsynlige fornavnet før prediksjonen. |
country | string | Valgfri | ISO 3166-1 alfa-2-landkode, for eksempel NO eller SE, som gir regional kontekst. |
askToAI | boolean | Valgfri | Når verdien er true, brukes KI som reserve hvis navnet som ble hentet ut, ikke finnes i databasen. |
askToAI vurderes etter navneuttrekket og bare når navnet som ble hentet ut, ikke finnes i databasen. E-postendepunktet støtter ikke forceToGenderize.
Kodeeksempler
Send en e-postforespørsel
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}'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: "michael.smith@example.com", country: "US", 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": "michael.smith@example.com", "country": "US", "askToAI": True}
)
print(response.json())200-svar
Navneuttrekk og prediksjon
{
"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"
}Svarfelt
| Felt | Type | Beskrivelse |
|---|---|---|
status | boolean | Om forespørselen ble fullført uten feil. |
used_credits | integer | Antall kreditter som forespørselen brukte. |
remaining_credits | integer | Antall kreditter som er tilgjengelige etter forespørselen. |
expires | integer | Pakkens utløpstid som UNIX-tidsstempel. |
q | string | Den opprinnelige e-postadressen som ble sendt inn. |
name | string | Fornavnet som ble hentet ut fra e-postadressen. |
gender | string | null | Predikert verdi: male, female eller null. |
country | string | Landkoden som ble brukt i prediksjonen. |
total_names | integer | Antall navneforekomster som støtter prediksjonen. |
probability | integer | Prediksjonens konfidens uttrykt i prosent. |
duration | string | Serverens behandlingstid. |
Bruk en gyldig og fullstendig e-postadresse
Navneuttrekket avhenger av adressestrukturen. Generelle innbokser, aliaser eller lokale deler uten gjenkjennelige navn kan gi tomt resultat. Kontroller name, gender og probability før du bruker en prediksjon. E-postforespørsler lagres ikke.
Neste veiledning