# GenderAPI.io

GenderAPI.io provides an API to determine the gender associated with a given name, email address, or username.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `GENDERAPI_IO`
- **Version:** 20260211_00

## Tools

### Gender API Get Statistics

**Slug:** `GENDERAPI_IO_GENDERAPI_GET_STATS`

Tool to retrieve account usage statistics from GenderAPI.io. Use when you need to check remaining API credits and expiry.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Gender by First Name

**Slug:** `GENDERAPI_IO_GENDER_API_QUERY_BY_FIRST_NAME`

Tool to determine gender by querying first name. Use when you need to infer likely gender for a given name with optional localization hints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Optional arbitrary identifier (up to 50 characters) to correlate the response. |
| `ip` | string | No | Optional IP address (IPv4 or IPv6) to localize the query. |
| `name` | string | Yes | First name to query gender for. |
| `locale` | string | No | Optional locale to guide gender inference. |
| `askToAI` | boolean | No | Ask AI model when the name isn’t present in the database. |
| `country` | string | No | Optional ISO 3166 alpha-2 country code to localize the query. |
| `forceToGenderize` | boolean | No | Attempt to genderize even for non-typical names (e.g., nicknames). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gender from Username

**Slug:** `GENDERAPI_IO_GET_GENDER_FROM_USERNAME`

Tool to determine gender from a username or nickname. Use when you have an alias or handle and want to infer gender from that identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `askToAI` | boolean | No | If true, asks the AI model when the name is not found in the database. |
| `country` | string | No | Optional ISO 3166-1 alpha-2 country code to improve prediction accuracy. |
| `username` | string | Yes | Username or nickname to analyze for gender inference. |
| `forceToGenderize` | boolean | No | If true, attempts prediction even for usernames that don't resemble real names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Gender API Error Codes

**Slug:** `GENDERAPI_IO_LIST_ERROR_CODES`

Tool to list all possible error codes returned by Gender API. Use when debugging or validating API responses.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query gender by email address

**Slug:** `GENDERAPI_IO_QUERY_BY_EMAIL_ADDRESS`

Tool to determine gender from an email address. Use when you need to infer gender for personalization after obtaining proper consent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Optional client-provided ID (max 50 characters) for tracing. |
| `ip` | string | No | Valid IPv4 or IPv6 address for geo-hinting. |
| `email` | string | Yes | Email address to query; must be a valid email format. |
| `locale` | string | No | Browser locale to improve name parsing (e.g., 'en', 'fr'). |
| `country` | string | No | ISO 3166-1 alpha-2 country code to hint the endpoint (uppercase). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
