Grundlæggende Brug

GenderAPI giver dig mulighed for at bestemme en persons køn ved hjælp af forskellige typer inputdata. Du kan analysere fornavne direkte eller udtrække navne fra e-mailadresser og brugernavne. Sådan kommer du i gang:

1. Køn fra Navn

Send et fornavn til følgende endpoint: 

https://api.genderapi.io/api

Eksempel: 

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

Du kan også tilføje valgfrie parametre:

  • country: Send en to-bogstavs landekode ( ISO 3166-1 alpha-2 ) for at forbedre præcisionen. For eksempel: country=TR for Tyrkiet.
  • askToAI: Hvis sat til true, vil API’en spørge en AI-model om at bestemme kønnet, hvis navnet ikke findes i databasen.
  • forceToGenderize: Hvis sat til true, vil API’en forsøge at gætte et køn, selv for input der ikke ligner rigtige menneskenavne, som kælenavne eller fantasifulde navne som sparkling unicorn eller mystic warrior. Dette kan være nyttigt til analyse af brugernavne, men resultaterne kan være mindre præcise. Bemærk: Denne parameter er ikke tilgængelig i e-mail endpointet.

Eksempel med parametre: 

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

2. Køn fra E-mailadresse

Brug dette endpoint, hvis du kun har en e-mailadresse: 

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

Eksempel: 

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

Bemærk: Parameteren forceToGenderize er ikke tilgængelig for e-mail endpointet, fordi dette endpoint først internt udtrækker navnet.


3. Køn fra Brugernavn

For brugernavne eller kælenavne, brug: 

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

Eksempel: 

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

Parameteren forceToGenderize er især nyttig her, fordi brugernavne ofte indeholder ikke-navne eller fantasifulde udtryk. Den tvinger API’en til at forsøge en kønsbestemmelse, selv hvis input ikke er et typisk menneskeligt navn.

Alle metoder understøtter enkelt- eller bulkforespørgsler. For flere detaljer, se de specifikke sektioner i navigationsmenuen til venstre.


✅ API-svar

Eksempel på JSON-svar for 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"
}

Felter i svaret

Felt Type Beskrivelse
status Boolean true hvis forespørgslen lykkedes. Tjek fejl, hvis false.
used_credits Integer Antal credits brugt på denne forespørgsel.
remaining_credits Integer Tilbageværende credits på din konto efter denne forespørgsel.
expires Integer (timestamp) Udløbsdato for pakken som UNIX timestamp (sekunder).
q String Din forespørgsel (navn, e-mail eller brugernavn).
name String Det fundne eller udtrukne fornavn.
gender Enum[String] Det forudsagte køn. Mulige værdier: male, female eller null.
country Enum[String] Den mest sandsynlige landekode (f.eks. US eller DE).
total_names Integer Antal eksempler, der ligger til grund for forudsigelsen.
probability Integer Sandsynlighedsprocent for kønsforudsigelsen (f.eks. 50-100).
duration String Behandlingstid for forespørgslen (f.eks. 4ms).
Advarsel: Hvis dine input indeholder mellemrum eller specialtegn (f.eks. sparkling unicorn), skal du altid URL-enkode dem før du laver GET-forespørgsler. Ellers kan forespørgslen fejle eller andre parametre kan blive fejlfortolket af dit programmeringssprog eller HTTP-bibliotek. 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
du skal bruge: 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
eller bruge korrekte URL-enkodningsfunktioner i dit programmeringssprog.