Podstawowe Użycie

GenderAPI pozwala określić płeć osoby na podstawie różnych rodzajów danych wejściowych. Możesz analizować bezpośrednio imiona lub wyodrębniać je z adresów e-mail i nazw użytkowników. Oto jak zacząć:

1. Płeć na podstawie Imienia

Wyślij imię na poniższy endpoint: 

https://api.genderapi.io/api

Przykład: 

curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

Możesz też dodać opcjonalne parametry:

  • country: Podaj dwuliterowy kod kraju ( ISO 3166-1 alpha-2 ) aby zwiększyć dokładność przewidywania. Przykład: country=TR dla Turcji.
  • askToAI: Jeśli ustawione na true, API zapyta model sztucznej inteligencji o określenie płci, jeśli imię nie zostanie znalezione w bazie danych.
  • forceToGenderize: Jeśli ustawione na true, API spróbuje zgadnąć płeć nawet dla danych wejściowych, które nie wyglądają jak prawdziwe imiona, takich jak pseudonimy czy fantazyjne nazwy, np. sparkling unicorn czy mystic warrior. Może to być przydatne przy analizie nazw użytkowników, ale wyniki mogą być mniej dokładne. Uwaga: Ten parametr nie jest dostępny w endpointcie email.

Przykład z parametrami: 

curl "https://api.genderapi.io/api?name=sparkling%20unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

2. Płeć na podstawie Adresu Email

Użyj tego endpointu, jeśli masz tylko adres email: 

https://api.genderapi.io/api/email

Przykład: 

curl "https://api.genderapi.io/api/email?email=alice.smith@example.com&country=TR&askToAI=true&key=YOUR_API_KEY"

Uwaga: Parametr forceToGenderize nie jest dostępny dla endpointu email, ponieważ ten endpoint najpierw wewnętrznie wyodrębnia imię.


3. Płeć na podstawie Nazwy Użytkownika

Dla nazw użytkowników lub pseudonimów użyj: 

https://api.genderapi.io/api/username

Przykład: 

curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

Parametr forceToGenderize jest tutaj szczególnie przydatny, ponieważ nazwy użytkowników często zawierają słowa, które nie są prawdziwymi imionami lub są terminami fantazyjnymi. Zmusza API do próby przewidzenia płci, nawet jeśli dane wejściowe nie są typowym imieniem ludzkim.

Wszystkie metody obsługują zarówno pojedyncze, jak i masowe żądania. Aby uzyskać więcej informacji, sprawdź odpowiednie sekcje w menu nawigacyjnym po lewej stronie.


✅ Odpowiedź API

Przykład odpowiedzi JSON dla wszystkich endpointów: 

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "michael.smith@example.com",
  "name": "Michael",
  "gender": "male",
  "country": "US",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

Pola Odpowiedzi

Pole Typ Opis
status Boolean true, jeśli zapytanie zakończyło się sukcesem. Sprawdź błędy, jeśli false.
used_credits Integer Liczba kredytów użytych w tym zapytaniu.
remaining_credits Integer Pozostałe kredyty na Twoim koncie po tym zapytaniu.
expires Integer (timestamp) Data wygaśnięcia pakietu w formacie UNIX timestamp (sekundy).
q String Twoje zapytanie wejściowe (imię, email lub nazwa użytkownika).
name String Znalezione lub wyodrębnione imię.
gender Enum[String] Przewidywana płeć. Możliwe wartości: male, female lub null.
country Enum[String] Najbardziej prawdopodobny kod kraju (np. US lub DE).
total_names Integer Liczba próbek użytych do przewidywania.
probability Integer Procent prawdopodobieństwa przewidywania płci (np. 50-100).
duration String Czas przetwarzania zapytania (np. 4ms).
Uwaga: Jeśli Twoje wartości wejściowe zawierają spacje lub znaki specjalne (np. sparkling unicorn), zawsze koduj je w formacie URL przed wykonaniem żądań GET. W przeciwnym razie zapytanie może się nie powieść lub inne parametry mogą zostać źle zinterpretowane przez Twój język programowania lub bibliotekę HTTP. 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
powinieneś użyć: 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
lub zastosować odpowiednie funkcje kodowania URL w swoim języku programowania.