Peruskäyttö

GenderAPI:n avulla voit tunnistaa henkilön sukupuolen erilaisilla syötteillä. Voit analysoida etunimiä suoraan tai poimia nimet sähköpostiosoitteista ja käyttäjätunnuksista. Näin pääset alkuun:

1. Sukupuoli nimestä

Lähetä etunimi seuraavaan päätepisteeseen: 

https://api.genderapi.io/api

Esimerkki: 

curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

Voit lisätä myös valinnaisia parametreja:

  • country: Anna kaksikirjaiminen maakoodi ( ISO 3166-1 alpha-2 ) parantaaksesi ennusteen tarkkuutta. Esim: country=TR Turkille.
  • askToAI: Jos asetettu true, API kysyy tekoälyltä sukupuolen, kun nimeä ei löydy tietokannasta.
  • forceToGenderize: Jos asetettu true, API yrittää arvata sukupuolen myös sellaisille syötteille, jotka eivät näytä oikeilta nimiltä, kuten lempinimet tai fantasianimet, esim. sparkling unicorn tai mystic warrior. Tämä voi olla hyödyllistä käyttäjätunnusten analysoinnissa, mutta tulokset voivat olla vähemmän tarkkoja. Huom: Tätä parametria ei ole saatavilla sähköpostipäätepisteessä.

Esimerkki parametreilla: 

curl "https://api.genderapi.io/api?name=sparkling%20unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

2. Sukupuoli sähköpostiosoitteesta

Käytä tätä päätepistettä, jos sinulla on vain sähköpostiosoite: 

https://api.genderapi.io/api/email

Esimerkki: 

curl "https://api.genderapi.io/api/email?email=alice.smith@example.com&country=TR&askToAI=true&key=YOUR_API_KEY"

Huom: forceToGenderize ei ole käytettävissä sähköpostipäätepisteessä, koska tämä päätepiste poimii nimen automaattisesti.


3. Sukupuoli käyttäjätunnuksesta

Käyttäjätunnuksille tai lempinimille käytä: 

https://api.genderapi.io/api/username

Esimerkki: 

curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

forceToGenderize-parametri on erityisen hyödyllinen täällä, koska käyttäjätunnukset sisältävät usein muita kuin nimiä tai fantasiatermejä. Se pakottaa API:n yrittämään sukupuolen ennustusta, vaikka syöte ei olisi tyypillinen ihmisen nimi.

Kaikki menetelmät tukevat yksittäisiä ja massapyyntöjä. Lisätietoja löydät vasemmasta navigaatiovalikosta.


✅ API-vastaus

Esimerkki JSON-vastauksesta kaikille päätepisteille: 

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "michael.smith@example.com",
  "name": "Michael",
  "gender": "male",
  "country": "US",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

Vastauskentät

Kenttä Tyyppi Kuvaus
status Boolean true, jos pyyntö onnistui. Tarkista virheet, jos false.
used_credits Integer Tämän pyynnön käytettyjen krediittien määrä.
remaining_credits Integer Tämän pyynnön jälkeen tililläsi jäljellä olevat krediitit.
expires Integer (timestamp) Paketin voimassaolon päättymispäivä UNIX-aikaleimana (sekuntia).
q String Syötekyselysi (nimi, sähköposti tai käyttäjätunnus).
name String Löydetty tai poimittu etunimi.
gender Enum[String] Ennustettu sukupuoli. Mahdolliset arvot: male, female tai null.
country Enum[String] Todennäköisin maakoodi (esim. US, DE).
total_names Integer Ennusteen taustalla käytettyjen näytteiden määrä.
probability Integer Sukupuoliennusteen todennäköisyysprosentti (esim. 50-100).
duration String Pyynnön käsittelyaika (esim. 4ms).
Varoitus: Jos syötteesi sisältää välilyöntejä tai erikoismerkkejä (esim. sparkling unicorn), muista aina URL-koodata ne ennen GET-pyyntöjä. Muuten pyyntö voi epäonnistua tai muut parametrit voivat tulkkiutua väärin ohjelmointikielessäsi tai HTTP-kirjastossa. 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
sinun tulisi käyttää: 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
Tai käytä oikeita URL-koodausfunktioita ohjelmointikielessäsi.