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.
API v1.0 anzeigen

OpenAPI

Schau dir unsere Dokumentation mit Swagger an

Postman

Importiere unsere API-Definitionen in Postman
Abfrage anhand eines Vornamens
Abfrage anhand eines vollständigen Namens
Abfrage anhand einer E-Mail Adresse
Abfrage des Herkunftslandes
Statistiken abfragen
Fehler Codes

Abfrage eines vollständigen Namens - VOR- UND NACHNAME SPLITTEN

Wenn du ein kombiniertes Feld für Vor- und Nachname auf deiner Webseite hast, benutze diesen API Endpunkt um die entsprechenden Teile zu extrahieren:

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
full_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 eines vollständigen Namens
play_arrow Live auf copepen.io testen 
{"full_name":"Theresa Miller"}
Abfrage eines vollständigen Namens mit Ländercode
play_arrow Live auf copepen.io testen 
{"full_name":"Theresa Miller","country":"US"}
Abfrage anhand des vollständigen Namens und benutze die Browser Locale zur Lokalisierung
play_arrow Live auf copepen.io testen 
{"full_name":"Thomas Johnson","locale":"en_US"}
Abfrage anhand des vollständigen Namens und benutze eine IP Adresse zur Lokalisierung
play_arrow Live auf copepen.io testen 
{"full_name":"Markus Stefan NonExistingLastName","ip":"54.201.16.177"}
Abfrage mehrere Namen in einem einzigen Query
play_arrow Live auf copepen.io testen 
[{"full_name":"Theresa Miller"},{"full_name":"Thomas Johnson","country":"US"}]
Antwort
{
    "input": {
        "full_name": "Theresa Miller"
    },
    "details": {
    "credits_used": 1,
        "duration": "33ms",
        "samples": 8961,
        "country": null,
        "first_name_sanitized": "theresa"
    },
    "result_found": true,
    "last_name": "Miller",
    "first_name": "Theresa",
    "probability": 0.98,
    "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.full_name_sanitized int 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
full_name string Der vollständige Name, den wir für die Bestimmung des Geschlechts verwendet 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