Grundlagen
Erste Anfrage an die Gender API senden
Senden Sie einen Eingabewert und erhalten Sie Geschlecht, Wahrscheinlichkeit, Land und Nutzungsinformationen. Beginnen Sie mit einem Namen; für E-Mail-Adressen und Benutzernamen stehen eigene Endpunkte bereit.
Übergeben Sie Ihren API-Schlüssel im Query-Parameter key. Speichern Sie produktive Schlüssel ausschließlich auf Ihrem Server – niemals im Browser-Code oder in einem öffentlichen Repository.
Nutzen Sie den aktuellen GenderAPI-Vertrag im OpenAPI-, Swagger- oder Postman-Format.
Geschlecht anhand des Namens
Vorname oder vollständiger Name
Verwenden Sie den Basis-Endpunkt, wenn die Eingabe ein Vorname oder vollständiger Name ist.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Anna&country=DE&key=YOUR_API_KEY"Optionale Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
country | string | Zweistelliger Ländercode wie DE oder US. |
askToAI | boolean | Bei true wird die KI-Unterstützung abgefragt, wenn der Name nicht in der Datenbank gefunden wurde. |
forceToGenderize | boolean | Versucht auch bei ungewöhnlichen Eingaben eine Einschätzung, selbst wenn diese nicht wie Personennamen aussehen. |
Geschlecht anhand der E-Mail
E-Mail-Adresse
Der E-Mail-Endpunkt extrahiert zunächst einen wahrscheinlichen Namen aus der Adresse und führt anschließend die Geschlechtserkennung aus.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=anna.mueller%40example.com&country=DE&askToAI=true&key=YOUR_API_KEY"forceToGenderize ist für diesen Endpunkt nicht verfügbar, da der Name intern extrahiert wird.Geschlecht anhand des Benutzernamens
Benutzername oder Handle
Verwenden Sie diesen Endpunkt für Benutzernamen, Handles und Spitznamen, die einen erkennbaren Namen enthalten können.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=anna_mueller&country=DE&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"JSON-Antwort
GenderAPI-Antwort richtig auswerten
Alle drei Endpunkte verwenden dieselbe grundlegende Antwortstruktur.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Anna",
"name": "anna",
"gender": "female",
"country": "DE",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Antwortfelder
| Feld | Typ | Beschreibung |
|---|---|---|
status | boolean | Gibt an, ob die Anfrage erfolgreich abgeschlossen wurde. |
used_credits | integer | Anzahl der durch diese Anfrage verbrauchten Credits. |
remaining_credits | integer | Verbleibende Credits nach der Anfrage. |
expires | integer | Ablaufzeit des Pakets als UNIX-Zeitstempel. |
q | string | Die ursprüngliche Abfrage für Name, E-Mail-Adresse oder Benutzername. |
name | string | Der normalisierte oder aus der Eingabe extrahierte Vorname. |
gender | string | Geschätztes Geschlecht: male, female oder "null". |
country | string | Wahrscheinlichster Ländercode nach ISO 3166-1 Alpha-2. |
total_names | integer | Anzahl der Namensdatensätze, auf denen die Einschätzung beruht. |
probability | integer | Wahrscheinlichkeit der Einschätzung in Prozent. |
duration | string | Serverseitige Verarbeitungsdauer der Anfrage. |
Eingabewerte immer URL-kodieren
Leerzeichen und Sonderzeichen müssen vom HTTP-Client kodiert werden. Verwenden Sie beispielsweise anna%20mueller statt eines nicht kodierten Leerzeichens.
Integration fortsetzen