Grundläggande Användning

GenderAPI låter dig avgöra en persons kön baserat på olika typer av indata. Du kan analysera förnamn direkt eller extrahera namn från e-postadresser och användarnamn. Så här kommer du igång:

1. Kön utifrån Namn

Skicka ett förnamn till följande endpoint: 

https://api.genderapi.io/api

Exempel: 

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

Du kan också lägga till valfria parametrar:

  • country: Skicka en tvåbokstavs landskod ( ISO 3166-1 alpha-2 ) för att förbättra noggrannheten i förutsägelsen. Till exempel: country=TR för Turkiet.
  • askToAI: Om satt till true, kommer API:et att fråga en AI-modell om könet om namnet inte finns i databasen.
  • forceToGenderize: Om satt till true, försöker API:et gissa könet även för indata som inte ser ut som riktiga personnamn, som smeknamn eller fantasifulla namn som sparkling unicorn eller mystic warrior. Detta kan vara användbart för att analysera användarnamn, men resultaten kan vara mindre exakta. Obs: Denna parameter är inte tillgänglig för e-post-endpointen.

Exempel med parametrar: 

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

2. Kön utifrån E-postadress

Använd denna endpoint om du bara har en e-postadress: 

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

Exempel: 

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

Obs: Parametern forceToGenderize är inte tillgänglig för e-postendpointen eftersom denna först internt extraherar namnet.


3. Kön utifrån Användarnamn

För användarnamn eller smeknamn, använd: 

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

Exempel: 

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

Parametern forceToGenderize är särskilt användbar här eftersom användarnamn ofta innehåller ord som inte är riktiga namn eller fantasitermer. Den tvingar API:et att försöka förutsäga kön även om indata inte är ett typiskt människonamn.

Alla metoder stöder enskilda eller bulk-förfrågningar. För mer information, se de specifika avsnitten i navigationsmenyn till vänster.


✅ API-svar

Exempel på JSON-svar för alla 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"
}

Svarsfält

Fält Typ Beskrivning
status Boolean true om begäran lyckades. Kontrollera fel om false.
used_credits Integer Antal krediter som användes för denna begäran.
remaining_credits Integer Kvarvarande krediter på ditt konto efter denna begäran.
expires Integer (timestamp) Förfallodatum för paketet som UNIX timestamp (sekunder).
q String Din indatafråga (namn, e-post eller användarnamn).
name String Det hittade eller extraherade förnamnet.
gender Enum[String] Förutspått kön. Möjliga värden: male, female eller null.
country Enum[String] Den mest troliga landskoden (t.ex. US eller DE).
total_names Integer Antal prover som använts för förutsägelsen.
probability Integer Sannolikhetsprocent för könsförutsägelsen (t.ex. 50-100).
duration String Bearbetningstid för begäran (t.ex. 4ms).
Varning: Om dina indata innehåller mellanslag eller specialtecken (t.ex. sparkling unicorn), se alltid till att URL-enkoda dem innan du gör GET-förfrågningar. Annars kan begäran misslyckas eller andra parametrar kan tolkas felaktigt av ditt programmeringsspråk eller HTTP-bibliotek. 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
du bör istället använda: 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
eller använda lämpliga URL-enkodningsfunktioner i ditt programmeringsspråk.