Dokumentacja API Unified API v2.0

API v1.0

Oferujemy także inną wersję naszego interfejsu API z punktami końcowymi, które są łatwiejsze do zintegrowania. Jeśli dopiero zaczynasz implementować API, możesz przełączyć się na nasz punkt końcowy v1.0.
Zobacz API v1.0

OpenAPI

Zobacz naszą dokumentację API w Swaggerze

Postman

Zaimportuj naszą definicję API do Postmana
Zapytanie według imienia
Zapytanie według pełnego imienia
Zapytanie według adresu e-mail
Pochodzenie kraju
Pobierz statystyki
Kody błędów

Wyszukaj po adresie e-mail

Możesz również zapytać o płeć, korzystając z adresu e-mail, zawierającego:

Wyślij
Wymagane żądania: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <twój token autoryzacyjny>
link
JSON Payload
Pole Typ Wymagane Opis
email string Tak Adres e-mail do zapytania
country string Nie Kod kraju ISO 3166 ALPHA-2
link
locale string Nie Lokalizacja przeglądarki
ip string Nie Poprawny adres IPv4 lub IPv6
id string Nie Maksymalnie 50 znaków. Id może być ustawione na dowolną alfanumeryczną wartość. Na przykład możesz ustawić id na swoje wewnętrzne id zbioru danych w bazie danych. W asynchronicznym środowisku może to pomóc w lepszym połączeniu odpowiedzi z poprzednim żądaniem

Przykłady

Zapytaj tylko według adresu e-mail
play_arrow Testuj na żywo na codepen.io 
{"email":"theresa.miller14@gmail.com"}
Zapytaj według adresu e-mail i kodu kraju
play_arrow Testuj na żywo na codepen.io 
{"email":"thomas.clarks@hotmail.com","country":"US"}
Zapytaj według adresu e-mail i ustawień regionalnych przeglądarki
play_arrow Testuj na żywo na codepen.io 
{"email":"Thomas.j32@live.com","locale":"en_US"}
Zapytaj według adresu e-mail i użyj adresu IP do określenia lokalizacji
play_arrow Testuj na żywo na codepen.io 
{"email":"thomasfromnewyork@gmail.com","ip":"54.201.16.177"}
Zapytaj o wiele nazw w jednym żądaniu
play_arrow Testuj na żywo na codepen.io 
[{"email":"thomas.clarks@hotmail.com","country":"US"},{"email":"theresa.miller14@gmail.com"}]
Odpowiedź
{
    "input": {
        "email": "theresa.miller14@gmail.com"
    },
    "details": {
        "credits_used": 1,
        "duration": "12ms",
        "samples": 8961,
        "country": null,
        "first_name_sanitized": "theresa"
    },
    "result_found": true,
    "last_name": "Miller",
    "first_name": "Theresa",
    "probability": 0.98,
    "gender": "female"
}
Pole Typ Opis
input object Wysłany payload
details.credits_used int Ilość użytych zapytań dla tej zapytania
details.samples int Liczba rekordów znalezionych w naszej bazie danych, które pasują do twojego zapytania
details.country string Znalezione przez nas kraj
details.email_sanitized int Imię po zastosowaniu normalizacji
details.duration string Czas potrzebny serwerowi na przetworzenie zapytania
result_found bool Prawda jeżeli byliśmy w stanie uzyskać informacje o płci na podstawie podanego imienia
email string Adres e-mail użyty do określenia płci
probability float Ta wartość (między 0 a 1) określa wiarygodność naszej bazy danych. Wartość 1 oznacza, że wynik twojego zapytania o płeć jest w 100% dokładny.
gender string Możliwe wartości: mężczyzna, kobieta, nieznana
Ten produkt zawiera dane GeoLite2 utworzone przez firmę MaxMind, dostępne z http://www.maxmind.com.
Czat