基本的な使い方
最初のGenderAPIリクエストを送信する
入力値を1つ送信すると、推定性別、確率、国、クレジット使用量を取得できます。名前には基本エンドポイントを、メールアドレスやユーザー名には専用エンドポイントを使用します。
認証
key クエリパラメータでAPIキーを追加します。本番環境のキーはサーバー側で管理し、ブラウザーコードや公開リポジトリには決して含めないでください。
機械可読な API リソース
最新の GenderAPI 契約を OpenAPI、Swagger、Postman 形式で利用できます。
GET
名前から性別を判定
名または氏名
名または氏名を入力する場合は、基本エンドポイントを使用します。
https://api.genderapi.io/apicURL
curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"任意パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
country | string | JP や US などの2文字の国コードです。 |
askToAI | boolean | true にすると、データベースに名前がない場合にAIによる補完判定を試みます。 |
forceToGenderize | boolean | 人名に見えにくい特殊な入力についても推定を試みます。 |
注意：架空の名前、ニックネーム、情報量の少ない入力を強制的に推定すると、精度が低くなる場合があります。
GET
メールアドレスから性別を判定
メールアドレス
メールエンドポイントは、アドレスから名前の候補を抽出してから性別を推定します。
https://api.genderapi.io/api/emailcURL
curl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=JP&askToAI=true&key=YOUR_API_KEY"名前を内部で抽出するため、このエンドポイントでは
forceToGenderize を使用できません。GET
ユーザー名から性別を判定
SNSのユーザー名
ユーザー名、ハンドルネーム、ニックネームに識別可能な名前が含まれる場合に使用します。
https://api.genderapi.io/api/usernamecURL
curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"JSONレスポンス
GenderAPIレスポンスの構造
3つのエンドポイントは共通の基本レスポンス構造を使用します。
200 OK
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "alice",
"gender": "female",
"country": "US",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
status | boolean | リクエストが正常に完了したかを示します。 |
used_credits | integer | このリクエストで消費したクレジット数です。 |
remaining_credits | integer | リクエスト後に残っているクレジット数です。 |
expires | integer | プランの有効期限を UNIX タイムスタンプで示します。 |
q | string | 送信した名前、メールアドレス、またはユーザー名です。 |
name | string | 正規化された、または入力から抽出された名前です。 |
gender | string | 推定結果です。値は male、female、または "null" です。 |
country | string | 最も可能性が高い ISO 3166-1 alpha-2 国コードです。 |
total_names | integer | 推定の根拠となった名前レコード数です。 |
probability | integer | 推定確率をパーセントで示します。 |
duration | string | サーバーがリクエストを処理した時間です。 |
入力値は必ずURLエンコードする
空白や特殊文字はHTTPクライアントでエンコードしてください。たとえば、未処理の空白ではなく sparkling%20unicorn を使用します。
次のステップ