Tunnista sukupuoli nimestä APIlla

Pyynnön yleiskatsaus

Lähetä yksi nimi kyselyä kohti

Lähetä etunimen sisältävä JSON-objekti ja tunnista pyyntö Bearer-tokenilla. Lisää maakoodi, kun alueelliset nimikäytännöt voivat parantaa ennustetta.

MenetelmäPOST

Sisältötyyppiapplication/json

TunnistautuminenBearer-token

Krediittikustannus1 haku

HDR

Pakolliset HTTP-headerit

Valtuuta pyyntö

Content-Typeapplication/json

AuthorizationBearer YOUR_API_KEY

Säilytä API-avain palvelimen ympäristömuuttujissa. Katso tunnistautumisoppaasta tunnistetietojen turvallinen käsittely.

Pyynnön JSON-runko

Parametrit

Parametri	Tyyppi	Vaatimus	Kuvaus
`name`	string	Pakollinen	Analysoitava etunimi. Käytä puhdasta nimikenttää ilman titteleitä tai etuliitteitä.
`country`	string	Valinnainen	Alueellisen kontekstin antava ISO 3166-1 alpha-2 -maakoodi, esimerkiksi FI tai SE.
`askToAI`	boolean	Valinnainen	Kun arvo on true, tekoälyä käytetään varamenetelmänä, jos nimeä ei löydy tietokannasta.
`forceToGenderize`	boolean	Valinnainen	Kun arvo on true, tulosta yritetään myös lempinimille tai syötteille, jotka eivät muistuta tavallisia nimiä.

Tekoäly varamenetelmänä

askToAI-asetusta käytetään vain, kun tietokanta ei anna tulosta. Epätavallisten syötteiden pakotetut ennusteet voivat olla epävarmempia, joten käytä todennäköisyyttä tärkeänä laatusignaalina.

Koodiesimerkit

Lähetä yksittäinen kysely

Kaikki esimerkit lähettävät saman pyynnön Bearer-tunnistautumisella.

cURL

curl -X POST "https://api.genderapi.io/api" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"name":"Emilia","country":"FI","askToAI":true}'

JavaScript

const response = await fetch("https://api.genderapi.io/api", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  body: JSON.stringify({ name: "Emilia", country: "FI", askToAI: true })
});

const data = await response.json();

Python

import requests

response = requests.post(
  "https://api.genderapi.io/api",
  headers={"Authorization": "Bearer YOUR_API_KEY"},
  json={"name": "Emilia", "country": "FI", "askToAI": True}
)
print(response.json())

200-vastaus

Ennustetulos

JSON

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "Emilia",
  "name": "Emilia",
  "gender": "female",
  "country": "FI",
  "total_names": 10234,
  "probability": 98,
  "duration": "4ms"
}

Vastauskentät

Kenttä	Tyyppi	Kuvaus
`status`	boolean	Suoritettiinko pyyntö ilman virheitä.
`used_credits`	integer	Pyynnön käyttämien krediittien määrä.
`remaining_credits`	integer	Pyynnön jälkeen käytettävissä olevien krediittien määrä.
`expires`	integer	Paketin vanhenemisaika UNIX-aikaleimana.
`q`	string	Pyynnössä lähetetty alkuperäinen nimi.
`name`	string	GenderAPIn analysoima nimi.
`gender`	string \| null	Ennustettu arvo: male, female tai null.
`country`	string	Ennusteessa käytetty maakoodi.
`total_names`	integer	Ennustetta tukevien nimiesiintymien määrä.
`probability`	integer	Ennusteen luottamus prosentteina.
`duration`	string	Palvelimen käsittelyaika.

Lähetä puhtaat ja oikein koodatut syötteet

Käytä etunimeä ilman titteleitä tai etuliitteitä. JSON-asiakasohjelmat hoitavat koodauksen automaattisesti, mutta validoi aina ulkoinen syöte ennen pyyntörungon muodostamista.

Seuraava opas

Analysoi useita nimiä

Usean nimen kyselyKäsittele useita nimiä yhdellä kyselyllä →TunnistautuminenTarkista API-avaimen turvallisuus →