Grundlæggende brug
Send din første Gender API-forespørgsel
Send én inputværdi, og modtag estimeret køn, sandsynlighed, land og forbrugsoplysninger. Begynd med et navn, og brug det særlige endpoint til e-mail eller brugernavn, når det er den datatype, du har.
Tilføj din API-nøgle med forespørgselsparameteren key. Opbevar produktionsnøgler på din server – eksponér aldrig en privat nøgle i browserkode eller et offentligt repository.
Brug den aktuelle GenderAPI-kontrakt i OpenAPI-, Swagger- eller Postman-format.
Køn ud fra navn
Fornavn eller fuldt navn
Brug basis-endpointet, når dit input er et fornavn eller et fuldt navn.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"Valgfrie parametre
| Parameter | Type | Beskrivelse |
|---|---|---|
country | string | Landekode på to bogstaver, f.eks. DK eller US. |
askToAI | boolean | Når værdien er true, bruges AI som fallback, hvis navnet ikke findes i databasen. |
forceToGenderize | boolean | Forsøger en estimering for usædvanligt input, som muligvis ikke ligner et personnavn. |
Køn ud fra e-mail
E-mailadresse
E-mail-endpointet udtrækker først et sandsynligt navn fra adressen og foretager derefter kønsbestemmelsen.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=DK&askToAI=true&key=YOUR_API_KEY"forceToGenderize er ikke tilgængelig for dette endpoint, fordi navnet udtrækkes internt.Køn ud fra brugernavn
Brugernavn på sociale medier
Brug dette endpoint til brugernavne, handles og kaldenavne, der kan indeholde et genkendeligt navn.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=DK&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"JSON-svar
Forstå svaret fra GenderAPI
Alle tre endpoints bruger den samme grundlæggende svarstruktur.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "alice",
"gender": "female",
"country": "DK",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Svarfelter
| Felt | Type | Beskrivelse |
|---|---|---|
status | boolean | Angiver, om forespørgslen blev gennemført korrekt. |
used_credits | integer | Antal kreditter, som forespørgslen brugte. |
remaining_credits | integer | Resterende kreditter efter forespørgslen. |
expires | integer | Pakkens udløbstid som UNIX-tidsstempel. |
q | string | Den oprindelige forespørgsel med navn, e-mail eller brugernavn. |
name | string | Det normaliserede eller udtrukne fornavn. |
gender | string | Estimeret køn: male, female eller "null". |
country | string | Den mest sandsynlige ISO 3166-1 alpha-2-landekode. |
total_names | integer | Antal navneposter, som estimeringen bygger på. |
probability | integer | Estimeringens sandsynlighed angivet i procent. |
duration | string | Serverens behandlingstid for forespørgslen. |
URL-kod altid inputværdier
Mellemrum og specialtegn skal kodes af din HTTP-klient. Brug eksempelvis sparkling%20unicorn i stedet for et almindeligt mellemrum.
Fortsæt implementeringen