⚡ 統合API v2.0 上級者向け

APIドキュメント

大量リクエストにも対応した高性能な統合 API を体験しよう。複数の名前を 1 回のリクエストで問い合わせて、驚くほど高速なレスポンスを受け取れるよ。

メールアドレスで問い合わせる

メールアドレスに含まれる情報を使って、性別を判定することもできます

POST https://gender-api.com/v2/gender

info 必要なリクエスト数: 1

http Headers

Content-Type: application/json

Authorization: Bearer <your authorization token>

link

data_object JSON Payload

フィールド	種類	必須	説明
`email`	string	はい	問い合わせるメールアドレス
`country`	string	いいえ	ISO 3166 ALPHA-2 Country Code link
`locale`	string	いいえ	ブラウザーのロケール
`ip`	string	いいえ	有効な IPv4 または IPv6 アドレス
`id`	string	いいえ	最大 50 文字。任意の英数字の値を id として設定できるよ。たとえば、データベース内のデータセットに使っている社内の ID をそのまま設定することも可能。非同期環境では、この値を使うことで、レスポンスと以前のリクエストをより正確に結びつけられるよ

code リクエスト例

arrow_forward メールアドレスだけで問い合わせる

play_arrow Codepen.io でライブ実行

{
    "email": "theresa.miller14@gmail.com"
}

arrow_forward メールアドレスと国コードで問い合わせる

play_arrow Codepen.io でライブ実行

{
    "email": "thomas.clarks@hotmail.com",
    "country": "US"
}

arrow_forward メールアドレスとブラウザーのロケールで問い合わせる

play_arrow Codepen.io でライブ実行

{
    "email": "Thomas.j32@live.com",
    "locale": "en_US"
}

arrow_forward メールアドレスで照会し、IPアドレスを使ってローカライズする

play_arrow Codepen.io でライブ実行

{
    "email": "thomasfromnewyork@gmail.com",
    "ip": "54.201.16.177"
}

arrow_forward 1つのリクエストで複数の名前を照会

play_arrow Codepen.io でライブ実行

[
    {
        "email": "thomas.clarks@hotmail.com",
        "country": "US"
    },
    {
        "email": "theresa.miller14@gmail.com"
    }
]

check_circle レスポンス

{
    "input": {
        "email": "theresa.miller14@gmail.com"
    },
    "details": {
        "credits_used": 1,
        "duration": "12ms",
        "samples": 8961,
        "country": null,
        "first_name_sanitized": "theresa"
    },
    "result_found": true,
    "last_name": "Miller",
    "first_name": "Theresa",
    "probability": 0.98,
    "gender": "female"
}

list レスポンスフィールド

フィールド	種類	説明
`input`	object	送信したペイロード
`details.credits_used`	int	このクエリで消費されたリクエスト数
`details.samples`	int	あなたのリクエストに一致して、当社データベース内で見つかったレコード数
`details.country`	string	判定に使用した国
`details.email_sanitized`	int	当社の正規化処理を適用したあとの名前
`details.duration`	string	リクエストを処理するためにサーバーが必要とした時間
`result_found`	bool	指定された名前について性別を取得できた場合は true
`email`	string	性別推定に使用したメールアドレス
`probability`	float	この値（0〜1の範囲）は、当社データベースの信頼性を示しているよ。1 の場合、その性別判定結果が 100%% 正確であることを意味するよ。
`gender`	string	取り得る値: male, female, unknown