Skip to main content

Easily detect the gender of an individual based on their name. This API uses AI to predict the likely gender of a person by their name

Project description

Gender Detector API

Easily detect the gender of an individual based on their name. This API uses AI to predict the likely gender of a person by their name

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Gender Detector API


Installation

Using pip:

pip install apiverve-genderdetector

Using pip3:

pip3 install apiverve-genderdetector

Configuration

Before using the genderdetector API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_genderdetector.apiClient import GenderdetectorAPIClient

# Initialize the client with your APIVerve API key
api = GenderdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "name": "John Mcdonald",
    "country": "us"
}

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Gender Detector API documentation is found here: https://docs.apiverve.com/ref/genderdetector. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_genderdetector.apiClient import GenderdetectorAPIClient

# Initialize the client with your APIVerve API key
api = GenderdetectorAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {
    "name": "John Mcdonald",
    "country": "us"
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "name": "John Mcdonald",
    "country": "US",
    "detected": true,
    "gender": "male"
  }
}

Error Handling

The API client provides comprehensive error handling through the GenderdetectorAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_genderdetector.apiClient import GenderdetectorAPIClient, GenderdetectorAPIClientError

api = GenderdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "name": "John Mcdonald",
    "country": "us"
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except GenderdetectorAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_genderdetector.apiClient import GenderdetectorAPIClient, GenderdetectorAPIClientError

api = GenderdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "name": "John Mcdonald",
    "country": "us"
}

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except GenderdetectorAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_genderdetector.apiClient import GenderdetectorAPIClient, GenderdetectorAPIClientError

query = {
    "name": "John Mcdonald",
    "country": "us"
}

# Using context manager ensures proper cleanup
with GenderdetectorAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except GenderdetectorAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_genderdetector.apiClient import GenderdetectorAPIClient

# Enable debug mode
api = GenderdetectorAPIClient("[YOUR_API_KEY]", debug=True)

query = {
    "name": "John Mcdonald",
    "country": "us"
}

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_genderdetector.apiClient import GenderdetectorAPIClient

api = GenderdetectorAPIClient("[YOUR_API_KEY]")

query = {
    "name": "John Mcdonald",
    "country": "us"
}

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_genderdetector-1.1.14.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_genderdetector-1.1.14-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_genderdetector-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_genderdetector-1.1.14.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_genderdetector-1.1.14.tar.gz
Algorithm Hash digest
SHA256 b49d32bce262550434d785ce702708ba1f084da6e30d20cb289d1aace12596ce
MD5 2a0607775af55cfeb3af9e88dcb46630
BLAKE2b-256 416918466f1bbc9cf42b0b58c7c6cf82343eee3369c23ef1930652308f165ea8

See more details on using hashes here.

File details

Details for the file apiverve_genderdetector-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_genderdetector-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 62267c310a26e4d4f5483e51e12eb89c0f5b532209ecc4d9c778f8cae284b236
MD5 9779be2c85e58d1ce10e0227b502b387
BLAKE2b-256 a0e167d75ecd191815856f58fcfaabec5cfa77c911d5cfa952a1d339c6d06be5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page