Kön från namn API | Dokumentation för enskild förfrågan

Översikt över förfrågan

Skicka ett namn per förfrågan

Skicka ett JSON-objekt med ett förnamn och autentisera med Bearer-token. Lägg till landskod när regionala namnmönster kan förbättra prognosen.

MetodPOST

Content typeapplication/json

AutentiseringBearer-token

Kreditkostnad1 uppslagning

HDR

Obligatoriska HTTP-headers

Auktorisera förfrågan

Content-Typeapplication/json

AuthorizationBearer YOUR_API_KEY

Förvara API-nyckeln i miljövariabler på servern. Läs autentiseringsguiden om hur nyckeln skyddas.

JSON-body för förfrågan

Parametrar

Parameter	Typ	Krav	Beskrivning
`name`	string	Obligatorisk	Förnamnet som ska analyseras. Använd ett rent namnvärde utan titlar eller prefix.
`country`	string	Valfri	Landskod enligt ISO 3166-1 alpha-2, exempelvis SE eller US, som ger regional kontext.
`askToAI`	boolean	Valfri	När värdet är true används AI-stöd om namnet inte hittas i databasen.
`forceToGenderize`	boolean	Valfri	När värdet är true försöker API:t ge ett resultat för smeknamn eller värden som inte liknar vanliga personnamn.

Om AI-stöd

askToAI används endast när databasen saknar resultat. Tvingade prognoser för ovanliga värden kan vara mindre tillförlitliga, så behandla probability som en viktig signal.

Kodexempel

Skicka en enskild förfrågan

Exemplen skickar samma förfrågan med Bearer-autentisering.

cURL

curl -X POST "https://api.genderapi.io/api" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"name":"Alice","country":"SE","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: "Alice", country: "SE", 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": "Alice", "country": "SE", "askToAI": True}
)
print(response.json())

200-svar

Prognosresultat

JSON

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

Svarsfält

Fält	Typ	Beskrivning
`status`	boolean	Anger om förfrågan slutfördes utan fel.
`used_credits`	integer	Antal krediter som förbrukades av förfrågan.
`remaining_credits`	integer	Antal krediter som återstår efter förfrågan.
`expires`	integer	Paketets utgångstid som en UNIX-tidsstämpel.
`q`	string	Det ursprungliga namnet i förfrågan.
`name`	string	Namnet som analyserades av GenderAPI.
`gender`	string \| null	Prognostiserat värde: male, female eller null.
`country`	string	Landskoden som användes för prognosen.
`total_names`	integer	Antal namnposter som stöder prognosen.
`probability`	integer	Prognosens sannolikhet i procent.
`duration`	string	Serverns behandlingstid.

Skicka rena och korrekt kodade värden

Använd ett förnamn utan titlar eller prefix. JSON-klienter hanterar kodningen automatiskt, men validera alltid extern indata innan du skapar request body.

Nästa guide

Analysera flera namn

Förfrågan med flera namnBearbeta flera namn i en förfrågan →AutentiseringGranska säkerheten för API-nyckeln →