メールアドレスから何が分かるのか 構文上有効なメールアドレスをtype: emailで送信します。GenderAPI.ioは@より前の部分から名前の手掛かりを探し、構造化された推定結果を返します。メールボックスの存在確認、所有者の特定、その人の性自認の判定は行いません。
データセットの照合では、アドレスの構成要素から候補を取り出し、範囲を限定した部分文字列も試すことがあります。ニックネームモードでは構成要素での照合は維持されますが、部分文字列による候補は追加されません。複数のレコードが一致した場合は、保存されている合計件数が最も多い候補が選ばれますが、それが意図した名であるとは限りません。抽出された名前を連絡先レコードに使う前に、data.nameとdata.matchを確認してください。
アプリケーションからメールアドレスのリクエストを送信する この例では、既存のAPIキーをBearer認証で使い、fallbackを明示しています。サンプルのアドレスは、処理が許可されている入力に置き換えてください。countryは関連するコンテキストがある場合にのみ指定します。メールアドレスのドメインは、その人の所在地を示すものではありません。国が分からない場合はこのフィールドを省略してください。
GENDERAPI_API_KEYを設定し、サーバー上で例を実行してください。POSTを使うと、メールアドレスはリクエストのURLに含まれません。実際の結果は、デモにある説明用のレスポンスと異なる場合があります。
プログラミング言語を選んでください。 APIキーを設定する 。次に、サーバー上で例を実行してください。
推定のリクエストは、再試行を含め、毎回新たに課金される処理です。これらの例は自動的に再試行しません。次のリクエストを送信する前に課金ステータスを確認してください。
実行する前に:アクセスとエラー処理 これらの例はサーバー上で実行してください。プロセスの環境変数GENDERAPI_API_KEY に既存のAPI キーを設定し、meta.access.mode がapi_key であることを確認します。認識されないキーはIPトライアルに切り替わることがあります。
HTTP 4xxと5xxのJSON レスポンスでは、例はエラーのボディをそのまま残し、0以外の終了ステータスで終了します。再試行する前にcode 、action 、meta.usage.billing_status を確認してください。
エラーと再試行のガイド → cURL JavaScript Python PHP Java C# / .NET Go
curl --silent --show-error --fail-with-body --max-time 30 \
--request POST 'https://api.genderapi.io/api/v2/gender' \
--header "Authorization: Bearer ${ GENDERAPI_API_KEY :? Set GENDERAPI_API_KEY }" \
--header 'Content-Type: application/json' \
--data '{
"type": "email",
"value": "alice.smith@example.com",
"country": "US",
"options": {
"ai_mode": "fallback"
}
}' POSIXシェルでcURL 7.76以上。 ターミナルで実行します。実行環境のドキュメント
// Server-side Node.js. Save as example.mjs.
const apiKey = process.env. GENDERAPI_API_KEY ;
if ( ! apiKey) throw new Error ( "Set GENDERAPI_API_KEY" );
const body = {
"type" : "email" ,
"value" : "alice.smith@example.com" ,
"country" : "US" ,
"options" : {
"ai_mode" : "fallback"
}
};
const response = await fetch ( "https://api.genderapi.io/api/v2/gender" , {
method: "POST" ,
headers: {
Authorization: `Bearer ${ apiKey }` ,
"Content-Type" : "application/json" ,
},
body: JSON . stringify (body),
signal: AbortSignal. timeout ( 30_000 ),
redirect: "error" ,
});
const raw = await response. text ();
if ( ! (response.headers. get ( "content-type" ) ?? "" ). includes ( "json" )) {
throw new Error ( `HTTP ${ response . status }: expected JSON; request ID ${ response . headers . get ( "x-request-id" ) }` );
}
const result = JSON . parse (raw); // Also accepts application/problem+json.
if ( ! response.ok) {
console. error ( `HTTP ${ response . status }` , result);
process.exitCode = 1 ; // A retry is a new operation; inspect billing first.
} else {
console. log ( JSON . stringify (result, null , 2 ));
// For batches, inspect every item: HTTP 200 may contain item errors.
} Node.js 22以上、組み込みのfetch。 example.mjsとして保存し、node example.mjsを実行します。実行環境のドキュメント
import json
import os
import sys
import urllib.error
import urllib.request
api_key = os.environ.get( "GENDERAPI_API_KEY" )
if not api_key:
raise RuntimeError ( "Set GENDERAPI_API_KEY" )
body = json.loads( "{ \" type \" : \" email \" , \" value \" : \" alice.smith@example.com \" , \" country \" : \" US \" , \" options \" :{ \" ai_mode \" : \" fallback \" }}" )
class NoRedirect ( urllib . request . HTTPRedirectHandler ):
def redirect_request (self, req, fp, code, msg, headers, newurl):
return None
request = urllib.request.Request(
"https://api.genderapi.io/api/v2/gender" ,
method = "POST" ,
data = json.dumps(body).encode( "utf-8" ),
headers = {
"Authorization" : "Bearer " + api_key,
"Content-Type" : "application/json" ,
},
)
opener = urllib.request.build_opener(NoRedirect())
try :
response = opener.open(request, timeout = 30 )
except urllib.error.HTTPError as error:
response = error # Keep the Problem Details body on non-2xx responses.
with response:
status = response.status
raw = response.read().decode( "utf-8" )
if "json" not in response.headers.get( "Content-Type" , "" ):
raise RuntimeError ( f "HTTP { status } : expected a JSON response" )
result = json.loads(raw)
print (json.dumps(result, indent = 2 ), file = sys.stderr if status >= 300 else sys.stdout)
if not 200 <= status < 300 :
sys.exit( 1 ) # Inspect code, action and billing before retrying.
# For batches, inspect every item even when HTTP status is 200. Python 3.10以上、標準ライブラリ。 example.pyとして保存し、python3 example.pyを実行します。実行環境のドキュメント
<? php
$apiKey = getenv ( 'GENDERAPI_API_KEY' );
if ( ! $apiKey) {
throw new RuntimeException ( 'Set GENDERAPI_API_KEY' );
}
$body = json_decode ( '{"type":"email","value":"alice.smith@example.com","country":"US","options":{"ai_mode":"fallback"}}' , true , 512 , JSON_THROW_ON_ERROR );
$ch = curl_init ( 'https://api.genderapi.io/api/v2/gender' );
curl_setopt_array ($ch, [
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_FOLLOWLOCATION => false ,
CURLOPT_TIMEOUT => 30 ,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $apiKey,
'Content-Type: application/json' ,
],
CURLOPT_POSTFIELDS => json_encode ($body, JSON_THROW_ON_ERROR ),
]);
$raw = curl_exec ($ch);
if ($raw === false ) {
throw new RuntimeException ( curl_error ($ch));
}
$status = curl_getinfo ($ch, CURLINFO_HTTP_CODE );
$contentType = curl_getinfo ($ch, CURLINFO_CONTENT_TYPE ) ?: '' ;
curl_close ($ch);
if ( strpos ($contentType, 'json' ) === false ) {
throw new RuntimeException ( "HTTP $status : expected a JSON response" );
}
$result = json_decode ($raw, true , 512 , JSON_THROW_ON_ERROR );
$output = json_encode ($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR ) . PHP_EOL ;
if ($status < 200 || $status >= 300 ) {
fwrite ( STDERR , $output); // Preserve the Problem Details body.
exit ( 1 );
}
echo $output;
// For batches, inspect every item; HTTP 200 can contain item errors. PHP 8以上とcURL拡張機能。 example.phpとして保存し、php example.phpを実行します。実行環境のドキュメント
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
public class GenderApiExample {
private static String requiredEnv (String name ) {
String value = System. getenv (name);
if (value == null || value. isBlank ()) throw new IllegalStateException ( "Set " + name);
return value;
}
public static void main ( String [] args ) throws Exception {
String apiKey = requiredEnv ( "GENDERAPI_API_KEY" );
String body = "{ \" type \" : \" email \" , \" value \" : \" alice.smith@example.com \" , \" country \" : \" US \" , \" options \" :{ \" ai_mode \" : \" fallback \" }}" ;
HttpClient client = HttpClient. newBuilder ()
. connectTimeout (Duration. ofSeconds ( 10 ))
. followRedirects (HttpClient.Redirect.NEVER)
. build ();
HttpRequest request = HttpRequest. newBuilder (URI. create ( "https://api.genderapi.io/api/v2/gender" ))
. timeout (Duration. ofSeconds ( 30 ))
. header ( "Authorization" , "Bearer " + apiKey)
. header ( "Content-Type" , "application/json" )
. POST (HttpRequest.BodyPublishers. ofString (body, StandardCharsets.UTF_8))
. build ();
HttpResponse < String > response = client. send (request,
HttpResponse.BodyHandlers. ofString (StandardCharsets.UTF_8));
if ( ! response. headers (). firstValue ( "content-type" ). orElse ( "" ). contains ( "json" )) {
throw new IllegalStateException ( "HTTP " + response. statusCode () + ": expected JSON" );
}
// JSON text; parse with your application's JSON library when integrating.
if (response. statusCode () < 200 || response. statusCode () >= 300 ) {
System.err. println (response. body ()); // Includes Problem Details.
System. exit ( 1 );
}
System.out. println (response. body ());
// For batches, inspect each item's data or error, including on HTTP 200.
}
} Java 17以上、標準のHTTPクライアント。 GenderApiExample.javaとして保存し、java GenderApiExample.javaを実行します。実行環境のドキュメント
using System ;
using System . Net . Http ;
using System . Net . Http . Headers ;
using System . Text ;
using System . Text . Json ;
string RequiredEnv ( string name ) =>
! string . IsNullOrWhiteSpace (Environment. GetEnvironmentVariable (name))
? Environment. GetEnvironmentVariable (name) !
: throw new InvalidOperationException ( $"Set { name } " );
var apiKey = RequiredEnv ( "GENDERAPI_API_KEY" );
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient (handler) { Timeout = TimeSpan. FromSeconds ( 30 ) };
using var request = new HttpRequestMessage (HttpMethod.Post, "https://api.genderapi.io/api/v2/gender" );
request.Headers.Authorization = new AuthenticationHeaderValue ( "Bearer" , apiKey);
request.Content = new StringContent ( "{ \" type \" : \" email \" , \" value \" : \" alice.smith@example.com \" , \" country \" : \" US \" , \" options \" :{ \" ai_mode \" : \" fallback \" }}" , Encoding.UTF8, "application/json" );
using var response = await client. SendAsync (request);
var raw = await response.Content. ReadAsStringAsync ();
if ( ! (response.Content.Headers.ContentType ? .MediaType ? . Contains ( "json" ) ?? false ))
throw new InvalidOperationException ( $"HTTP {( int ) response . StatusCode } : expected JSON" );
using var result = JsonDocument. Parse (raw);
if ( ! response.IsSuccessStatusCode)
{
Console.Error. WriteLine (result.RootElement); // Preserve Problem Details.
Environment.ExitCode = 1 ;
}
else
{
Console. WriteLine (result.RootElement);
// For batches, inspect every item even on HTTP 200.
} .NET 8以上のコンソールアプリケーション。 コンソールプロジェクトのProgram.csとして使用し、dotnet runを実行します。実行環境のドキュメント
package main
import (
" encoding/json "
" fmt "
" io "
" net/http "
" os "
" strings "
" time "
)
func requiredEnv ( name string ) string {
value := os. Getenv (name)
if value == "" { panic ( "Set " + name) }
return value
}
func run () error {
apiKey := requiredEnv ( "GENDERAPI_API_KEY" )
body := "{ \" type \" : \" email \" , \" value \" : \" alice.smith@example.com \" , \" country \" : \" US \" , \" options \" :{ \" ai_mode \" : \" fallback \" }}"
request, err := http. NewRequest ( "POST" , "https://api.genderapi.io/api/v2/gender" , strings. NewReader (body))
if err != nil { return err }
request.Header. Set ( "Authorization" , "Bearer " + apiKey)
request.Header. Set ( "Content-Type" , "application/json" )
client := & http . Client {
Timeout: 30 * time.Second,
CheckRedirect: func ( req * http . Request , via [] * http . Request ) error {
return http.ErrUseLastResponse
},
}
response, err := client. Do (request)
if err != nil { return err }
defer response.Body. Close ()
raw, err := io. ReadAll (response.Body)
if err != nil { return err }
if ! strings. Contains (response.Header. Get ( "Content-Type" ), "json" ) || ! json. Valid (raw) {
return fmt. Errorf ( "HTTP %d : expected a JSON response" , response.StatusCode)
}
if response.StatusCode < 200 || response.StatusCode >= 300 {
return fmt. Errorf ( "HTTP %d : %s " , response.StatusCode, raw)
}
fmt. Println ( string (raw))
// For batches, inspect every item even on HTTP 200.
return nil
}
func main () {
if err := run (); err != nil {
fmt. Fprintln (os.Stderr, err) // Keep Problem Details for error handling.
os. Exit ( 1 )
}
} Go 1.22以上、標準ライブラリ。 main.goとして保存し、go run main.goを実行します。実行環境のドキュメント
結果とその根拠をあわせて保存する 推定された関連付けは、本人が申告した性別ではありません。元の入力、返された根拠、本人から提供された情報は分けて保存してください。不明な結果は有効な結果であり、アプリケーション内で推測によるカテゴリーに置き換えるべきではありません。
AIを使うタイミングを選ぶ forceToGenderizeは、名前、メールアドレス、ユーザー名のいずれでも任意で使用できます。有効にする場合は、ai_modeを省略するかfallbackを使用してください。offとalwaysは併用できず、422が返ります。最終的な課金で残高がマイナスになる場合でも、開始時の残高がプラスであればリクエストを開始できます。
ニックネームモードでは、name: nullのまま性別が返ることがあります。不明な結果になることもあります。通常のフォールバックもニックネームの推定も、正しい回答やnullでない回答を保証するものではありません。
メールアドレスのリストをバッチで処理する type: emailの項目を並べたitems配列をPOST /api/v2/gender/batchに送信します。登録済みのAPIキーでは最大50項目、IPトライアルでは最大10項目です。結果を元の行に対応付けられるよう、各項目に一意のidを付けてください。レスポンスも入力の順序を保ち、indexを返します。
バッチの項目はデフォルトでデータセットのみを使用します。通常のAIフォールバックが必要な項目には、それぞれoptions.ai_mode: fallbackを設定してください。fallbackで成功した2項目は、不明な結果を含めて合計2クレジットです。1回のHTTPリクエストが1回分の推定クレジットになるわけではありません。
バッチがHTTP 200を返した場合でも、すべての項目を確認してください。成功した結果と不明な結果を保存し、エラーと確定した課金を確認してから、失敗した項目を再送します。タイムアウトの後に、課金結果を確認しないまま成功したバッチ全体を再送しないでください。
よくある質問 APIはメールアドレスから名を抽出できますか? ローカル部分に利用できる手掛かりがあれば、名前の候補を返せます。構成要素での一致も部分文字列での一致もありうるため、data.matchを確認してください。この結果は、メールボックスの所有者の名を証明するものではありません。
info@やsupport@のようなアドレスでも性別は返りますか? 共有の役割アドレスには、通常、個人名の根拠がありません。不明な結果は有効な結果です。AIやニックネームモードの結果を、共有の受信箱を使う人たちの確認として扱わないでください。
メールアドレスの結果が不明でもクレジットを消費しますか? はい。成功した通常のメールアドレスの検索は、フォールバックや不明な結果を含めて1クレジットです。ニックネームの強制推定は、データセットで推定できた場合は1クレジット、AIを使った場合は合計2クレジットです。エラーの場合の課金結果は、meta.usageで別途示されます。
AIで処理する前に、メールアドレスのドメインは取り除かれますか? そのような除去は約束していません。データセットの候補はローカル部分から作られますが、AIは送信された値そのものを受け取り、ドメインと+以降のサフィックスを無視するよう指示されます。ワークフローで必要な場合は、データセットのみのモードを使用してください。