APIドキュメント
大量リクエストにも対応した高性能な統合 API を体験しよう。複数の名前を 1 回のリクエストで問い合わせて、驚くほど高速なレスポンスを受け取れるよ。
登録する
無料アカウントを作成して、たった1回の呼び出しでAPIトークンを取得しよう。名前の登録は不要 — AIエージェントに最適。
- 無料プラン
- 認証なし
- インスタントAPIトークン
名からのクエリ
名(ファーストネーム)から性別を判定。オプションで国情報を指定して、さらに高精度な結果を得られるよ。
- バッチ処理
- 国別ローカライズ
- 高精度
フルネームで照会
フルネームを自動で分割し、1回の効率的なAPIコールで性別を判定
- 自動ネームスプリット
- 複数の名前
- スマート検出
メールアドレスで照会
メールアドレスから名前を抽出し、高度な解析アルゴリズムで性別を判定。
- メール解析
- 名前抽出
- 一括処理
出身国を取得
名前にもとづいて、考えられる出身国や民族的ルーツを推定。
- 国の検出
- 民族データ
- 名前の意味
統計を取得
アカウントの詳細な利用統計と、残りのリクエストクレジットを取得しよう。
- 利用状況の追跡
- クレジット残高
- リアルタイムデータ
エラーコード
デバッグ用のすべてのAPIエラーコードとステータスレスポンスの完全リファレンス。
- エラーリファレンス
- ステータスコード
- デバッグヘルプ
API v1.0 シンプル
統合しやすいエンドポイントを備えた、別バージョンのAPIも用意しているよ。API実装が初めてなら、v1.0エンドポイントに切り替えるのがおすすめ。
API v1.0 を見るAIエージェント&LLM(大規模言語モデル) 翻訳する原文が見当たらないよ。「PROMPT-READY」だけだと内容がないので、翻訳したいテキスト(「;;」で区切られた文字列も含めて)をそのまま貼り付けて送ってね
ChatGPT、Claude などのLLMでツールを作ってる?AIがそのまま読み取れるように最適化した、事前整形済みのインストラクションファイルを用意してるよ。AIエージェントに私たちのスキルファイルを参照させれば、Gender-API をどう組み込めばいいか直感的に理解して、すぐに連携できる。
無料アカウントに登録する
無料アカウント(毎月100リクエスト)を作成して、認証なしの1回の呼び出しだけでAPIトークンを受け取ろう。名も姓も不要。これはAIエージェントがユーザーをオンボーディングするときに最適だよ。ユーザーにメールアドレスと同意を確認してから、リクエストを送信してね。アカウントは最初は未確認の状態で作成され、ユーザーがメールで届く有効化リンクをクリックすると確認完了。その後、返されるAPIトークンはすぐに使えるようになる。
POST https://gender-api.com/v2/sign-up
| Headers |
Content-Type: application/json
|
||||||||||||||||||||
| JSON Payload |
|
リクエスト例
{
"email": "user@example.com",
"accept_terms": true
}
{
"email": "user@example.com",
"accept_terms": true,
"newsletter": true,
"locale": "en"
}
レスポンス
{
"email": "user@example.com",
"password": "",
"api_token": "",
"free_requests_per_month": 100,
"status": "awaiting_activation",
"message": "Account created. Ask the user to click the activation link sent to their email address. The API token below activates automatically once the email is confirmed and can then be used as a Bearer token against the API.",
"docs_url": "https://gender-api.com/skill.md"
}
レスポンスフィールド
| フィールド | 種類 | 説明 |
|---|---|---|
email |
string | 登録済みのメールアドレス。 |
password |
string | ウェブダッシュボード用のランダムなログインパスワード。返されるのは1回だけなので、安全な場所に保管してね。あとで「パスワードを忘れた」からリセットできるよ。 |
api_token |
string | APIのBearerトークン。「Authorization: Bearer |
free_requests_per_month |
int | 毎月付与される無料リクエスト数。 |
status |
string | アカウントのステータス。「awaiting_activation」は、メールアドレスの確認が完了するまで表示されます。 |
message |
string | 次のステップ(メールアドレスの確認)についての、わかりやすい案内文。 |
docs_url |
string | すぐ使えるAI実装手順(skill.md)へのリンク。 |
ファーストネームで検索
これは、名前から性別を取得するいちばん簡単な方法です。すべてのレスポンスは JSON 形式で返されます
POST https://gender-api.com/v2/gender
| Headers |
Content-Type: application/json
Authorization: Bearer <your authorization token>
|
||||||||||||||||||||||||
| JSON Payload |
|
リクエスト例
{
"first_name": "Sandra"
}
{
"first_name": "Sandra",
"country": "US"
}
{
"first_name": "Sandra",
"locale": "en_US"
}
{
"first_name": "Sandra",
"ip": "54.201.16.177"
}
[
{
"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 |
フルネームで照会 - 名と姓を分割
ページ上で名と姓を 1 つのフィールドにまとめている場合、この API を使ってそれぞれを抽出できるよ
POST https://gender-api.com/v2/gender
| Headers |
Content-Type: application/json
Authorization: Bearer <your authorization token>
|
||||||||||||||||||||||||
| JSON Payload |
|
リクエスト例
{
"full_name": "Theresa Miller"
}
{
"full_name": "Theresa Miller",
"country": "US"
}
{
"full_name": "Thomas Johnson",
"locale": "en_US"
}
{
"full_name": "Markus Stefan NonExistingLastName",
"ip": "54.201.16.177"
}
[
{
"full_name": "Theresa Miller"
},
{
"full_name": "Thomas Johnson",
"country": "US"
}
]
レスポンス
{
"input": {
"full_name": "Theresa Miller"
},
"details": {
"credits_used": 1,
"duration": "33ms",
"samples": 8961,
"country": null,
"first_name_sanitized": "theresa"
},
"result_found": true,
"last_name": "Miller",
"first_name": "Theresa",
"probability": 0.98,
"gender": "female"
}
レスポンスフィールド
| フィールド | 種類 | 説明 |
|---|---|---|
input |
object | 送信したペイロード |
details.credits_used |
int | このクエリで消費されたリクエスト数 |
details.samples |
int | あなたのリクエストに一致して、当社データベース内で見つかったレコード数 |
details.country |
string | 判定に使用した国 |
details.full_name_sanitized |
int | 当社の正規化処理を適用したあとの名前 |
details.duration |
string | リクエストを処理するためにサーバーが必要とした時間 |
result_found |
bool | 指定された名前について性別を取得できた場合は true |
full_name |
string | 性別判定に使用したフルネーム |
probability |
float | この値(0〜1の範囲)は、当社データベースの信頼性を示しているよ。1 の場合、その性別判定結果が 100%% 正確であることを意味するよ。 |
gender |
string | 取り得る値: male, female, unknown |
メールアドレスで問い合わせる
メールアドレスに含まれる情報を使って、性別を判定することもできます
POST https://gender-api.com/v2/gender
| Headers |
Content-Type: application/json
Authorization: Bearer <your authorization token>
|
||||||||||||||||||||||||
| JSON Payload |
|
リクエスト例
{
"email": "theresa.miller14@gmail.com"
}
{
"email": "thomas.clarks@hotmail.com",
"country": "US"
}
{
"email": "Thomas.j32@live.com",
"locale": "en_US"
}
{
"email": "thomasfromnewyork@gmail.com",
"ip": "54.201.16.177"
}
[
{
"email": "thomas.clarks@hotmail.com",
"country": "US"
},
{
"email": "theresa.miller14@gmail.com"
}
]
レスポンス
{
"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"
}
レスポンスフィールド
| フィールド | 種類 | 説明 |
|---|---|---|
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 |
出身国を取得
名前の出身国を取得:
POST https://gender-api.com/v2/country-of-origin
| Headers |
Content-Type: application/json
Authorization: Bearer <your authorization token>
|
||||||||||||||||||||
| JSON Payload |
|
リクエスト例
{
"first_name": "Johann"
}
{
"full_name": "Theresa Miller"
}
{
"full_name": "sophia5342@gmail.com"
}
レスポンス
{
"input": {
"first_name": "Johann",
"id": 12
},
"details": {
"credits_used": 2,
"duration": "414ms",
"samples": 890,
"country": null,
"first_name_sanitized": "johann"
},
"result_found": true,
"country_of_origin": [
{
"country_name": "Germany",
"country": "DE",
"probability": 0.52,
"continental_region": "Europe",
"statistical_region": "Western Europe"
},
{
"country_name": "Austria",
"country": "AT",
"probability": 0.48,
"continental_region": "Europe",
"statistical_region": "Western Europe"
}
],
"first_name": "Johann",
"probability": 0.9,
"gender": "male",
"language_of_origin": "Germanic",
"meaning": "Johann is the German variation of the name John, which means 'God is gracious'. It was frequently used in the Middle Ages across Europe, particularly as a name for religious figures.",
"ethnicity": {
"id": "GERMANIC",
"name": "Germanic (German, Austrian, Swiss)",
"distribution": [
{
"id": "GERMANIC",
"name": "Germanic (German, Austrian, Swiss)",
"percentage": 90
},
{
"id": "DUTCH",
"name": "Dutch",
"percentage": 5
},
{
"id": "FRENCH",
"name": "French",
"percentage": 5
}
]
}
}
レスポンスフィールド
| フィールド | 種類 | 説明 |
|---|---|---|
input |
object | 送信したペイロード |
details.credits_used |
int | このクエリで消費されたリクエスト数 |
details.samples |
int | あなたのリクエストに一致して、当社データベース内で見つかったレコード数 |
details.country |
string | 判定に使用した国 |
details.first_name_sanitized |
string | 当社の正規化処理を適用したあとの名前 |
details.duration |
string | リクエストを処理するためにサーバーが必要とした時間 |
result_found |
bool | 指定された名前について性別を取得できた場合は true |
country_of_origin_map_url |
string | この名前に関するインタラクティブマップへのURL |
first_name |
string | 性別判定に使用したファーストネーム |
probability |
float | この値(0〜1の間)は、当社データベースの信頼性を示します。値が1の場合、この名前の性別判定結果は100%%正確であることを意味します |
gender |
string | 取り得る値: male, female, unknown |
country_of_origin |
object | 出身国トップ25件。「Complete List Of Possible Countries」で、サポートされている国の一覧を確認できます。各レコードには country_name、country、probability、continental_region、statistical_region フィールドが含まれます |
language_of_origin |
string | この名前の由来となる言語 |
meaning |
string | この名前の意味についての短い説明 |
ethnicity |
object | ethnicity フィールドには、その名前に主に関連する主要な民族グループと、さまざまな民族グループ間での名前の分布に関する詳細が含まれます |
ethnicity.id |
string | id フィールドには、判定された主要民族グループの識別子が含まれます。利用可能な民族グループの完全な一覧は「Complete List Of Possible Ethnic Groups」を参照してください |
ethnicity.name |
string | name フィールドには、判定された主要民族グループの名称が含まれます。利用可能な民族グループの完全な一覧は「Complete List Of Possible Ethnic Groups」を参照してください |
ethnicity.distribution |
array | Distribution フィールドには、各民族グループにおけるその名前の割合に関する情報が含まれます。各配列エントリには id(string)、name(string)、percentage(float)フィールドが含まれます。取りうる値の完全な一覧は「Complete List Of Possible Ethnic Groups」を参照してください |
| 国コード | 国名 | 統計地域 | 大陸地域 |
|---|---|---|---|
| CN | China | Eastern Asia | Asia |
| IN | India | Southern Asia | Asia |
| US | United States | Northern America | Americas |
| ID | Indonesia | South-eastern Asia | Asia |
| BR | Brazil | South America | Americas |
| PK | Pakistan | Southern Asia | Asia |
| NG | Nigeria | Western Africa | Africa |
| BD | Bangladesh | Southern Asia | Asia |
| RU | Russia | Eastern Europe | Europe |
| MX | Mexico | Central America | Americas |
| JP | Japan | Eastern Asia | Asia |
| ET | Ethiopia | Eastern Africa | Africa |
| PH | Philippines | South-eastern Asia | Asia |
| EG | Egypt | Northern Africa | Africa |
| VN | Vietnam | South-eastern Asia | Asia |
| DE | Germany | Western Europe | Europe |
| CD | Democratic Republic of the Congo | Middle Africa | Africa |
| IR | Iran | Southern Asia | Asia |
| TR | Turkey | Western Asia | Asia |
| TH | Thailand | South-eastern Asia | Asia |
| GB | United Kingdom | Northern Europe | Europe |
| FR | France | Western Europe | Europe |
| IT | Italy | Southern Europe | Europe |
| TZ | Tanzania | Eastern Africa | Africa |
| ZA | South Africa | Southern Africa | Africa |
| MM | Myanmar | South-eastern Asia | Asia |
| KR | South Korea | Eastern Asia | Asia |
| CO | Colombia | South America | Americas |
| KE | Kenya | Eastern Africa | Africa |
| ES | Spain | Southern Europe | Europe |
| AR | Argentina | South America | Americas |
| UA | Ukraine | Eastern Europe | Europe |
| UG | Uganda | Eastern Africa | Africa |
| DZ | Algeria | Northern Africa | Africa |
| SD | Sudan | Northern Africa | Africa |
| IQ | Iraq | Western Asia | Asia |
| PL | Poland | Eastern Europe | Europe |
| CA | Canada | Northern America | Americas |
| MA | Morocco | Northern Africa | Africa |
| AF | Afghanistan | Southern Asia | Asia |
| SA | Saudi Arabia | Western Asia | Asia |
| PE | Peru | South America | Americas |
| VE | Venezuela | South America | Americas |
| UZ | Uzbekistan | Central Asia | Asia |
| MY | Malaysia | South-eastern Asia | Asia |
| AO | Angola | Middle Africa | Africa |
| MZ | Mozambique | Eastern Africa | Africa |
| NP | Nepal | Southern Asia | Asia |
| GH | Ghana | Western Africa | Africa |
| YE | Yemen | Western Asia | Asia |
| MG | Madagascar | Eastern Africa | Africa |
| KP | North Korea | Eastern Asia | Asia |
| AU | Australia | AustraliaandNew Zealand | Oceania |
| CI | Ivory Coast | Western Africa | Africa |
| CM | Cameroon | Middle Africa | Africa |
| TW | Taiwan | Eastern Asia | Asia |
| NE | Niger | Western Africa | Africa |
| LK | Sri Lanka | Southern Asia | Asia |
| RO | Romania | Eastern Europe | Europe |
| BF | Burkina Faso | Western Africa | Africa |
| MW | Malawi | Eastern Africa | Africa |
| ML | Mali | Western Africa | Africa |
| SY | Syria | Western Asia | Asia |
| KZ | Kazakhstan | Central Asia | Asia |
| CL | Chile | South America | Americas |
| ZM | Zambia | Eastern Africa | Africa |
| NL | Netherlands | Western Europe | Europe |
| GT | Guatemala | Central America | Americas |
| EC | Ecuador | South America | Americas |
| ZW | Zimbabwe | Eastern Africa | Africa |
| KH | Cambodia | South-eastern Asia | Asia |
| SN | Senegal | Western Africa | Africa |
| TD | Chad | Middle Africa | Africa |
| SO | Somalia | Eastern Africa | Africa |
| GN | Guinea | Western Africa | Africa |
| SD | Sudan | Northern Africa | Africa |
| RW | Rwanda | Eastern Africa | Africa |
| TN | Tunisia | Northern Africa | Africa |
| CU | Cuba | Caribbean | Americas |
| BE | Belgium | Western Europe | Europe |
| BJ | Benin | Western Africa | Africa |
| GR | Greece | Southern Europe | Europe |
| BO | Bolivia | South America | Americas |
| HT | Haiti | Caribbean | Americas |
| BI | Burundi | Eastern Africa | Africa |
| DO | Dominican Republic | Caribbean | Americas |
| CZ | Czech Republic | Eastern Europe | Europe |
| PT | Portugal | Southern Europe | Europe |
| SE | Sweden | Northern Europe | Europe |
| AZ | Azerbaijan | Western Asia | Asia |
| HU | Hungary | Eastern Europe | Europe |
| JO | Jordan | Western Asia | Asia |
| BY | Belarus | Eastern Europe | Europe |
| AE | United Arab Emirates | Western Asia | Asia |
| HN | Honduras | Central America | Americas |
| TJ | Tajikistan | Central Asia | Asia |
| RS | Serbia | Southern Europe | Europe |
| AT | Austria | Western Europe | Europe |
| CH | Switzerland | Western Europe | Europe |
| IL | Israel | Western Asia | Asia |
| PG | Papua New Guinea | Melanesia | Oceania |
| TG | Togo | Western Africa | Africa |
| SL | Sierra Leone | Western Africa | Africa |
| HK | Hong Kong | Eastern Asia | Asia |
| BG | Bulgaria | Eastern Europe | Europe |
| LA | Laos | South-eastern Asia | Asia |
| PY | Paraguay | South America | Americas |
| SV | El Salvador | Central America | Americas |
| LY | Libya | Northern Africa | Africa |
| NI | Nicaragua | Central America | Americas |
| LB | Lebanon | Western Asia | Asia |
| KG | Kyrgyzstan | Central Asia | Asia |
| TM | Turkmenistan | Central Asia | Asia |
| DK | Denmark | Northern Europe | Europe |
| SG | Singapore | South-eastern Asia | Asia |
| FI | Finland | Northern Europe | Europe |
| SK | Slovakia | Eastern Europe | Europe |
| NO | Norway | Northern Europe | Europe |
| CG | Congo | Middle Africa | Africa |
| ER | Eritrea | Eastern Africa | Africa |
| PS | Palestine | Western Asia | Asia |
| CR | Costa Rica | Central America | Americas |
| IE | Ireland | Northern Europe | Europe |
| LR | Liberia | Western Africa | Africa |
| NZ | New Zealand | AustraliaandNew Zealand | Oceania |
| CF | Central African Republic | Middle Africa | Africa |
| OM | Oman | Western Asia | Asia |
| MR | Mauritania | Western Africa | Africa |
| HR | Croatia | Southern Europe | Europe |
| KW | Kuwait | Western Asia | Asia |
| PA | Panama | Central America | Americas |
| MD | Moldova | Eastern Europe | Europe |
| GE | Georgia | Western Asia | Asia |
| PR | Puerto Rico | Caribbean | Americas |
| BA | Bosnia and Herzegovina | Southern Europe | Europe |
| UY | Uruguay | South America | Americas |
| MN | Mongolia | Eastern Asia | Asia |
| AM | Armenia | Western Asia | Asia |
| AL | Albania | Southern Europe | Europe |
| JM | Jamaica | Caribbean | Americas |
| LT | Lithuania | Northern Europe | Europe |
| QA | Qatar | Western Asia | Asia |
| NA | Namibia | Southern Africa | Africa |
| BW | Botswana | Southern Africa | Africa |
| LS | Lesotho | Southern Africa | Africa |
| GM | The Gambia | Western Africa | Africa |
| MK | Republic of Macedonia | Southern Europe | Europe |
| SI | Slovenia | Southern Europe | Europe |
| GA | Gabon | Middle Africa | Africa |
| LV | Latvia | Northern Europe | Europe |
| GW | Guinea-Bissau | Western Africa | Africa |
| BH | Bahrain | Western Asia | Asia |
| TT | Trinidad and Tobago | Caribbean | Americas |
| SZ | Swaziland | Southern Africa | Africa |
| EE | Estonia | Northern Europe | Europe |
| TL | East Timor | South-eastern Asia | Asia |
| GQ | Equatorial Guinea | Middle Africa | Africa |
| MU | Mauritius | Eastern Africa | Africa |
| CY | Cyprus | Western Asia | Asia |
| DJ | Djibouti | Eastern Africa | Africa |
| FJ | Fiji | Melanesia | Oceania |
| RE | Réunion | Eastern Africa | Africa |
| KM | Comoros | Eastern Africa | Africa |
| BT | Bhutan | Southern Asia | Asia |
| GY | Guyana | South America | Americas |
| ME | Montenegro | Southern Europe | Europe |
| MO | Macau | Eastern Asia | Asia |
| SB | Solomon Islands | Melanesia | Oceania |
| LU | Luxembourg | Western Europe | Europe |
| SR | Suriname | South America | Americas |
| EH | Western Sahara | Northern Africa | Africa |
| CV | Cape Verde | Western Africa | Africa |
| GP | Guadeloupe | Caribbean | Americas |
| MV | Maldives | Southern Asia | Asia |
| MT | Malta | Southern Europe | Europe |
| BN | Brunei | South-eastern Asia | Asia |
| BS | Bahamas | Caribbean | Americas |
| MQ | Martinique | Caribbean | Americas |
| BZ | Belize | Central America | Americas |
| IS | Iceland | Northern Europe | Europe |
| BB | Barbados | Caribbean | Americas |
| PF | French Polynesia | Polynesia | Oceania |
| GF | French Guiana | South America | Americas |
| NC | New Caledonia | Melanesia | Oceania |
| VU | Vanuatu | Melanesia | Oceania |
| YT | Mayotte | Eastern Africa | Africa |
| ST | Sao Tome and Principe | Middle Africa | Africa |
| WS | Samoa | Polynesia | Oceania |
| LC | Saint Lucia | Caribbean | Americas |
| JE | Guernsey and Jersey | Northern Europe | Europe |
| GU | Guam | Micronesia | Oceania |
| CW | Curaçao | Caribbean | Americas |
| KI | Kiribati | Micronesia | Oceania |
| VC | Saint Vincent and the Grenadines | Caribbean | Americas |
| TO | Tonga | Polynesia | Oceania |
| GD | Grenada | Caribbean | Americas |
| FM | Federated States of Micronesia | Micronesia | Oceania |
| AW | Aruba | Caribbean | Americas |
| VI | United States Virgin Islands | Caribbean | Americas |
| AG | Antigua and Barbuda | Caribbean | Americas |
| SC | Seychelles | Eastern Africa | Africa |
| IM | Isle of Man | Northern Europe | Europe |
| AD | Andorra | Southern Europe | Europe |
| DM | Dominica | Caribbean | Americas |
| KY | Cayman Islands | Caribbean | Americas |
| BM | Bermuda | Northern America | Americas |
| GL | Greenland | Northern America | Americas |
| AS | American Samoa | Polynesia | Oceania |
| KN | Saint Kitts and Nevis | Caribbean | Americas |
| MP | Northern Mariana Islands | Micronesia | Oceania |
| MH | Marshall Islands | Micronesia | Oceania |
| FO | Faroe Islands | Northern Europe | Europe |
| SX | Sint Maarten | Caribbean | Americas |
| MC | Monaco | Western Europe | Europe |
| LI | Liechtenstein | Western Europe | Europe |
| TC | Turks and Caicos Islands | Caribbean | Americas |
| GI | Gibraltar | Southern Europe | Europe |
| SM | San Marino | Southern Europe | Europe |
| VG | British Virgin Islands | Caribbean | Americas |
| BQ | Caribbean Netherlands | Caribbean | Americas |
| PW | Palau | Micronesia | Oceania |
| CK | Cook Islands | Polynesia | Oceania |
| AI | Anguilla | Caribbean | Americas |
| WF | Wallis and Futuna | Polynesia | Oceania |
| NR | Nauru | Micronesia | Oceania |
| TV | Tuvalu | Polynesia | Oceania |
| PM | Saint Pierre and Miquelon | Northern America | Americas |
| MS | Montserrat | Caribbean | Americas |
| SH | Saint Helena Ascension and Tristan da Cunha | Western Africa | Africa |
| FK | Falkland Islands | South America | Americas |
| NU | Niue | Polynesia | Oceania |
| TK | Tokelau | Polynesia | Oceania |
| VA | Vatican City | Southern Europe | Europe |
| ID | 名前 |
|---|---|
| GERMANIC | Germanic (German, Austrian, Swiss) |
| SCANDINAVIAN | Scandinavian (Swedish, Norwegian, Danish, Finnish) |
| ENGLISH | English |
| DUTCH | Dutch |
| HUNGARIAN | Hungarian |
| ESTONIAN | Estonian |
| LATVIAN | Latvian |
| LITHUANIAN | Lithuanian |
| SLOVENIAN | Slovenian |
| CROATIAN | Croatian |
| SERBIAN | Serbian |
| BOSNIAN | Bosnian |
| MACEDONIAN | Macedonian |
| BULGARIAN | Bulgarian |
| ROMANIAN | Romanian |
| POLISH | Polish |
| SLOVAK | Slovak |
| CZECH | Czech |
| RUSSIAN | Russian |
| UKRAINIAN | Ukrainian |
| BELARUSIAN | Belarusian |
| ICELANDIC | Icelandic |
| FAROESE | Faroese |
| SCOTTISH | Scottish |
| IRISH | Irish |
| WELSH | Welsh |
| ITALIAN | Italian |
| SPANISH | Spanish |
| PORTUGUESE | Portuguese |
| FRENCH | French |
| GREEK | Greek |
| TURKISH | Turkish |
| ARMENIAN | Armenian |
| GEORGIAN | Georgian |
| ALBANIAN | Albanian |
| KURDISH | Kurdish |
| PERSIAN | Persian |
| ARAB | Arab (Various Arabic-speaking countries) |
| HEBREW | Hebrew |
| INDIAN | Indian |
| PAKISTANI | Pakistani |
| BANGLADESHI | Bangladeshi |
| SRI_LANKAN | Sri Lankan |
| NEPALI | Nepali |
| BHUTANESE | Bhutanese |
| TIBETAN | Tibetan |
| CHINESE | Chinese |
| JAPANESE | Japanese |
| KOREAN | Korean |
| VIETNAMESE | Vietnamese |
| THAI | Thai |
| MALAYSIAN | Malaysian |
| INDONESIAN | Indonesian |
| FILIPINO | Filipino |
| AUSTRALIAN_ABORIGINAL | Australian Aboriginal |
| MAORI | Maori (New Zealand) |
| NATIVE_AMERICAN | Native American (various tribes in North and South America) |
| INUIT | Inuit (Arctic regions) |
| AFRICAN | African ethnic groups (various countries and tribes) |
| PACIFIC_ISLANDER | Pacific Islander (various islands and cultures) |
統計情報を取得
このコールで、自分のアカウントに関する各種統計情報を取得できるよ:
GET https://gender-api.com/v2/statistic
| Headers |
Content-Type: application/json
Authorization: Bearer <your authorization token>
|
レスポンス
{
"is_limit_reached": false,
"remaining_credits": 24999,
"details": {
"credits_used": 0,
"duration": "83ms"
},
"usage_last_month": {
"date": "2018-03",
"credits_used": 25
}
}
レスポンスフィールド
| フィールド | 種類 | 説明 |
|---|---|---|
is_limit_reached |
bool | リクエストの残り回数がない場合に true を返します |
remaining_credits |
int | 残りのリクエスト数 |
details.credits_used |
int | このクエリで消費されたリクエスト数 |
details.duration |
string | リクエストを処理するためにサーバーが必要とした時間 |
usage_last_month.date |
string | 前月の日付 |
usage_last_month.credits_used |
int | 過去1か月間に使用したリクエスト数 |
エラーコード
| Status | endpoint-not-found |
| HTTP Status Code | 404 |
| Description | API endpoint not found |
| Status | limit-exceeded |
| HTTP Status Code | 401 |
| Description | Limit exceeded. Thank you for using our service. Please consider to buy more requests. |
| Status | parameter-first-name-invalid |
| HTTP Status Code | 400 |
| Description | The "first_name" parameter is invalid. The parameter can only be a string with a length from 1 to 50 chars. |
| Status | parameter-full-name-invalid |
| HTTP Status Code | 400 |
| Description | The "full_name" parameter is invalid. The parameter can only be a string with a length from 1 to 100 chars. |
| Status | parameter-email-invalid |
| HTTP Status Code | 400 |
| Description | The "email" parameter is invalid. The parameter can only be a string with a length from 3 to 100 chars and must be a valid email address. |
| Status | key-parameter-missing |
| HTTP Status Code | 400 |
| Description | The "key" parameter is not set. Please create an account to fetch an API key. |
| Status | invalid-key |
| HTTP Status Code | 400 |
| Description | Invalid API key. You can find your personal API key in your account. |
| Status | invalid-country-code |
| HTTP Status Code | 400 |
| Description | The given country code is not valid. You can find a list of valid country codes in our API docs. |
| Status | invalid-ip-address |
| HTTP Status Code | 400 |
| Description | The given ip address is not valid. Please provide either a valid IPv4 or an IPv6 address. |
| Status | generic-error |
| HTTP Status Code | 400 |
| Description |
| Status | invalid-json |
| HTTP Status Code | 400 |
| Description |
| Status | invalid-locale |
| HTTP Status Code | 400 |
| Description | The given locale is not valid. You can find a list of valid country codes in our API docs. |
| Status | invalid-id |
| HTTP Status Code | 400 |
| Description | The given id is not valid. An id can be either an integer or a string with 50 chars at max. |
| Status | mandatory-parameter-missing |
| HTTP Status Code | 400 |
| Description | Mandatory parameter missing. Either first_name, full_name or email must be set. |
| Status | content-type-missing |
| HTTP Status Code | 400 |
| Description | Content-Type missing. Please add a "Content-Type: application/json" to your API call. |
| Status | missing-json |
| HTTP Status Code | 400 |
| Description | We weren't able to find a json body in your API call. Please make sure the body is sent with a POST request to our API endpoint. |
| Status | too-many-queries |
| HTTP Status Code | 400 |
| Description | Too many queries in a single API call. |
| Status | too-many-queries-api-key |
| HTTP Status Code | 400 |
| Description | Too many queries in a single API call. Your API key is limited to 3 lookups per request. |
| Status | authorization-header-missing |
| HTTP Status Code | 400 |
| Description | Your query misses the "Authorization" header with the bearer token. |
| Status | invalid-auth-token |
| HTTP Status Code | 400 |
| Description | Invalid authentication token provided. Please log in to your account to find a list of valid tokens or to create a new one. |
| Status | email-invalid |
| HTTP Status Code | 400 |
| Description | Invalid or empty email address given. |
| Status | password-invalid |
| HTTP Status Code | 400 |
| Description | Invalid credentials. Login failed. Please also check your account that third-party app access is not restricted.: https://gender-api.com/de/account/password |
| Status | label-invalid |
| HTTP Status Code | 400 |
| Description | Invalid label given. A label must be a string between 2 and 30 chars. |
| Status | email-account-not-found |
| HTTP Status Code | 400 |
| Description | No Gender-API.com account found. Please create a free account first, to sign-in with Google or try to login with an existing username or password. |
| Status | invalid-list-of-names |
| HTTP Status Code | 400 |
| Description | Invalid list of names. Expected array of strings. |
| Status | terms-not-accepted |
| HTTP Status Code | 400 |
| Description | You must accept the Terms and Conditions and Privacy Policy to sign up. Please set "accept_terms" to true. |
| Status | email-already-registered |
| HTTP Status Code | 400 |
| Description | An account with this email address already exists. Please log in or reset your password at https://gender-api.com/en/account/password instead of signing up again. |
| Status | signup-rate-limit |
| HTTP Status Code | 429 |
| Description | Too many sign-up attempts from your network. Please try again later. |
| Status | signup-email-rejected |
| HTTP Status Code | 400 |
| Description | This email address cannot be used to sign up. Please use a different, non-disposable email address. |