Aanvraagoverzicht
Verstuur één naam per aanvraag
Verstuur een JSON-object met een voornaam en authenticeer met een Bearer-token. Voeg een landcode toe wanneer regionale naamgewoonten de voorspelling kunnen verbeteren.
Vereiste HTTP-headers
Autoriseer de aanvraag
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYJSON-aanvraagbody
Parameters
| Parameter | Type | Vereiste | Beschrijving |
|---|---|---|---|
name | string | Verplicht | Voornaam om te analyseren. Gebruik een schone naam zonder titels of voorvoegsels. |
country | string | Optioneel | ISO 3166-1 alpha-2-landcode, zoals NL of BE, voor regionale context. |
askToAI | boolean | Optioneel | Gebruik bij true AI wanneer de naam niet in de database wordt gevonden. |
forceToGenderize | boolean | Optioneel | Probeer bij true een resultaat voor bijnamen of invoer die niet op een gebruikelijke naam lijkt. |
askToAI geldt alleen als de database geen resultaat heeft. Geforceerde voorspellingen voor ongebruikelijke invoer kunnen minder betrouwbaar zijn; behandel probability als een belangrijk signaal.
Codevoorbeelden
Voer een enkele aanvraag uit
Deze voorbeelden versturen dezelfde aanvraag met Bearer-authenticatie.
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Sophie","country":"NL","askToAI":true}'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: "Sophie", country: "NL", askToAI: true })
});
const data = await response.json();import requests
response = requests.post("https://api.genderapi.io/api",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"name": "Sophie", "country": "NL", "askToAI": True})
print(response.json())200-respons
Voorspellingsresultaat
{
"status": true, "used_credits": 1,
"remaining_credits": 4999, "expires": 1743659200,
"q": "Sophie", "name": "Sophie",
"gender": "female", "country": "NL",
"total_names": 10234, "probability": 98,
"duration": "4ms"
}Responsvelden
| Veld | Type | Beschrijving |
|---|---|---|
status | boolean | Of de aanvraag met succes is voltooid. |
used_credits | integer | Credits die deze aanvraag heeft verbruikt. |
remaining_credits | integer | Credits die na de aanvraag beschikbaar zijn. |
expires | integer | Vervaldatum van het pakket als UNIX-tijdstempel. |
q | string | Oorspronkelijke naam uit de aanvraag. |
name | string | Naam die GenderAPI heeft geanalyseerd. |
gender | string | null | Voorspelde waarde: male, female of null. |
country | string | Landcode die voor de voorspelling is gebruikt. |
total_names | integer | Aantal voorbeelden waarop de voorspelling berust. |
probability | integer | Waarschijnlijkheid van de voorspelling als percentage. |
duration | string | Verwerkingstijd op de server. |
Verstuur schone, correct gecodeerde invoer
Gebruik een voornaam zonder titels of voorvoegsels. JSON-clients verzorgen de codering automatisch, maar valideer externe invoer altijd voordat u de aanvraagbody maakt.
Volgende handleiding