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.com/v2/gender
|
||||||||||||||||||||||||
| Headers |
Content-Type: application/json
Authorization: Bearer <dein Authentifizierungstoken>
|
||||||||||||||||||||||||
| JSON Payload |
|
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.
