API Dokumentation Unified API v2.0

API v1.0

Wir bieten auch eine weitere API-Version mit Schnittstellen an, die einfacher zu integrieren sind. Wenn du Anfänger in der Implementierung von APIs bist, kannst du auch zu der Dokumentation des 1.0er Endpunkts wechseln.

Abfrage nur mit einem Vornamen

Das ist der einfachste Weg, das Geschlecht zu bestimmen. Alle Antworten unseres Servers sind im JSON Format:

Post
Benötigtes Guthaben: 1 Credit für jede erfolgreiche Anfrage
URL
https://gender-api.io/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <dein Authentifizierungstoken>
link
JSON Payload
Feld Typ Benötigt Beschreibung
first_name string Ja Name der abgefragt werden soll
country string Nein ISO 3166 ALPHA-2 Länderkürzel
link
locale string Nein Browser Locale
ip string Nein Gültige IPv4 oder IPv6 Adresse
id string Nein Max. 50 Zeichen. Du kannst diesem Feld einen beliebigen Alphanumerischen Wert mitgeben. Beispielsweise kann als ID die interne ID des Datensatzes aus deiner Datenbank gesetzt werden. In einer asynchronen Umgebung kann dadurch z.B. unsere Serverantwort besser der vorhergehenden Anfrage zugeordnet werden

Beispiele

Abfrage nur mit einem Vornamen
{"first_name":"Sandra"}
Abfrage nach Vornamen und Ländercode
{"first_name":"Sandra","country":"US"}
Abfrage nach Vorname und Browser Locale
{"first_name":"Sandra","locale":"en_US"}
Abfrage anhand des Vornamens und benutze eine IP Adresse zur Lokalisierung
{"first_name":"Sandra","ip":"54.201.16.177"}
Abfrage mehrere Namen in einem einzigen Query
[{"first_name":"Sandra","country":"US"},{"first_name":"Jason","country":"US"}]
Antwort
{
    "input": {
        "first_name": "Sandra"
    },
    "details": {
        "credits_used": 1,
        "samples": 464,
        "country": null,
        "first_name_sanitized": "sandra",
        "duration": "436ms"
    },
    "result_found": true,
    "first_name": "Sandra",
    "probability": 0.85,
    "gender": "female"
}
Feld Typ Beschreibung
input object Der übergebene Input
details.credits_used int Die Anzahl an Anfragen, die für diesen Query nötig waren
details.samples int Anzahl an Einträgen die auf deine Anfrage in unserer Datenbank gefunden wurden
details.country string Das gefundene Land
details.first_name_sanitized string Der Name, nachdem wir ihn normalisiert haben
details.duration string Zeit, wie lange der Server gebraucht hat, um die Antwort zu ermitteln
result_found bool True, wenn wir ein Geschlecht zum angegebenen Namen bestimmen konnten
first_name string Der gefundene Vorname, den wir zur Bestimmung des Geschlechts genutzt haben
probability float Dieser Wert (zwischen 0 und 1) bestimmt, wie sicher wir uns sind, das richtige Geschlecht gefunden zu haben. Ein Wert von 1 sagt aus, dass wir uns zu 100% sicher sind.
gender string Mögliche Antworten: male, female, uknown
Dieses Produkt enthält GeoLite2 Daten erstellt von MaxMind, verfügbar von http://www.maxmind.com.
Chat
Wir benötigen deine Zustimmung
Wir verwenden Cookies (auch von Drittanbietern), um Informationen über die Nutzung unserer Website durch Besucher zu sammeln. Diese Cookies helfen uns dabei, dir das bestmögliche Online-Erlebnis zu bieten, unsere Websites ständig zu verbessern. Über Cookies gesammelte Informationen können auch außerhalb der Europäischen Union, etwa in den USA verarbeitet werden. Mit dem Klick auf den Button „Ja, ich stimme zu“ erklärst du dich mit der Verwendung von Cookies einverstanden. Um deine Einwilligung jederzeit zu widerrufen, deine Einstellungen zu ändern und für weitere Informationen über die Nutzung von Cookies klicke hier oder auf “Cookie Einstellungen” am Ende der Seite.