API-dokumentation Enhetlig API v2.0

API v1.0

Vi erbjuder också en annan version av API med endpoints som är lättare att integrera. Om du är nybörjare på att implementera API:er kan du byta till vår v1.0 endpoint.
Visa API v1.0

OpenAPI

Visa vår API-dokumentation i Swagger

Postman

Importera vår API-definition till Postman
Sök efter Förnamn
Sök efter Fullständigt Namn
Sök efter E-postadress
Få ursprungsland
Hämta statistik
Felkoder

Fråga med förnamn

Det här är det enklaste sättet att fråga om ett kön med hjälp av ett namn. Varje svar är JSON-kodad:

Skicka
Nödvändiga förfrågningar: 1
URL
https://gender-api.io/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <din auktoriseringstoken>
link
JSON Payload
Fält Typ Obligatorisk Beskrivning
first_name string Ja Namn att fråga
country string Nej ISO 3166 ALPHA-2 landskod
link
locale string Nej Webbläsarinställning
ip string Nej Giltig IPv4- eller IPv6-adress
id string Nej Max 50 tecken. Du kan ange detta id till vilket alfanumeriskt värde du vill. Som ett exempel kan du ange id till ditt interna id för datasetet i din databas. I en asynkron miljö kan detta hjälpa dig att bättre koppla svaren till en tidigare förfrågan

Exempel

Fråga endast med förnamn
play_arrow Testa live med codepen.io 
{"first_name":"Sandra"}
Fråga med förnamn och landskod
play_arrow Testa live med codepen.io 
{"first_name":"Sandra","country":"US"}
Fråga med förnamn och webbläsarens språk
play_arrow Testa live med codepen.io 
{"first_name":"Sandra","locale":"en_US"}
Fråga med förnamn och använd en IP-adress för lokalisering
play_arrow Testa live med codepen.io 
{"first_name":"Sandra","ip":"54.201.16.177"}
Fråga flera namn i en enda förfrågan
play_arrow Testa live med codepen.io 
[{"first_name":"Sandra","country":"US"},{"first_name":"Jason","country":"US"}]
Svar
{
    "input": {
        "first_name": "Sandra"
    },
    "details": {
        "credits_used": 1,
        "samples": 464,
        "country": null,
        "first_name_sanitized": "sandra",
        "duration": "436ms"
    },
    "result_found": true,
    "first_name": "Sandra",
    "probability": 0.85,
    "gender": "female"
}
Fält Typ Beskrivning
input object Den inskickade nyttolasten
details.credits_used int Antalet förfrågningar som använts för denna fråga
details.samples int Antal poster som hittats i vår databas som matchar din förfrågan
details.country string Landet vi hittade
details.first_name_sanitized string Namnet efter att vi applicerat vår normaliserare på det
details.duration string Tiden servern behövde för att behandla begäran
result_found bool Sant om vi kunde fråga ett kön för det angivna namnet
first_name string Det första förnamnet vi använde för att könsbestämma
probability float Denna värde (mellan 0 och 1) bestämmer tillförlitligheten i vår databas. Ett värde av 1 innebär att resultaten på din könsförfrågan är 100% korrekta.
gender string Möjliga värden: man, kvinna, okänd
Den här produkten inkluderar GeoLite2-data skapad av MaxMind, tillgänglig från http://www.maxmind.com.
Chatt