Pobierz płeć na podstawie nazwy użytkownika – Pojedyncze zapytanie

Endpoint Get Gender by Username pozwala określić płeć osoby poprzez analizę nazwy użytkownika lub pseudonimu. Wszystkie parametry przesyłane są w żądaniu POST w formacie JSON. Autoryzacja musi być przeprowadzona z użyciem metody Bearer token w nagłówku Authorization.

URL żądania

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

Wymagane nagłówki HTTP

  • Content-Type: application/json
  • Authorization: Bearer YOUR_API_KEY

Parametry żądania (Request Body)

Parametr Typ Wymagane Opis
username String Tak Nazwa użytkownika lub pseudonim do analizy. Może to być nazwa z mediów społecznościowych, nick lub alias. Może zawierać słowa, które nie są imionami, np. terminy fantasy lub nazwy marek.
country String Nie Dwuliterowy kod kraju (ISO 3166-1 alpha-2) w celu zwiększenia dokładności predykcji. Przykład: TR dla Turcji.
askToAI Boolean Nie Jeśli ustawione na true, API zapyta model AI o określenie płci, gdy wyodrębnione imię nie zostanie znalezione w bazie danych.
forceToGenderize Boolean Nie Jeśli ustawione na true, API spróbuje odgadnąć płeć nawet dla nazw użytkowników, które nie przypominają prawdziwych imion, np. terminy fantasy lub pseudonimy (np. sparkling_unicorn).

Przykłady zapytań


Przykład cURL

curl -X POST "https://api.genderapi.io/api/username" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{"username": "sparkling_unicorn", "country": "US", "askToAI": true, "forceToGenderize": true}'

Przykład PHP cURL

<?php
$url = "https://api.genderapi.io/api/username";

$data = array(
    "username" => "sparkling_unicorn",
    "country" => "US",
    "askToAI" => true,
    "forceToGenderize" => true
);

$payload = json_encode($data);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "Content-Type: application/json",
    "Authorization: Bearer YOUR_API_KEY"
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Przykład JavaScript fetch

fetch("https://api.genderapi.io/api/username", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  body: JSON.stringify({
    username: "sparkling_unicorn",
    country: "US",
    askToAI: true,
    forceToGenderize: true
  })
})
.then(response => response.json())
.then(data => console.log(data));

Przykład Python requests

import requests

url = "https://api.genderapi.io/api/username"

payload = {
    "username": "sparkling_unicorn",
    "country": "US",
    "askToAI": True,
    "forceToGenderize": True
}

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())

Przykładowa odpowiedź JSON

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "sparkling_unicorn",
  "name": "Sparkling",
  "gender": "female",
  "country": "US",
  "total_names": 9876,
  "probability": 92,
  "duration": "6ms"
}

Pola w odpowiedzi

Pole Typ Opis
status Boolean Określa, czy żądanie zakończyło się powodzeniem.
used_credits Integer Liczba kredytów zużytych na to żądanie.
remaining_credits Integer Liczba kredytów pozostałych na koncie po tym żądaniu.
expires Integer (timestamp) Data wygaśnięcia pakietu w formacie UNIX timestamp.
q String Twoje zapytanie wejściowe (przesłana nazwa użytkownika).
name String Wyodrębnione imię z nazwy użytkownika.
gender Enum[String] Przewidywana płeć. Możliwe wartości: male, female lub null.
country String Kod kraju brany pod uwagę podczas predykcji.
total_names Integer Liczba próbek wykorzystanych do tej predykcji.
probability Integer Procentowe prawdopodobieństwo trafności predykcji płci.
duration String Czas potrzebny na przetworzenie żądania (np. 6ms).