Grundläggande användning
Skicka din första Gender API-förfrågan
Skicka ett inmatningsvärde och få prognostiserat kön, sannolikhet, land och användningsinformation. Börja med ett namn och använd sedan den särskilda endpointen för e-post eller användarnamn när det är den data du har.
Lägg till din API-nyckel med frågeparametern key. Förvara produktionsnycklar på servern och exponera aldrig en privat nyckel i webbläsarkod eller publika kodarkiv.
Använd det aktuella GenderAPI-kontraktet i OpenAPI-, Swagger- eller Postman-format.
Kön från namn
Förnamn eller fullständigt namn
Använd bas-endpointen när inmatningen är ett förnamn eller fullständigt namn.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Alice&country=SE&key=YOUR_API_KEY"Valfria parametrar
| Parameter | Typ | Beskrivning |
|---|---|---|
country | string | Tvåställig landskod, exempelvis SE eller US. |
askToAI | boolean | När värdet är true används AI-stöd om namnet inte hittas i databasen. |
forceToGenderize | boolean | Försöker skapa en prognos för ovanliga värden som kanske inte ser ut som personnamn. |
Kön från e-post
E-postadress
E-post-endpointen extraherar först ett sannolikt namn ur adressen och genomför därefter könsanalysen.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=SE&askToAI=true&key=YOUR_API_KEY"forceToGenderize är inte tillgänglig för denna endpoint eftersom namnet extraheras internt.Kön från användarnamn
Användarnamn eller handle
Använd denna endpoint för användarnamn, handles och smeknamn som kan innehålla ett identifierbart namn.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=SE&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"JSON-svar
Tolka svaret från GenderAPI
Alla tre endpoints använder samma grundläggande svarsstruktur.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "alice",
"gender": "female",
"country": "SE",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Svarsfält
| Fält | Typ | Beskrivning |
|---|---|---|
status | boolean | Anger om förfrågan slutfördes utan fel. |
used_credits | integer | Antal API-krediter som förbrukades av förfrågan. |
remaining_credits | integer | Antal krediter som återstår efter förfrågan. |
expires | integer | Paketets utgångstid som en UNIX-tidsstämpel. |
q | string | Den ursprungliga sökningen efter namn, e-postadress eller användarnamn. |
name | string | Det normaliserade eller extraherade förnamnet. |
gender | string | Prognostiserat kön: male, female eller "null". |
country | string | Mest sannolika landskod enligt ISO 3166-1 alpha-2. |
total_names | integer | Antal namnposter som prognosen bygger på. |
probability | integer | Prognosens sannolikhet i procent. |
duration | string | Serverns behandlingstid för förfrågan. |
URL-koda alltid inmatningsvärden
Mellanslag och specialtecken måste kodas av HTTP-klienten. Använd exempelvis sparkling%20unicorn i stället för ett okodat mellanslag.
Fortsätt bygga