Geschlecht per Benutzername abrufen – Einzelanfrage
Der Endpunkt Get Gender by Username ermöglicht es dir, das Geschlecht einer Person
durch die Analyse eines Benutzernamens oder Spitznamens zu bestimmen. Alle Parameter werden per POST-Request
als JSON gesendet. Du musst dich mit der Bearer-Token-Methode im Authorization-Header authentifizieren.
Request-URL
POST https://api.genderapi.io/api/username
Erforderliche HTTP-Header
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Body-Parameter der Anfrage
Parameter |
Typ |
Erforderlich |
Beschreibung |
username |
String |
Ja |
Der Benutzername oder Spitzname, der analysiert werden soll. Kann ein Social-Media-Handle, Bildschirmname oder Alias sein.
Kann auch Wörter enthalten, die keine echten Namen sind, z. B. Fantasiebegriffe oder Markennamen.
|
country |
String |
Nein |
Ein zweistelliger Ländercode (ISO 3166-1 alpha-2),
um die Vorhersagegenauigkeit zu verbessern. Beispiel: TR für die Türkei.
|
askToAI |
Boolean |
Nein |
Wenn auf true gesetzt, fragt die API ein KI-Modell nach einer Geschlechtsbestimmung,
falls der extrahierte Name nicht in der Datenbank gefunden wird.
|
forceToGenderize |
Boolean |
Nein |
Wenn auf true gesetzt, versucht die API, ein Geschlecht auch dann zu erraten,
wenn der Benutzername nicht wie ein echter Vorname aussieht, z. B. bei Fantasienamen oder Spitznamen (z. B. sparkling_unicorn ).
|
Beispiele für Requests
cURL-Beispiel
curl -X POST "https://api.genderapi.io/api/username" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"username": "sparkling_unicorn", "country": "US", "askToAI": true, "forceToGenderize": true}'
PHP cURL-Beispiel
<?php
$url = "https://api.genderapi.io/api/username";
$data = array(
"username" => "sparkling_unicorn",
"country" => "US",
"askToAI" => true,
"forceToGenderize" => true
);
$payload = json_encode($data);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
"Content-Type: application/json",
"Authorization: Bearer YOUR_API_KEY"
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
JavaScript fetch-Beispiel
fetch("https://api.genderapi.io/api/username", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({
username: "sparkling_unicorn",
country: "US",
askToAI: true,
forceToGenderize: true
})
})
.then(response => response.json())
.then(data => console.log(data));
Python requests-Beispiel
import requests
url = "https://api.genderapi.io/api/username"
payload = {
"username": "sparkling_unicorn",
"country": "US",
"askToAI": True,
"forceToGenderize": True
}
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
Beispiel für eine JSON-Antwort
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "sparkling_unicorn",
"name": "Sparkling",
"gender": "female",
"country": "US",
"total_names": 9876,
"probability": 92,
"duration": "6ms"
}
Felder in der Antwort
Feld |
Typ |
Beschreibung |
status |
Boolean |
Gibt an, ob die Anfrage erfolgreich war. |
used_credits |
Integer |
Anzahl der Credits, die für diese Anfrage verbraucht wurden. |
remaining_credits |
Integer |
Anzahl der verbleibenden Credits nach dieser Anfrage. |
expires |
Integer (timestamp) |
Ablaufdatum des Pakets als UNIX-Timestamp. |
q |
String |
Deine Eingabeanfrage (der übermittelte Benutzername). |
name |
String |
Der extrahierte Vorname aus dem Benutzernamen. |
gender |
Enum[String] |
Vorhergesagtes Geschlecht. Mögliche Werte: male , female oder null . |
country |
String |
Das bei der Vorhersage berücksichtigte Länderkürzel. |
total_names |
Integer |
Anzahl der Beispiele, die für diese Vorhersage verwendet wurden. |
probability |
Integer |
Prozentsatz der Sicherheit der Geschlechtsvorhersage. |
duration |
String |
Dauer der Verarbeitung der Anfrage (z. B. 6ms ). |