Client for 'GenderAPI.io'.

genderapi-R

Official R Client for GenderAPI.io — determine gender from names, emails, and usernames using AI, including bulk operations for high-volume analysis.

✅ Get a Free API Key:
https://app.genderapi.io

🚀 Installation

Since the package is not yet on CRAN, install directly from GitHub using {devtools}.

Install {devtools} if you don’t have it:

install.packages("devtools")

Then install genderapi-R:

devtools::install_github("GenderAPI/genderapi-R")

Load the package:

library(genderapi)

⚠️ Required Packages

Make sure you have these installed:

install.packages(c("httr", "jsonlite"))

Example

library(genderapi)

api_key <- "YOUR_API_KEY"

result <- get_gender_by_name(
  api_key = api_key,
  name = "Michael"
)

print(result)

🔗 Load the Library

library(genderapi)

📝 Usage

🔹 Get Gender by Name

api_key <- "YOUR_API_KEY"

result <- get_gender_by_name(
  api_key = api_key,
  name = "Michael"
)

print(result)

With Additional Options

result <- get_gender_by_name(
  api_key = api_key,
  name = "李雷",
  country = "CN",
  askToAI = TRUE,
  forceToGenderize = TRUE
)

print(result)

🔹 Get Gender by Email

result <- get_gender_by_email(
  api_key = api_key,
  email = "[email protected]"
)

print(result)

With askToAI

result <- get_gender_by_email(
  api_key = api_key,
  email = "[email protected]",
  askToAI = TRUE
)

print(result)

🔹 Get Gender by Username

result <- get_gender_by_username(
  api_key = api_key,
  username = "michael_dev"
)

print(result)

With Additional Options

result <- get_gender_by_username(
  api_key = api_key,
  username = "michael_dev",
  country = "US",
  askToAI = TRUE,
  forceToGenderize = TRUE
)

print(result)

🔹 Get Gender by Name (Bulk)

Lookup up to 100 names in a single request.

data <- list(
  list(name = "Andrea", country = "DE", id = "123"),
  list(name = "andrea", country = "IT", id = "456"),
  list(name = "james", country = "US", id = "789")
)

result <- get_gender_by_name_bulk(
  api_key = api_key,
  data = data
)

print(result)

🔹 Get Gender by Email (Bulk)

Lookup up to 50 emails in a single request.

data <- list(
  list(email = "[email protected]", country = "US", id = "abc123"),
  list(email = "[email protected]", country = "DE", id = "def456")
)

result <- get_gender_by_email_bulk(
  api_key = api_key,
  data = data
)

print(result)

🔹 Get Gender by Username (Bulk)

Lookup up to 50 usernames in a single request.

data <- list(
  list(username = "cooluser", country = "US", id = "u001"),
  list(username = "maria2025", country = "DE", id = "u002")
)

result <- get_gender_by_username_bulk(
  api_key = api_key,
  data = data
)

print(result)

📥 API Parameters

Below are the parameters accepted by each function.

Name Lookup

Name Lookup (Bulk)

Email Lookup

Email Lookup (Bulk)

Username Lookup

Username Lookup (Bulk)

✅ API Response

All functions return a list representing the JSON response.

Single lookup example:

list(
  status = TRUE,
  used_credits = 1,
  remaining_credits = 4999,
  expires = 1743659200,
  q = "[email protected]",
  name = "Michael",
  gender = "male",
  country = "US",
  total_names = 325,
  probability = 98,
  duration = "4ms"
)

Bulk lookup example:

list(
  status = TRUE,
  used_credits = 3,
  remaining_credits = 7265,
  expires = 1717069765,
  names = list(
    list(
      name = "andrea",
      q = "Andrea",
      gender = "female",
      country = "DE",
      total_names = 644,
      probability = 88,
      id = "123"
    ),
    list(
      name = "andrea",
      q = "andrea",
      gender = "male",
      country = "IT",
      total_names = 13537,
      probability = 98,
      id = "456"
    )
  ),
  duration = "5ms"
)

🔎 Response Fields

⚠️ Error Handling

If an error occurs, the API returns:

list(
  status = FALSE,
  errno = 94,
  errmsg = "invalid or missing key"
)

Common error codes:

💻 Troubleshooting

• Check internet connection.
• Ensure your API key is correct.
• Confirm required R packages are installed:

  install.packages(c("httr", "jsonlite"))
  

🔗 Live Test Pages

• Gender by name:https://www.genderapi.io
• Gender by email:https://www.genderapi.io/determine-gender-from-email
• Gender by username:https://www.genderapi.io/determine-gender-from-username

📚 Detailed API Documentation

See full API docs:

https://www.genderapi.io/api-documentation

⚖️ License

MIT License.