Määritä sukupuoli käyttäjänimestä – Yksittäinen pyyntö

Get Gender by Username -päätepisteen avulla voit määrittää henkilön sukupuolen analysoimalla käyttäjänimeä tai lempinimeä. Kaikki parametrit tulee lähettää JSON-muotoisena POST-pyyntönä. Pyyntö tulee tunnistaa Bearer-tunnuksella Authorization-otsikossa.

Pyyntöosoite

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

Vaaditut HTTP-otsikot

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Pyyntörungon parametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
username	Merkkijono	Kyllä	Analysoitava käyttäjänimi tai lempinimi. Tämä voi olla sosiaalisen median tunnus, näyttönimi tai alias. Voi sisältää myös muita kuin oikeita nimiä, kuten fantasia- tai brändisanoja.
country	Merkkijono	Ei	Kaksikirjaiminen maakoodi tarkkuuden parantamiseksi (ISO 3166-1 alpha-2). Esim. `TR` = Turkki.
askToAI	Boolean	Ei	Jos arvo on `true`, API pyytää AI-mallilta sukupuoliennustetta, kun nimeä ei löydy tietokannasta.
forceToGenderize	Boolean	Ei	Jos arvo on `true`, API yrittää arvata sukupuolen myös käyttäjänimille, jotka eivät muistuta oikeita ihmisten nimiä (esim. fantasia- tai lempinimet kuten `sparkling_unicorn`).

Esimerkkipyynnöt

cURL-esimerkki

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}'

PHP cURL -esimerkki

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

JavaScript fetch -esimerkki

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

Python requests -esimerkki

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

Esimerkkivastaus JSON-muodossa

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

Vasteen kentät

Kenttä	Tyyppi	Kuvaus
status	Boolean	Osoittaa, onnistuiko pyyntö.
used_credits	Kokonaisluku	Tässä pyynnössä käytettyjen krediittien määrä.
remaining_credits	Kokonaisluku	Krediittien määrä jäljellä pyynnön jälkeen.
expires	Kokonaisluku (timestamp)	Paketin vanhenemisaika UNIX-muodossa.
q	Merkkijono	Lähettämäsi syöte (käyttäjänimi).
name	Merkkijono	Käyttäjänimestä tunnistettu nimi.
gender	Enum[String]	Ennustettu sukupuoli. Mahdolliset arvot: `male`, `female` tai `null`.
country	Merkkijono	Ennustamisessa huomioitu maa.
total_names	Kokonaisluku	Tässä ennusteessa käytettyjen niminäytteiden määrä.
probability	Kokonaisluku	Sukupuoliennusteen varmuusprosentti.
duration	Merkkijono	Pyynnön käsittelyaika (esim. `6ms`).