Anfrage im Überblick
Einen Namen pro Anfrage senden
Übermitteln Sie ein JSON-Objekt mit einem Vornamen und authentifizieren Sie die Anfrage mit einem Bearer Token. Ergänzen Sie einen Ländercode, wenn regionale Namensmuster die Einschätzung verbessern können.
Erforderliche HTTP-Header
Anfrage autorisieren
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYJSON-Request-Body
Parameter
| Parameter | Typ | Status | Beschreibung |
|---|---|---|---|
name | string | Erforderlich | Zu analysierender Vorname. Verwenden Sie einen bereinigten Wert ohne Titel oder Präfixe. |
country | string | Optional | Ländercode nach ISO 3166-1 Alpha-2, zum Beispiel DE oder US, für regionalen Kontext. |
askToAI | boolean | Optional | Bei true wird die KI-Unterstützung verwendet, wenn der Name nicht in der Datenbank gefunden wurde. |
forceToGenderize | boolean | Optional | Bei true wird auch für Spitznamen oder Eingaben, die nicht wie typische Namen aussehen, eine Einschätzung versucht. |
askToAI wird nur verwendet, wenn die Datenbank kein Ergebnis liefert. Erzwungene Einschätzungen ungewöhnlicher Eingaben können weniger zuverlässig sein; behandeln Sie probability deshalb als wichtiges Kontrollsignal.
Codebeispiele
Einzelanfrage ausführen
Alle Beispiele senden dieselbe Anfrage mit Bearer-Authentifizierung.
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Anna","country":"DE","askToAI":true}'const response = await fetch("https://api.genderapi.io/api", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({ name: "Anna", country: "DE", askToAI: true })
});
const data = await response.json();import requests
response = requests.post(
"https://api.genderapi.io/api",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"name": "Anna", "country": "DE", "askToAI": True}
)
print(response.json())200-Antwort
Ergebnis der Einschätzung
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Anna",
"name": "Anna",
"gender": "female",
"country": "DE",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}Antwortfelder
| Feld | Typ | Beschreibung |
|---|---|---|
status | boolean | Gibt an, ob die Anfrage erfolgreich verarbeitet wurde. |
used_credits | integer | Durch diese Anfrage verbrauchte Credits. |
remaining_credits | integer | Nach der Anfrage verfügbare Credits. |
expires | integer | Ablaufzeit des Pakets als UNIX-Zeitstempel. |
q | string | Ursprünglich übermittelter Name. |
name | string | Von GenderAPI analysierter Name. |
gender | string | null | Geschätzter Wert: male, female oder null. |
country | string | Bei der Einschätzung berücksichtigter Ländercode. |
total_names | integer | Anzahl der Stichproben, auf denen die Einschätzung beruht. |
probability | integer | Wahrscheinlichkeit der Einschätzung in Prozent. |
duration | string | Serverseitige Verarbeitungsdauer. |
Bereinigte und korrekt kodierte Eingaben senden
Verwenden Sie einen Vornamen ohne Titel oder Präfixe. JSON-Clients übernehmen die Kodierung automatisch; validieren Sie externe Eingaben trotzdem, bevor Sie den Request-Body erstellen.
Nächste Anleitung