Hämta kön via användarnamn – Enkel förfrågan

Slutpunkten Get Gender by Username låter dig avgöra en persons kön genom att analysera ett användarnamn eller smeknamn. Alla parametrar skickas via en POST-begäran i JSON-format. Du måste autentisera dig med Bearer-tokenmetoden i Authorization-headern.

Begärans URL

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

Nödvändiga HTTP-headers

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Parametrar i begärans body

Parameter	Typ	Obligatorisk	Beskrivning
username	String	Ja	Användarnamnet eller smeknamnet som ska analyseras. Det kan vara ett sociala medier-handle, skärmnamn eller alias. Kan innehålla ord som inte är riktiga namn, som fantasitermer eller varumärkesreferenser.
country	String	Nej	En landskod på två bokstäver (ISO 3166-1 alpha-2) för att förbättra noggrannheten i förutsägelsen. Exempel: `SE` för Sverige.
askToAI	Boolean	Nej	Om satt till `true` kommer API:t fråga en AI-modell för att avgöra könet om det extraherade namnet inte finns i databasen.
forceToGenderize	Boolean	Nej	Om satt till `true` kommer API:t försöka gissa kön även för användarnamn som inte liknar riktiga mänskliga namn, som fantasitermer eller smeknamn (exempelvis `sparkling_unicorn`).

Exempel på begäran

cURL-exempel

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

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

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

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

Exempel på JSON-svar

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

Fält i svaret

Fält	Typ	Beskrivning
status	Boolean	Anger om begäran lyckades.
used_credits	Integer	Antal krediter som användes för denna begäran.
remaining_credits	Integer	Antal krediter som återstår på ditt konto efter denna begäran.
expires	Integer (timestamp)	Förfallodatum för ditt paket som UNIX timestamp.
q	String	Din ursprungliga fråga (det skickade användarnamnet).
name	String	Det förnamn som extraherats från användarnamnet.
gender	Enum[String]	Förutsagt kön. Möjliga värden: `male`, `female` eller `null`.
country	String	Landskod som övervägdes vid prediktionen.
total_names	Integer	Antal exempel som användes för denna prediktion.
probability	Integer	Sannolikhetsprocent för könsprediktionen.
duration	String	Tiden det tog att behandla begäran (t.ex. `6ms`).