Basisgebruik
Voer uw eerste Gender API-aanvraag uit
Verstuur één invoerwaarde en ontvang voorspeld gender, waarschijnlijkheid, land en gebruiksinformatie. Begin met een naam en kies het speciale endpoint wanneer u een e-mailadres of gebruikersnaam hebt.
Voeg uw API-sleutel toe met queryparameter key. Bewaar productiesleutels op uw server en plaats een privésleutel nooit in browsercode of een openbare repository.
Gebruik het actuele GenderAPI-contract in OpenAPI-, Swagger- of Postman-formaat.
Gender uit een naam
Voornaam of volledige naam
Gebruik het basisendpoint wanneer de invoer een voornaam of volledige naam is.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Sophie&key=YOUR_API_KEY"Optionele parameters
| Parameter | Type | Beschrijving |
|---|---|---|
country | string | Tweeletterige landcode, zoals NL of BE. |
askToAI | boolean | Bij true wordt AI geraadpleegd wanneer de naam niet in de database staat. |
forceToGenderize | boolean | Probeert een voorspelling voor ongebruikelijke invoer die mogelijk niet op een persoonsnaam lijkt. |
Gender uit e-mail
E-mailadres
Het e-mailendpoint leidt eerst een waarschijnlijke naam af uit het adres en voert daarna genderherkenning uit.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=sophie.devries%40example.com&country=NL&askToAI=true&key=YOUR_API_KEY"forceToGenderize is niet beschikbaar voor dit endpoint, omdat de naam intern wordt afgeleid.Gender uit een gebruikersnaam
Socialmedia-gebruikersnaam
Gebruik dit endpoint voor gebruikersnamen, handles en bijnamen die een herkenbare naam kunnen bevatten.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=NL&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"JSON-respons
Begrijp de respons van GenderAPI
Alle drie endpoints gebruiken dezelfde kernstructuur voor de respons.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Sophie",
"name": "sophie",
"gender": "female",
"country": "NL",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Responsvelden
| Veld | Type | Beschrijving |
|---|---|---|
status | boolean | Geeft aan of de aanvraag met succes is voltooid. |
used_credits | integer | Aantal credits dat deze aanvraag heeft verbruikt. |
remaining_credits | integer | Aantal credits dat na de aanvraag resteert. |
expires | integer | Vervaldatum van het pakket als UNIX-tijdstempel. |
q | string | De oorspronkelijke naam, het e-mailadres of de gebruikersnaam. |
name | string | De genormaliseerde of uit de invoer afgeleide voornaam. |
gender | string | Voorspeld gender: male, female of "null". |
country | string | Meest waarschijnlijke ISO 3166-1 alpha-2-landcode. |
total_names | integer | Aantal naamrecords waarop de voorspelling berust. |
probability | integer | Waarschijnlijkheid van de voorspelling als percentage. |
duration | string | Verwerkingstijd van de aanvraag op de server. |
Codeer invoerwaarden altijd voor de URL
Spaties en speciale tekens moeten door uw HTTP-client worden gecodeerd. Gebruik bijvoorbeeld sparkling%20unicorn in plaats van een onbewerkte spatie.
Ga verder met bouwen