⚡ 統合API v2.0
上級者向け
APIドキュメント
大量リクエストにも対応した高性能な統合 API を体験しよう。複数の名前を 1 回のリクエストで問い合わせて、驚くほど高速なレスポンスを受け取れるよ。
ファーストネームで検索
これは、名前から性別を取得するいちばん簡単な方法です。すべてのレスポンスは JSON 形式で返されます
POST https://gender-api.com/v2/gender
必要なリクエスト数: 1
| Headers |
Content-Type: application/json
Authorization: Bearer <your authorization token>
|
||||||||||||||||||||||||
| JSON Payload |
|
リクエスト例
ファーストネームのみで検索
Codepen.io でライブ実行
{
"first_name": "Sandra"
}
ファーストネームと国コードで検索
Codepen.io でライブ実行
{
"first_name": "Sandra",
"country": "US"
}
ファーストネームとブラウザーのロケールで検索
Codepen.io でライブ実行
{
"first_name": "Sandra",
"locale": "en_US"
}
ファーストネームと IP アドレスを使ってローカライズ検索
Codepen.io でライブ実行
{
"first_name": "Sandra",
"ip": "54.201.16.177"
}
1つのリクエストで複数の名前を照会
Codepen.io でライブ実行
[
{
"first_name": "Sandra",
"country": "US"
},
{
"first_name": "Jason",
"country": "US"
}
]
レスポンス
{
"input": {
"first_name": "Sandra"
},
"details": {
"credits_used": 1,
"samples": 464,
"country": null,
"first_name_sanitized": "sandra",
"duration": "436ms"
},
"result_found": true,
"first_name": "Sandra",
"probability": 0.85,
"gender": "female"
}
レスポンスフィールド
| フィールド | 種類 | 説明 |
|---|---|---|
input |
object | 送信したペイロード |
details.credits_used |
int | このクエリで消費されたリクエスト数 |
details.samples |
int | あなたのリクエストに一致して、当社データベース内で見つかったレコード数 |
details.country |
string | 判定に使用した国 |
details.first_name_sanitized |
string | 当社の正規化処理を適用したあとの名前 |
details.duration |
string | リクエストを処理するためにサーバーが必要とした時間 |
result_found |
bool | 指定された名前について性別を取得できた場合は true |
first_name |
string | 性別判定に使用したファーストネーム |
probability |
float | この値(0〜1の範囲)は、当社データベースの信頼性を示しているよ。1 の場合、その性別判定結果が 100%% 正確であることを意味するよ。 |
gender |
string | 取り得る値: male, female, unknown |