Pyynnön yleiskatsaus
Sähköpostiosoitteesta ennusteeksi
GenderAPI analysoi osoitteen paikallisen osan, poimii todennäköisimmän etunimen ja käyttää sitä sukupuoliennusteessa. Lisää maakonteksti, kun käyttäjän alue on tiedossa.
emilia.korhonen@example.comEmiliamale · 97%Pakolliset HTTP-headerit
Valtuuta pyyntö
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYPyynnön JSON-runko
Parametrit
| Parametri | Tyyppi | Vaatimus | Kuvaus |
|---|---|---|---|
email | string | Pakollinen | Analysoitava sähköpostiosoite. GenderAPI poimii todennäköisimmän etunimen ennen ennustetta. |
country | string | Valinnainen | Alueellisen kontekstin antava ISO 3166-1 alpha-2 -maakoodi, esimerkiksi FI tai SE. |
askToAI | boolean | Valinnainen | Kun arvo on true, tekoälyä käytetään varamenetelmänä, jos poimittua nimeä ei löydy tietokannasta. |
askToAI arvioidaan nimen poiminnan jälkeen ja vain, jos poimittua nimeä ei löydy tietokannasta. Sähköpostiendpoint ei tue forceToGenderize.
Koodiesimerkit
Lähetä sähköpostikysely
curl -X POST "https://api.genderapi.io/api/email" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"email":"emilia.korhonen@example.com","country":"FI","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: "emilia.korhonen@example.com", country: "FI", 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": "emilia.korhonen@example.com", "country": "FI", "askToAI": True}
)
print(response.json())200-vastaus
Nimen poiminta og prediksjon
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "emilia.korhonen@example.com",
"name": "Emilia",
"gender": "male",
"country": "FI",
"total_names": 10345,
"probability": 97,
"duration": "5ms"
}Vastauskentät
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status | boolean | Suoritettiinko pyyntö ilman virheitä. |
used_credits | integer | Pyynnön käyttämien krediittien määrä. |
remaining_credits | integer | Pyynnön jälkeen käytettävissä olevien krediittien määrä. |
expires | integer | Paketin vanhenemisaika UNIX-aikaleimana. |
q | string | Lähetetty alkuperäinen sähköpostiosoite. |
name | string | Sähköpostiosoitteesta poimittu etunimi. |
gender | string | null | Ennustettu arvo: male, female tai null. |
country | string | Ennusteessa käytetty maakoodi. |
total_names | integer | Ennustetta tukevien nimiesiintymien määrä. |
probability | integer | Ennusteen luottamus prosentteina. |
duration | string | Palvelimen käsittelyaika. |
Käytä kelvollista ja täydellistä sähköpostiosoitetta
Nimen poiminta riippuu osoitteen rakenteesta. Yleiset postilaatikot, aliakset tai paikalliset osat ilman tunnistettavaa nimeä voivat tuottaa tyhjän tuloksen. Tarkista name, gender ja probability ennen ennusteen käyttöä. Sähköpostikyselyjä ei tallenneta.
Seuraava opas