API Docs Unified API v2.0

API v1.0

We also offer another API version with endpoints that are easier to integrate. If you're a beginner in implementing API's you can switch to our v1.0 endpoint.

Query by first name

This is the easiest way to query a gender by a name. Each response is JSON encoded:

Post
Required Credits: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <your authorization token>
link
JSON Payload
Field Type Required Description
first_name string Yes Name to query
country string No ISO 3166 ALPHA-2 Country Code
link
locale string No Browser Locale
ip string No Valid IPv4 or IPv6 address
id string No Max 50 chars. You can set this id to any alphanumeric value you want. As an example, you can set the id to your internal id of the dataset in your database. In an asynchronus environment this can help you to better connect the response to a previous request

Examples

Query by first name only
{"first_name":"Sandra"}
Query by first name and country code
{"first_name":"Sandra","country":"US"}
Query by first name and browser locale
{"first_name":"Sandra","locale":"en_US"}
Query by first name and use an IP address for localization
{"first_name":"Sandra","ip":"54.201.16.177"}
Query multiple names in a single request
[{"first_name":"Sandra","country":"US"},{"first_name":"Jason","country":"US"}]
Response
{
    "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"
}
Field Type Description
input array The submitted payload
details.credits_used int The amount of credits used for this query
details.samples int Number of records found in our database which match your request
details.country string The country we found
details.first_name_sanitized int The name after we applied our normalizer to it
details.duration int Time the server needed to process the request
result_found bool True if we were able to query a gender for the given name
first_name string The first name we used for genderization
probability int This value (between 0 and 1) determines the reliability of our database. A value of 1 means that the results on your gender request are 100% accurate.
gender string Possible values: male, female, unknown
This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com.
Chat

Cookies

We use cookies (including third-party cookies) to collect information about visitors' use of our website. These cookies help us to provide you with the best possible online experience and to constantly improve our websites. Information collected via cookies may also be processed outside the European Union, for example, in the USA. By clicking the "Accept All" button, you agree to the use of cookies. To withdraw your consent at any time, change your settings or for more information about the use of cookies, click here or "Cookie Settings" at the end of the page.