Grunnleggende Bruk

GenderAPI lar deg fastslå kjønnet til en person ved hjelp av ulike typer inndata. Du kan analysere fornavn direkte, eller trekke ut navn fra e-postadresser og brukernavn. Slik kommer du i gang:

1. Kjønn fra Navn

Send et fornavn til følgende endepunkt: 

https://api.genderapi.io/api

Eksempel: 

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

Du kan også legge til valgfrie parametere:

  • country: Send en to-bokstavs landskode ( ISO 3166-1 alpha-2 ) for å forbedre nøyaktigheten på forutsigelsen. For eksempel: country=TR for Tyrkia.
  • askToAI: Hvis satt til true, vil API-et be en AI-modell om å fastslå kjønn hvis navnet ikke finnes i databasen.
  • forceToGenderize: Hvis satt til true, vil API-et forsøke å gjette kjønn selv for inndata som ikke ligner ekte menneskenavn, som kallenavn eller fantasifulle navn som sparkling unicorn eller mystic warrior. Dette kan være nyttig ved analyse av brukernavn, men resultatene kan være mindre nøyaktige. Merk: Denne parameteren er ikke tilgjengelig på e-post-endepunktet.

Eksempel med parametere: 

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

2. Kjønn fra E-postadresse

Bruk dette endepunktet hvis du kun har en e-postadresse: 

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"

Merk: Parameteren forceToGenderize er ikke tilgjengelig for e-post-endepunktet, ettersom dette endepunktet først trekker ut navnet internt.


3. Kjønn fra Brukernavn

For brukernavn eller kallenavn, bruk: 

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 spesielt nyttig her fordi brukernavn ofte inneholder ikke-navn-ord eller fantasibegreper. Den tvinger API-et til å forsøke en kjønnsforutsigelse selv om inndataen ikke er et typisk menneskenavn.

Alle metodene støtter enkelt- eller bulk-forespørsler. For flere detaljer, sjekk de spesifikke seksjonene i menyen til venstre.


✅ API-respons

Eksempel på JSON-respons for alle endepunkter: 

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

Responsfelt

Felt Type Beskrivelse
status Boolean true hvis forespørselen var vellykket. Sjekk feilkoder hvis false.
used_credits Integer Antall kreditter brukt for denne forespørselen.
remaining_credits Integer Gjenværende kreditter tilgjengelig på kontoen din etter denne forespørselen.
expires Integer (timestamp) Utløpsdato for pakken som UNIX-timestamp (sekunder).
q String Din inndata (navn, e-post eller brukernavn).
name String Det funnede eller uttrukne fornavnet.
gender Enum[String] Forutsagt kjønn. Mulige verdier: male, female eller null.
country Enum[String] Den mest sannsynlige landskoden (f.eks. US, DE).
total_names Integer Antall eksempler som er brukt bak forutsigelsen.
probability Integer Sannsynlighetsprosent for kjønnsforutsigelsen (f.eks. 50–100).
duration String Behandlingstid for forespørselen (f.eks. 4ms).
Advarsel: Hvis inndataene dine inneholder mellomrom eller spesialtegn (f.eks. sparkling unicorn), må du alltid URL-kode dem før du utfører GET-forespørsler. Ellers kan forespørselen feile eller andre parametere kan bli feiltolket av programmeringsspråket eller HTTP-biblioteket ditt. 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
bør du bruke: 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
Eller bruk riktige funksjoner for URL-koding i programmeringsspråket ditt.