複数の名前から性別を判定するAPI｜一括リクエスト

一括リクエストの概要

最大100件の名前をまとめて処理

data 配列を送信すると、レコードごとに1件の結果が返ります。自社システムの id を追加すれば、各判定結果を元のレコードへ確実に対応付けられます。

メソッドPOST

上限100件の名前

認証Bearer token

AIフォールバック非対応

一括リクエストではAI推論を使用しません。

一括エンドポイントでは askToAI と forceToGenderize を利用できません。非ラテン文字の名前やAIフォールバックが必要な入力には、単一名前エンドポイントを使用してください。

HDR

必須HTTPヘッダー

一括リクエストを認証

Content-Typeapplication/json

AuthorizationBearer YOUR_API_KEY

JSONリクエストボディ

パラメータ

フィールド	型	要否	説明
`data`	object[]	必須	1件以上100件以下の名前レコードを含む配列。
`data[].name`	string	必須	判定する名前。
`data[].country`	string	任意	ISO 3166-1 alpha-2 の国コード。指定国に結果がない場合は、利用可能なグローバル結果を返します。
`data[].id`	string \| integer	任意	自社システムのレコード識別子。入力と結果を対応付けられるよう、そのまま返されます。

国別結果のフォールバック

指定した国に一致する結果がない場合、GenderAPIは利用可能なグローバル結果を返します。JP、US、DE などのISO 3166-1 alpha-2コードを使用してください。

リクエストペイロード

data配列を作成

JSON

{
  "data": [
    { "name": "Andrea", "country": "DE", "id": "123" },
    { "name": "andrea", "country": "IT", "id": "456" },
    { "name": "james", "country": "US", "id": "789" }
  ]
}

コード例

複数の名前を一括送信

cURL

curl -X POST "https://api.genderapi.io/api/name/multi/country" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"data":[{"name":"Andrea","country":"DE","id":"123"},{"name":"andrea","country":"IT","id":"456"}]}'

JavaScript

const data = [
  { name: "Andrea", country: "DE", id: "123" },
  { name: "andrea", country: "IT", id: "456" }
];

const response = await fetch("https://api.genderapi.io/api/name/multi/country", {
  method: "POST",
  headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
  body: JSON.stringify({ data })
});

200レスポンス

結果を自社レコードと照合

JSON

{
  "status": true,
  "used_credits": 3,
  "remaining_credits": 7265,
  "expires": 1717069765,
  "names": [
    { "name": "andrea", "q": "Andrea", "gender": "female", "country": "DE", "total_names": 644, "probability": 88, "id": "123" },
    { "name": "andrea", "q": "andrea", "gender": "male", "country": "IT", "total_names": 13537, "probability": 98, "id": "456" }
  ],
  "duration": "5ms"
}

レスポンスフィールド

フィールド	型	説明
`status`	boolean	一括リクエストが正常に完了したかどうか。
`used_credits`	integer	送信したすべての名前で消費したクレジット数。
`remaining_credits`	integer	リクエスト完了後の残りクレジット数。
`expires`	integer	パッケージの有効期限を示す UNIX タイムスタンプ。
`names`	object[]	入力順に返される名前判定結果の配列。
`names[].name`	string	判定に使用された正規化済みの名前。
`names[].q`	string	リクエストで送信した元の名前。
`names[].gender`	string \| null	判定値：male、female、または null。
`names[].country`	string	判定時に使用された国コード。
`names[].total_names`	integer	判定結果の根拠となったサンプル数。
`names[].probability`	integer	判定の信頼度（パーセント）。
`names[].id`	string \| integer	レコード照合用にそのまま返される入力識別子。
`duration`	string	サーバーでの合計処理時間。

1回のリクエストは100件以内

送信前に配列を検証し、確実に照合できるよう各レコードへ一意の idを付けてください。大きなデータセットは、1バッチ100件以下に分割します。

次のガイド

メールアドレスから性別を判定

メールの単一リクエストメールから名前を抽出して性別を分析 →名前の単一リクエスト1件の名前でAIフォールバックを利用 →