Hämta kön utifrån namn – Enskild förfrågan
Slutpunkten Hämta kön utifrån namn gör det möjligt att avgöra könet för ett enskilt förnamn. Alla parametrar skickas via en POST-begäran som JSON. Du måste autentisera dig med Bearer token-metoden i Authorization-headern.
Förfrågnings-URL
POST https://api.genderapi.io/api
Nödvändiga HTTP-rubriker
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Body-parametrar för förfrågan
Parameter | Typ | Obligatorisk | Beskrivning |
---|---|---|---|
name | String | Ja | Förnamnet du vill analysera. Måste vara ett enda ord utan extra titlar eller prefix. |
country | String | Nej |
En tvåställig landskod (ISO 3166-1 alpha-2) för att förbättra noggrannheten.
Exempel: TR för Turkiet.
|
askToAI | Boolean | Nej |
Om satt till true frågar API:t en AI-modell om kön om namnet inte hittas i databasen.
|
forceToGenderize | Boolean | Nej |
Om satt till true försöker API:t gissa kön även för inmatningar som inte är typiska personnamn,
som smeknamn eller fantasitermer (t.ex. sparkling unicorn ).
|
Exempel på förfrågningar
cURL-exempel
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}'
PHP cURL-exempel
<?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;
?>
JavaScript fetch-exempel
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));
Python requests-exempel
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())
Exempel på JSON-svar
{
"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"
}
Svarsfält
Fält | Typ | Beskrivning |
---|---|---|
status | Boolean | Anger om begäran lyckades. |
used_credits | Integer | Antal krediter som använts för denna förfrågan. |
remaining_credits | Integer | Kvarvarande krediter på ditt konto efter denna förfrågan. |
expires | Integer (timestamp) | Paketets utgångsdatum som ett UNIX-timestamp. |
q | String | Din inmatningsfråga (namnet som skickades in). |
name | String | Det analyserade eller extraherade förnamnet. |
gender | Enum[String] | Förutspått kön. Möjliga värden: male , female eller null . |
country | String | Landskod som beaktades vid förutsägelsen. |
total_names | Integer | Antal exempel som användes för denna förutsägelse. |
probability | Integer | Sannolikhetsprocent för könsförutsägelsen. |
duration | String | Tid som togs för att behandla begäran (t.ex. 4ms ). |
Varning:
Se alltid till att inmatningsvärden som namn inte innehåller oväntade tecken.
Om du planerar att använda specialtecken eller mellanslag, använd korrekt JSON-kodning för att undvika fel.