Uzyskaj płeć na podstawie imienia – pojedyncze zapytanie
Endpoint Uzyskaj płeć na podstawie imienia pozwala określić płeć pojedynczego imienia. Wszystkie parametry są przesyłane za pomocą żądania POST w formacie JSON. Musisz się uwierzytelnić, używając metody Bearer token w nagłówku Authorization.
Adres URL żądania
POST https://api.genderapi.io/api
Wymagane nagłówki HTTP
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Parametry body żądania
Parametr | Typ | Wymagany | Opis |
---|---|---|---|
name | String | Tak | Imię, które chcesz przeanalizować. Powinno być pojedynczym słowem, bez dodatkowych tytułów lub przedrostków. |
country | String | Nie |
Dwuliterowy kod kraju (ISO 3166-1 alpha-2) dla poprawy dokładności.
Przykład: TR dla Turcji.
|
askToAI | Boolean | Nie |
Jeśli ustawione na true , API zapyta model AI, jeśli imię nie zostanie znalezione w bazie danych.
|
forceToGenderize | Boolean | Nie |
Jeśli ustawione na true , API spróbuje zgadnąć płeć nawet dla wpisów, które nie są typowymi imionami,
np. pseudonimy lub nazwy fantazyjne (np. sparkling unicorn ).
|
Przykłady zapytań
Przykład cURL
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name": "Alice", "country": "US", "askToAI": true, "forceToGenderize": true}'
Przykład PHP cURL
<?php
$url = "https://api.genderapi.io/api";
$data = array(
"name" => "Alice",
"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", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({
name: "Alice",
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"
payload = {
"name": "Alice",
"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": "Alice",
"name": "Alice",
"gender": "female",
"country": "US",
"total_names": 10234,
"probability": 98,
"duration": "4ms"
}
Pola odpowiedzi
Pole | Typ | Opis |
---|---|---|
status | Boolean | Wskazuje, czy zapytanie się powiodło. |
used_credits | Integer | Liczba kredytów zużytych w tym zapytaniu. |
remaining_credits | Integer | Pozostałe kredyty na Twoim koncie po tym zapytaniu. |
expires | Integer (timestamp) | Data wygaśnięcia pakietu jako znacznik czasu UNIX. |
q | String | Twoje zapytanie wejściowe (wysłane imię). |
name | String | Analizowane lub wyodrębnione imię. |
gender | Enum[String] | Przewidziana płeć. Możliwe wartości: male , female lub null . |
country | String | Kod kraju użyty podczas przewidywania. |
total_names | Integer | Liczba próbek użytych do tego przewidywania. |
probability | Integer | Procent pewności przewidywania płci. |
duration | String | Czas przetwarzania zapytania (np. 4ms ). |
Uwaga:
Zawsze upewnij się, że wartości wejściowe (np. imiona) nie zawierają nieoczekiwanych znaków.
Jeśli planujesz używać znaków specjalnych lub spacji, zadbaj o poprawne kodowanie JSON, aby uniknąć błędów.