Määritä sukupuoli nimestä – Yksittäinen pyyntö

Get Gender by Name -päätepisteen avulla voit määrittää yksittäisen etunimen sukupuolen. Kaikki parametrit lähetetään POST-pyynnössä JSON-muodossa. Tunnistautuminen tulee tehdä Bearer-tunnuksen avulla Authorization-otsikossa.

Pyyntöosoite

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

Vaaditut HTTP-otsikot

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

Pyyntörungon parametrit

Parametri Tyyppi Pakollinen Kuvaus
name Merkkijono Kyllä Etunimi, jonka haluat analysoida. Vain yksi sana – ilman ylimääräisiä titteleitä tai etuliitteitä.
country Merkkijono Ei Kaksikirjaiminen maakoodi (ISO 3166-1 alpha-2) tarkkuuden parantamiseksi. Esim. TR = Turkki.
askToAI Boolean Ei Jos true, API pyytää tekoälymallia arvaamaan sukupuolen, jos nimeä ei löydy tietokannasta.
forceToGenderize Boolean Ei Jos true, API yrittää arvata sukupuolen myös epätyypillisille nimille, kuten lempinimet tai fantasiatermit (esim. sparkling unicorn).

Esimerkkipyynnöt


cURL-esimerkki

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 -esimerkki

<?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 -esimerkki

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 -esimerkki


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())

Esimerkki JSON-vastauksesta

{
  "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"
}

Vasteen kentät

Kenttä Tyyppi Kuvaus
status Boolean Kertoo, onnistuiko pyyntö.
used_credits Kokonaisluku Käytettyjen krediittien määrä tässä pyynnössä.
remaining_credits Kokonaisluku Jäljellä olevat krediitit tililläsi tämän pyynnön jälkeen.
expires Kokonaisluku (timestamp) Paketin vanhenemisaika UNIX-muodossa.
q Merkkijono Lähettämäsi syöte (nimi).
name Merkkijono Analysoitu tai tunnistettu etunimi.
gender Enum[String] Ennustettu sukupuoli. Mahdolliset arvot: male, female tai null.
country Merkkijono Maa, jota ennusteessa käytettiin.
total_names Kokonaisluku Tässä ennusteessa käytettyjen nimien määrä.
probability Kokonaisluku Ennusteen varmuusprosentti.
duration Merkkijono Pyynnön käsittelyaika (esim. 4ms).
Huomio: Varmista aina, että nimet eivät sisällä odottamattomia merkkejä. Jos käytät erikoismerkkejä tai välilyöntejä, käytä aina oikeaa JSON-koodausta virheiden välttämiseksi.