Post
Required Requests: 1
| URL |
https://gender-api.com/v2/gender
|
| Headers |
Content-Type: application/json
|
| JSON Payload |
| Field |
Type |
Required |
Description |
| email |
string |
Yes |
Email address 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 email address only
{"email":"theresa.miller14@gmail.com"}
Query by email address and country code
{"email":"thomas.clarks@hotmail.com","country":"US"}
Query by email address and browser locale
{"email":"Thomas.j32@live.com","locale":"en_US"}
Query by email address and use an IP address for localization
{"email":"thomasfromnewyork@gmail.com","ip":"54.201.16.177"}
Query multiple names in a single request
[{"email":"thomas.clarks@hotmail.com","country":"US"},{"email":"theresa.miller14@gmail.com"}]
Response
{
"input": {
"email": "theresa.miller14@gmail.com"
},
"details": {
"credits_used": 1,
"duration": "12ms",
"samples": 8961,
"country": null,
"first_name_sanitized": "theresa"
},
"result_found": true,
"last_name": "Miller",
"first_name": "Theresa",
"probability": 0.98,
"gender": "female"
}
| Field |
Type |
Description |
| input |
object |
The submitted payload |
| details.credits_used |
int |
The amount of requests 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.email_sanitized |
int |
The name after we applied our normalizer to it |
| details.duration |
string |
Time the server needed to process the request |
| result_found |
bool |
True if we were able to query a gender for the given name |
| email |
string |
The email address we used for genderization |
| probability |
float |
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 |