基本的な使い方

GenderAPIを使うと、さまざまな種類の入力データから人物の性別を判別できます。 名前を直接解析したり、メールアドレスやユーザー名から名前を抽出したりできます。 以下の手順で始めてみましょう。

1. 名前から性別を判定する

次のエンドポイントにファーストネームを送信します：

https://api.genderapi.io/api

例：

curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

以下のオプションパラメータも追加できます：

• country：2文字の国コードを指定します。 （ ISO 3166-1 alpha-2 ） を使用することで予測精度が向上します。例：country=TR （トルコの場合）。
• askToAI：true を設定すると、データベースに名前が存在しない場合にAIモデルに性別を判定させます。
• forceToGenderize：true を設定すると、 sparkling unicorn や mystic warrior のようなニックネームやファンタジー名など、 実在する人名らしくない入力でも性別推定を試みます。 ユーザー名の解析などに便利ですが、精度は低下する可能性があります。 注意： このパラメータはメールエンドポイントでは利用できません。

パラメータ付きの例：

curl "https://api.genderapi.io/api?name=sparkling%20unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

2. メールアドレスから性別を判定する

メールアドレスしか持っていない場合は、こちらのエンドポイントを使用します：

https://api.genderapi.io/api/email

例：

curl "https://api.genderapi.io/api/email?email=alice.smith@example.com&country=TR&askToAI=true&key=YOUR_API_KEY"

注意： forceToGenderize パラメータは、メールエンドポイントでは利用できません。 このエンドポイントでは内部的にまず名前を抽出するためです。

3. ユーザー名から性別を判定する

ユーザー名やニックネームを解析する場合は以下を使用します：

https://api.genderapi.io/api/username

例：

curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

forceToGenderize パラメータは特にこのケースで役立ちます。 ユーザー名には人名ではない単語やファンタジー用語が含まれることが多いため、 通常の人名でない入力でもAPIが性別推定を試みます。

すべてのメソッドは単一リクエストと一括リクエストの両方をサポートしています。 詳細は左側のナビゲーションメニュー内の各セクションをご確認ください。

✅ APIレスポンス例

全エンドポイントでのJSONレスポンス例：

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "michael.smith@example.com",
  "name": "Michael",
  "gender": "male",
  "country": "US",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

レスポンスフィールド

curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"

curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"