Basisgebruik

GenderAPI stelt je in staat het geslacht van een persoon te bepalen op basis van verschillende soorten invoerdata. Je kunt rechtstreeks voornamen analyseren of namen extraheren uit e-mailadressen en gebruikersnamen. Hier lees je hoe je kunt beginnen:

1. Geslacht op basis van Naam

Stuur een voornaam naar de volgende endpoint: 

https://api.genderapi.io/api

Voorbeeld: 

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

Je kunt ook optionele parameters toevoegen:

  • country: Geef een tweeletterige landcode mee ( ISO 3166-1 alpha-2 ) om de nauwkeurigheid van de voorspelling te verbeteren. Bijvoorbeeld: country=TR voor Turkije.
  • askToAI: Als dit ingesteld is op true, zal de API een AI-model raadplegen om het geslacht te bepalen als de naam niet in de database voorkomt.
  • forceToGenderize: Als dit ingesteld is op true, probeert de API alsnog het geslacht te raden, zelfs voor invoer die geen echte namen lijken te zijn, zoals bijnamen of fantasienamen zoals sparkling unicorn of mystic warrior. Dit kan handig zijn voor het analyseren van gebruikersnamen, maar de resultaten kunnen minder nauwkeurig zijn. Opmerking: Deze parameter is niet beschikbaar bij het e-mailendpoint.

Voorbeeld met parameters: 

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

2. Geslacht op basis van E-mailadres

Gebruik deze endpoint als je alleen een e-mailadres hebt: 

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

Voorbeeld: 

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

Opmerking: De parameter forceToGenderize is niet beschikbaar voor het e-mailendpoint, omdat dit endpoint eerst intern de naam extraheert.


3. Geslacht op basis van Gebruikersnaam

Voor gebruikersnamen of bijnamen gebruik je: 

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

Voorbeeld: 

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

De parameter forceToGenderize is hier vooral nuttig omdat gebruikersnamen vaak woorden bevatten die geen echte namen zijn of fantasietermen. Deze parameter dwingt de API om alsnog een voorspelling van het geslacht te doen, zelfs als de invoer geen typische menselijke naam is.

Alle methodes ondersteunen zowel enkele als bulk-aanvragen. Voor meer details kun je de specifieke secties in het navigatiemenu links raadplegen.


✅ API Response

Voorbeeld van een JSON-response voor alle endpoints: 

{
  "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"
}

Response Velden

Veld Type Omschrijving
status Boolean true als de aanvraag succesvol was. Controleer op fouten als het false is.
used_credits Integer Aantal credits gebruikt voor deze aanvraag.
remaining_credits Integer Overgebleven credits op je account na deze aanvraag.
expires Integer (timestamp) Vervaldatum van het pakket als UNIX timestamp (seconden).
q String Je ingevoerde query (naam, e-mail of gebruikersnaam).
name String De gevonden of geëxtraheerde voornaam.
gender Enum[String] Voorspeld geslacht. Mogelijke waarden: male, female of null.
country Enum[String] Waarschijnlijkste landcode (bijv. US of DE).
total_names Integer Aantal samples gebruikt voor de voorspelling.
probability Integer Kanspercentage voor de voorspelling van het geslacht (bijv. 50-100).
duration String Verwerkingstijd van de aanvraag (bijv. 4ms).
Waarschuwing: Als je invoer waarden bevat met spaties of speciale tekens (bijv. sparkling unicorn), zorg er dan altijd voor dat je deze URL-encode voordat je GET-aanvragen uitvoert. Anders kan de aanvraag mislukken of kunnen andere parameters verkeerd geïnterpreteerd worden door je programmeertaal of HTTP-bibliotheek. 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
je moet dit gebruiken: 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
of de juiste URL-encoding functies toepassen in je programmeertaal.