APIv1 ドキュメント

サポートされているメソッド、パラメータ、返されるデータ、例に関する情報。

警告: APIは現在開発中であり、機能追加の可能性があります：新しいメソッドとパラメータが将来追加される可能性があります。新しいメソッドやパラメータが追加される可能性があります。

概要

TLD-List v1 API は、TLD-List に表示されるデータをライブデータベースから取得するために使用できます。

API は JSON データを含む HTTP POST を受け付け、JSON データで応答します。すべてのAPIメソッドリクエストの要件

  • リクエストはHTTP POSTメソッドで行う必要があります。
  • リクエストには、認証用の有効な公開鍵と秘密鍵のペアを含むJSONボディが必要です。
  • リクエストにはヘッダーを含める必要があります：Content-Type: application/json

パラメータは、JSONエンコードされたリクエストボディのキー/値としてAPIに渡されます。

すべてのAPIリクエストのベースURLは次のとおりです：

https://api.tld-list.com/v1

認証

認証は、メソッドの URL に投稿される JSON 本文に公開 API キーと非公開 API キーを渡すことで実行されます。すべてのAPIコールには、有効なAPIキーペアを含める必要があります。API キーペアは、TLD-List アカウントのAPIタブで生成できます。

アカウント] > [API]でAPIキーを作成します。

APIキーは、パラメータapiKeyPublic（あなたの公開キー）とapiKeyPrivate（あなたの秘密キー）を使用してJSONリクエストボディに渡されます。

Example authentication parameters

{
    "apiKeyPublic":"MY_PUBLIC_KEY",
    "apiKeyPrivate":"MY_PRIVATE_KEY" 
}

レスポンス

成功したAPIレスポンスはすべて、200 SUCCESSHTTPステータスコードとJSONエンコードされたボディを持ちます。それ以外のHTTPステータスコードがレスポンスに含まれる場合は、リクエストに失敗し、エラーが発生したことを示します。

APIから返されるJSONレスポンス・オブジェクトは、以下の構造を持ちます：

キー タイプ 説明
status string リクエストのステータスを指定します。SUCCESSはAPIコールが成功したことを示し、FAILはリクエストが失敗したことを示します。
errors array of objects 発生したエラーを表すオブジェクトの配列。各エラーオブジェクトには

code: エラーの種類を示す文字列

message: エラーの内容を示す、人間が読める文字列。

parameter: オプションの文字列あるいは文字列の配列で、 リクエストで渡されたパラメータの問題を表します。

エラーが発生しなかった場合は、エラー配列は空になります。

詳細はエラーコードを参照ください。
seconds number API サーバーがレスポンスを生成するのに要した時間 (秒)。
data string|array|object 要求されたデータを含むオブジェクト、配列、または文字列。

エラーを含む失敗したレスポンスオブジェクトの例

{
   "errors" : [
      {
         "code" : "PARAMETER_INVALID",
         "message" : "pricetypes parameter must be a non-empty array",
         "parameter" : "pricetypes"
      },
      {
         "code" : "PARAMETER_INVALID",
         "message" : "includeRegistrars parameter contains invalid registrar names: foobar",
         "parameter" : "includeRegistrars"
      }
   ],
   "seconds" : 0.001,
   "status" : "FAIL"
}

成功した応答オブジェクトの例

{
   "data" : [
      {
         "cheapest" : {
            "renewal" : [
               {
                  "id" : "sav",
                  "name" : "Sav",
                  "price" : "8.38"
               }
            ],
         },
         "currency" : "USD",
         "name" : "com",
         "registrarsIncluded" : 58,
         "registrarsTotal" : 58
      }
   ],
   "errors" : [],
   "seconds" : 0.001,
   "status" : "SUCCESS"
}

共通レスポンスオブジェクト

APIメソッドの中には、同じ構造を持つデータ・オブジェクトを返すものがあります。これらの一般的なデータ・オブジェクトについては、以下で詳しく説明します。

RegistrarPricing

特定の価格タイプ(register, renewal, transfer)の拡張機能に対するレジストラの小売価格を記述します。特別条件、手数料、税金、プロモーションなどの追加詳細も含まれます。

パス タイプ 説明
id string レジストラを一意に識別するレジストラID文字列。
name string レジストラの表示名。
price string 拡張機能およびpricetypeに対するレジストラの最終小売価格。

注意:このフィールドは、RegistrarPricingオブジェクトがpricetypeのコンテキストにネストされている場合にのみ存在します(例えば、getCheapestRegistrarsからの応答)。
priceOriginal string 数字文字列としての拡張子のレジストラの通常の小売価格。このフィールドはpriceがプロモーション価格である場合にのみ存在します。

注意:このフィールドは、RegistrarPricingオブジェクトがpriceetypeのコンテキストにネストされている場合にのみ存在します(例えば、getCheapestRegistrarsからの応答)。
pricetype string register, renewal, transfer のいずれか。

注意:このフィールドは、RegistrarPricingオブジェクトがpriceetypeのコンテキストにネストされている場合にのみ存在します(例えば、getCheapestRegistrarsからのレスポンス)。
prices object すべての価格タイプの拡張機能に対するレジストラの小売価格。
prices[pricetype] string pricetype]キーはregister, renewal, transfer, restore, whoisprivacy 。 例

{
    "register": "8.73",
    "renewal": "9.73",
    "transfer": "9.73",
    "whoisPrivacy": "0.00"
}
pricesOriginal object すべての価格タイプの拡張機能に対するレジストラの通常の小売価格。レジストラに有効なプロモがない場合、このフィールドは存在しません。
pricesOriginal[pricetype] string 拡張子と[pricetype]のレジストラの通常小売価格。[pricetype]キーはregister, renewal, transfer, restore, whoisprivacy 。
promo object この拡張子および価格タイプのレジストラの価格に適用されたプロモーション価格を表すRegistrarPromoオブジェクト。プロモが適用されていない場合、このフィールドは存在しません。プロモオブジェクトの例：

{
    "code": "MYCOUPONCODE",
    "amount": "20.00",
    "type": "discount-percent",
    "start": "2015-06-22T00:00:00",
    "end": "2025-06-22T00:00:00"
}


注意:このフィールドは、RegistrarPricingオブジェクトがpricetypeのコンテキストにネストされている場合(たとえば、getCheapestRegistrarsからの応答)にのみ存在します。
promos array of objects この拡張子に対してレジストラが提供するすべての有効なプロモーション価格を表すRegistrarPromoオブジェクトの配列。
terms object レジストラの価格設定に適用される特別条件を表すオブジェクトのコレクション。特別条件が適用されない場合、このフィールドは存在しません。

limitPerCustomer- 価格設定が顧客ごとに一定数のドメインに対してのみ有効であることを指定します。
newCustomerOnly- 価格設定が新規顧客に対してのみ有効であることを指定します。
affiliateLink- 価格設定が、顧客がアフィリエイトリンク経由でレジストラのサイトにアクセスした場合にのみ有効であることを指定します。
nameserverLockIn- 購入したドメインがレジストラのネームサーバーのみを使用できることを指定します。
idSubmissionRequired- 購入を完了するために、顧客が写真付きIDまたは事業者登録を提出する必要があることを指定します。

条件オブジェクトの例：

{
    "limitPerCustomer": {
        "pricetype": [
            "register"
        ],
        "count": 1
    },
    "newCustomerOnly": {
        "pricetype": [
            "register"
        ]
    },
    "affiliateLink": {
        "pricetype": [
            "register"
        ]
    },
    "multiYearPurchaseRequired": {
        "pricetype": [
            "register"
        ],
        "count": 2
    },
    "nameserverLockIn": {
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ]
    },
    "idSubmissionRequired": {
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ]
    }
}
terms[term].count number 顧客が制限される数量。 例えば、count = 1の場合、顧客は指定された価格で1ドメインに制限されます。適用されない場合、このフィールドは存在しません。
terms[term].pricetype array of strings この用語が適用される価格タイプ:register, renewal, transfer.このフィールドは、RegistrarPricingオブジェクトのpricetypeが指定されていない場合にのみ存在します。
notes object レジストラの価格設定に関連するノートを表すオブジェクトのコレクション。価格設定ノートがない場合、この値は空のオブジェクトになります。各サブオブジェクトはノートIDでキー設定されています：currencyExchangeRate, feeIcann, feeTax, feePayment
notes.feeIcann object ICANN手数料がTLDの最終価格に追加されているかどうかを指定します（通常は$0.18USD ）。このノートが存在する場合、レジストラがICANN料金を広告価格に含めず、代わりに顧客のチェックアウト時にTLD's 価格に追加料金として追加することを意味します。

fee_icannノートオブジェクトの例：

{
    "feeIcann": {
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ],
        "amount": "0.18",
        "addedToListPrice": true
    }
}

pricetypeフィールドは、どの価格タイプに手数料が適用されるかを指定し、addedToListPriceフィールドは、手数料が最終価格に追加されたことを示します。
notes.feeTax array of objects レジストラによって請求される様々な税率、税金が適用される顧客、および計算された税金がTLDの最終価格に含まれているかどうかを指定します。税金がTLDの最終価格に含まれるのは、レジストラが広告価格に税金を含まず、すべての顧客に税金が請求される場合のみであることに注意してください。

オブジェクトのfeeTax配列の例：

{
    "feeTax": [
        {
            "addedToListPrice": false,
            "appliesToCustomers": [
                "eu",
                "us",
                "in"
            ],
            "amountRateType": "percent",
            "amountRate": "13",
            "type": "hst"
        },
        {
            "addedToListPrice": false,
            "appliesToCustomers": [
                "ca"
            ],
            "amountRateType": "percent",
            "amountRate": "5",
            "type": "gst"
        }
    ]
}
notes.feeTax[].type string 税金の種類を表すラベル。例えば、付加価値税は「vat」、物品サービス税は「gst」など。
notes.feeTax[].amountRate number|string 税率金額。これは、税率を数字で表示するか、税率が地域などの顧客の条件によって異なることを示す文字列'~'を表示します。
notes.feeTax[].amountRateType string 文字列値'percent'は、amountRate値が数値のパーセンテージであることを示します。文字列値'percent-varies-by-location' は、税率が顧客の請求地域または国によって異なることを示します。
notes.feeTax[].appliesToCustomers string|array of strings 文字列'*'は、税金がすべての顧客に適用されることを示します。そうでなければ、この値は ISO 3166-1 alpha-2 の国コード文字列の配列となります。例外として、この配列には国コード以外の文字列'eu' を含めることができます。
notes.feeTax[].addedToListPrice boolean 計算された税額が最終価格に加算されているかどうかを示します。
notes.feePayment object レジストラが顧客の支払い方法に基づいて追加料金を請求するかどうか、またその料金がTLDの最終価格に含まれているかどうかを指定します。
feePaymentオブジェクトの例：

{
    "feePayment": {
        "addedToListPrice": false,
        "amountRate": "~",
        "amountRateMin": "0.9",
        "amountRateMax": "20",
        "amountRateType": "percent-varies-by-method"
    }
}
notes.feePayment.amountRate string 手数料の金額。これは、手数料のパーセンテージを数値で表すか、または手数料率が支払い方法などの顧客基準に基づいて異なることを示す文字列「~」のいずれかになります。
notes.feePayment.amountRateMin string 最低手数料額。手数料が変動制の場合のみ適用されます。
notes.feePayment.amountRateMax string 手数料の最高額。手数料が変動制の場合のみ適用されます。
notes.feePayment.amountRateType string 文字列値「percent」は、amountRateの値が数値のパーセンテージであることを示します。文字列値「percent-varies-by-method」は、手数料が顧客の支払い方法に応じて変化するパーセンテージであることを示します。
notes.feePayment.addedToListPrice boolean 計算された料金額が最終価格に加算されているかどうかを示します。
notes.currencyExchangeRate object USD通貨変換の詳細は次のように表されます:

base: 3文字コードとしての登録者の価格設定通貨 (例: EUR)
quote: 価格が変換された通貨 (常にUSD)
rate: 通貨変換に使用された為替レート。

currencyExchangeRateノートオブジェクトの例：

{
    "currencyExchangeRate": {
        "base": "GBP",
        "quote": "USD",
        "rate": "1.2482"
    }
}
threeYearValueScore number レジストラ経由でこの拡張子を持つドメインを3年間所有するための、価格設定と無料機能によって決定される価値の数値測定。数字が大きいほど、より多くの価値が提供されます。
currency string 価格データの3文字のISO 4217通貨コード。この値は現在 USD.
freeFeatures array of objects レジストラがドメイン所有権と共に提供する無料機能を表すオブジェクトの配列。オブジェクトには各機能の数量と期間が含まれます。


whois-privacy- WHOISプライバシーサービス。
email-account- 無料メールアカウント。
email-forward- 無料メール転送。
ssl-cert - 無料基本SSL証明書。 無料機能配列の例：



[
    {
        "name": "dns"
    },
    {
        "name": "whois-privacy"
    },
    {
        "name": "email-account",
        "count": 5
    },
    {
        "name": "ssl-cert",
        "duration": 365
    }
]
freeFeatures[].count number レジストラが無料で提供する機能の数量。適用されない場合、このフィールドは存在しません。
freeFeatures[].duration number レジストラが機能を無料で提供する日数。期間=365の場合、機能は1年間無料で提供されます。適用されない場合、このフィールドは存在しません。

RegistrarPromo

レジストラが提供するアクティブなプロモーションについて説明します。例

{
    "code": "MYCOUPONCODE",
    "amount": "20.00",
    "type": "discount-percent",
    "start": "2015-06-22T00:00:00",
    "end": "2025-06-22T00:00:00"
}
パス タイプ 説明
promo.code string 割引プロモーションを受けるために、お客様がチェックアウト時に入力しなければならないプロモコード。
promo.amount string プロモーション価格の数値。プロモのタイプによって、これは割引価格(price)、通常価格から差し引かれた金額(discount)、または通常価格から差し引かれたパーセンテージの金額(discount-percent)になります。
promo.type string プロモーション価格のタイプを表す文字列。

price- プロモの金額フィールドが新しい割引価格であることを意味します
discount- プロモの金額フィールドが適用価格を得るために通常価格から差し引かれたことを意味します
discount-percent- プロモの金額フィールドがパーセンテージであり、適用価格を得るために通常価格からそのパーセンテージが差し引かれたことを意味します。
promo.start string プロモが開始されたISO 8601の日時(UTCタイムゾーン)。特定の開始日がない場合は存在しません。例 2015-06-22T00:00:00
promo.end string プロモが終了するISO 8601の日時(UTCタイムゾーン)。特定の終了日がない場合は表示されません。例 2025-06-22T00:00:00
promo.pricetype array of strings プロモが適用される価格タイプ:register, renewal, transfer.

注意:このフィールドは、(例えばgetCheapestRegistrars からのレスポンスのように) 価格タイプのコンテキストにネストされている場合のみ存在します。

エラーコード

リクエストに失敗した場合、JSON レスポンスオブジェクトには、何が問題だったのかを説明する 1 つ以上のエラーオブジェクトを含めることができます。以下は、エラーオブジェクトのコードフィールドに設定できるエラーコードの非包括的なリストです。

コード 説明
502 APIサーバーが一時的に利用できません。
RATE_LIMITED クライアントAPIリクエスト数が許容上限を超えました。
INVALID_METHOD 要求されたAPIメソッドが存在しません。
SYSTEM 不明なシステムエラーが発生しました。
RESPONSE_TIMEOUT APIサーバーが応答生成中にタイムアウトしました。
PARAMETER_REQUIRED 呼び出されたメソッドに必要なパラメータがクライアントから提供されていません。
ACCOUNT_INACTIVE クライアントのアカウントがアクティブでなくなり、APIアクセスのためにサブスクリプションの更新が必要になりました。
NO_ACCESS クライアントのアカウントレベルではAPIアクセスが許可されていません。APIアクセスにはアカウントのアップグレードが必要です。
AUTH_INVALID 認証に失敗しました: 提供された API キーが無効です。
CLIENT_IPS_EXCEEDED 提供されたAPIキーペアに対してAPIへのアクセスを許可された一意のクライアントIPの最大値を超えました。
REQUEST_ENDED_BY_CLIENT 応答が生成される前に、リクエストがクライアントによって終了されました。

制限

APIの使用には、悪用を防ぐために一定の制限があります。これらの使用制限は以下に示すとおりであり、予告なく変更されることがあります。

タイプ 説明
アカウントごとのAPIキー 3
料金制限 100 15 分あたりの最大リクエスト数
APIキーごとのクライアントIPアドレス 5 1440 分ごとに、キーごとにユニークなクライアント IP アドレス

エクステンション・メソッド

get

拡張子とそれに関連する価格と詳細データを返します。このメソッドは、ひとつあるいは複数の TLD 詳細ページ (.com など) に表示されているデータを取得するのと同じようなものです。ただし、"Cheapest Price History" データはこのメソッドでは返されません (過去のデータについてはgetAggregateHistoryメソッドを参照ください)。

APIエンドポイント:https://api.tld-list.com/v1/extension/get

応答時間:~12 seconds for all extensions, ~6 seconds < 2000 extensions, ~2 seconds < 100 extensions

リクエストパラメータ

キー タイプ 必須 説明
extensions array of strings

取得する拡張子を指定します。前にドットを付けないでください。拡張子名は unicode またはそれに相当する punycode です。省略すると、TLD-List にリストされているすべての拡張子が返されます。

例: "extensions": ["com", "io", "co.uk", "移动", "xn--p1ai"]
includeFields array of strings 返すデータをキー名で指定します。このパラメータで指定されていないキーは省略されます。デフォルトでは、使用可能なすべてのフィールドが返されます。使用可能なフィールドのリストについては、レスポンス・テーブルを参照してください。入れ子のフィールドはサポートされていません。

例: "includeFields": ["name", "registrars", "dnssecSupported"]
excludeFields array of strings 除外するセテインデータをキー名で指定します。このパラメータで指定されたキーは省略されます。デフォルトでは、除外されるフィールドはありません。使用可能なフィールドのリストについては、レスポンス・テーブルを参照してください。入れ子のフィールドはサポートされていません。

例: "excludeFields": ["available", "syntax", "sponsor"]
includeRegistrars array of strings

結果に含めるアクティブなレジストラの文字列ID。TLD-List でアクティブにリストされているすべてのレジストラの ID のリストを取得するにはgetIdsメソッドを使用します。

例: "includeRegistrars": ["godaddy", "porkbun", "namecheap"]
excludeRegistrars array of strings

結果から除外するアクティブなレジストラの文字列ID。TLD-List でアクティブにリストされているすべてのレジストラの ID のリストを取得するにはgetIdsメソッドを使用します。

例: "excludeRegistrars": ["godaddy", "porkbun", "namecheap"]
omitExtensionsWithoutRegistrars boolean

trueの場合、結果にレジストラの価格データがない拡張子は省略されます。デフォルトでは、すべての拡張機能が含まれます。

例: "omitExtensionsWithoutRegistrars": true

応答オブジェクト

パス タイプ 説明
data array of objects 拡張子名の配列。
data[].available object TLDフェーズ利用可能日のオブジェクト。
data[].available.general object ドメイン登録が一般公開されるISO 8601の日時（UTCタイムゾーン）。
data[].available.sunrise object TLD's サンライズフェーズ（商標権者が該当ドメインの登録申請を開始できる時期）を表す開始日時と終了日時の範囲のオブジェクト。例

{
    "sunrise": {
        "start": "2017-06-19T00:00:00.000Z",
        "end": "2017-08-21T00:00:00.000Z"
    }
}
data[].available.trademark object TLD's Trademark フェーズ (商標と一致するドメインが登録された場合に商標クリアリングハウスから商標権者に通知される期間) を表す開始日時と終了日時の範囲のオブジェクト。例

{
    "trademark": {
        "start": "2019-06-18T00:00:00.000Z",
        "end": "2020-09-21T00:00:00.000Z"
    }
}
data[].available.other array of objects ランドラッシュ(Land Rush)」や「認定ローンチプログラム(Qualified Launch Program)」など、TLDの様々なローンチフェーズとその日付範囲を表すオブジェクトの配列。例

{
    "other": [
        {
            "end": "2020-09-18T00:00:00.000Z",
            "name": "Limited Community Priority Period",
            "start": "2019-09-17T00:00:00.000Z",
            "type": "limited-registration-period"
        },
        {
            "end": "2018-07-03T00:00:00.000Z",
            "name": "Restricted Land Rush 1",
            "start": "2017-10-23T00:00:00.000Z",
            "type": "limited-registration-period"
        },
        {
            "end": "2019-09-16T00:00:00.000Z",
            "name": "Invitation Priority Access",
            "start": "2017-08-22T00:00:00.000Z",
            "type": "limited-registration-period"
        },
        {
            "end": "2017-08-21T00:00:00.000Z",
            "name": "Qualified Launch Program",
            "start": "2017-06-19T00:00:00.000Z",
            "type": "qualified-launch-program"
        }
    ]
}
data[].average object 含まれるレジストラの、価格種別ごとの拡張機能の平均価格を含むオブジェクト。 例

{
    "average": {
        "register": "7.63",
        "renewal": "13.63",
        "transfer": "9.63"
    }
}
data[].average[pricetype] string pricetype]に対応する数値文字列としてのエクステンションの平均価格。[pricetype]のキーはregister, renewal, transfer, restore, whoisprivacy 。
data[].category string TLD が分類されたカテゴリ。配列の各オブジェクトはカテゴリを表し、以下のフィールドを含みます:

id-TLD-List で内部的に使用される整数のカテゴリ ID .
idstr- 代替文字列のカテゴリ ID.
name- 英語でのカテゴリ名.
desc- 英語でのカテゴリの説明.

カテゴリ配列の例：

[
    {
        "id": 4,
        "idstr": "services",
        "name": "Services",
        "desc": "TLDs for representing the service industry."
    },
    {
        "id": 6,
        "idstr": "food",
        "name": "Food & Drink",
        "desc": "Domain extensions for dining, cooking, restaurants, and beverages."
    }
]
data[].dnssecSupported boolean レジストリのDNSゾーンがDNSセキュリティ拡張（DNSSEC）をサポートしている場合。
data[].hasPremiumDomains object pricetype]キーとブール値からなるオブジェクトで、レジストリが特定の「プレミアム」ドメイン名に対して高い価格を請求するかどうかを表します。例

{
    "hasPremiumDomains": {
        "register": false,
        "renewal": false
    }
}
data[].infoUpdated string TLD's 基本情報 (制限事項、利用可能日など) が最後にチェックされ、更新された日時の ISO 8601 日付 (UTC タイムゾーン)。注意: updated.infoの日付が新しくなっても、必ずしもデータに変更があったとは限りません。データが最後にチェックされ、設定された日時を示すだけです。
data[].intendedUsage string 登録者による拡張機能の使用方法に関する一般的な情報。
data[].language string ISO 639-1 2文字の言語コード。言語が英語ベースまたは不明の場合、このフィールドは存在しません。
data[].level integer 拡張子のドメインレベルを表す整数。1 = トップレベルドメイン、2 = セカンドレベルドメイン、3 = サードレベルドメインなど。
data[].localPresenceRequired boolean レジストリが登録者にその地域の住所を要求する場合。
data[].median object 含まれるレジストラの、価格種別ごとの拡張機能の価格の中央値を含むオブジェクト。例

{
    "median": {
        "register": "3.17",
        "renewal": "20.17",
        "transfer": "8.17"
    }
}
data[].median[pricetype] string pricetype]に対応する数値文字列としてのエクステンションの価格の中央値。[pricetype]のキーはregister, renewal, transfer, restore, whoisprivacy 。
data[].name string ドメイン拡張子のユニコード名。
data[].nameservers array レジストリのルートネームサーバで、登録されているドメインの権威ネームサーバを格納するもの。nameservers 配列の例：

{
    "nameservers": [
        {
            "host": "a.gtld-servers.net",
            "ipv4": "192.5.6.30",
            "ipv6": "2001:503:a83e:0:0:0:2:30"
        },
        {
            "host": "b.gtld-servers.net",
            "ipv4": "192.33.14.30",
            "ipv6": "2001:503:231d:0:0:0:2:30"
        }
    ]
}
data[].parentTld string 拡張子の親トップレベルドメイン。これがTLDの場合、このフィールドは存在しません。
data[].pricingUpdated string TLD's 登録機関の価格が最後にチェックされ、更新された日時の ISO 8601 日付 (UTC タイムゾーン)。注:新しいupdated.pricingの日付は、必ずしもデータ変更が発生したことを示しません。データが最後にチェックされ、設定された日時を示すだけです。
data[].punycode string ドメイン拡張子のピュニコード名。IDN拡張子の場合のみ存在します。
data[].registerMaxYears integer 購入時にドメインを登録できる最長年数。
data[].registerMinYears integer 購入時にドメインを登録できる最低年数。
data[].registrarsIncluded integer 返された登録者配列に含まれる登録者の数。
data[].registrarsTotal integer 拡張子を販売しているアクティブなレジストラの合計。
data[].registrars array of objects レジストラの価格と機能のデータを含むRegistrarPricingオブジェクトの配列。
data[].registryUrl string TLD登録情報を提供するレジストリの公式ウェブサイト。
data[].renewalMinYears integer ドメインを更新できる最低年数。
data[].restrictions string TLD's 登録の制限と要件の簡単な説明。制限がない場合、このフィールドは存在しません。
data[].sponsor object エクステンションのスポンサー組織または管理組織に関するデータを含むオブジェクト。
data[].sponsor.name string 拡張子のICANN承認スポンサー団体名またはccTLD 管理団体名。
data[].sponsor.address string スポンサー組織またはccTLD 管理組織の物理的所在地。アドレス配列の例：

{
    "sponsor": {
        "address": [
            "Minerva House",
            "Edmund Halley Road",
            "Oxford Science Park",
            "Oxford OX4 4DQ",
            "United Kingdom"
        ]
    }
}
data[].sponsorParentCompany string スポンサー組織の支配権を所有する企業名。
data[].romanized string ラテン文字に転写されたTLD。言語が英語ベースの場合、または不明な場合、このフィールドは存在しません。
data[].rtl string 拡張子が "右から左へ "読まれる場合（すなわちアラブリックTLDs ）、この値は次のようになります。 __true__.左から右へ」読む場合、この値は __false__.不明な場合、この値は存在しません。
data[].syntax object 拡張モジュールで許可されるドメイン名のルールと制限についての詳細を含むオブジェクト。
data[].syntax.minChars integer 登録可能なラベルの最小文字数。
data[].syntax.maxChars integer 登録できるラベルの最大文字数。
data[].targetMarket string TLDがサービスを提供することを意図する人々または団体。
data[].translation string TLDの英語翻訳。TLDが既に英語ベースの場合、または翻訳が不明な場合、この値は存在しません。
data[].type string 次の文字列のいずれかで識別される TLD のタイプ：

gTLD
ccTLD :国別トップレベルドメイン
grTLD:汎用制限トップレベルドメイン sTLD
:スポンサー付きトップレベルドメイン。
data[].wholesale object 価格種別ごとの拡張子の卸売価格を含むオブジェクト。卸売り価格とは、レジストリからレジストラにドメイン名を購入する際に請求される価格のことです。例

{
    "wholesale": {
        "register": "8.97",
        "renewal": "8.97",
        "transfer": "8.97"
    }
}
data[].whoisPrivacySupported boolean 拡張機能でWHOISプライバシーサービスが登録者の名前と連絡先情報を隠すことを許可している場合。不明な場合、このフィールドは存在しません。
data[].whoisServer boolean ドメイン登録者の連絡先情報を保存するレジストリのサーバーのホスト名。

リクエスト/レスポンスの例

curl -X POST https://api.tld-list.com/v1/extension/get -H 'Content-Type: application/json' -d '{"extensions": ["com"], "includeRegistrars": ["porkbun","godaddy","epik"], "apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY"}'

{
   "data" : [
      {
         "average" : {
            "register" : "7.63",
            "renewal" : "13.63",
            "transfer" : "9.63"
         },
         "clicks" : 226,
         "dnssecSupported" : true,
         "hasPremiumDomains" : {
            "register" : false,
            "renewal" : false
         },
         "infoUpdated" : "2023-02-04T11:05:09",
         "level" : 1,
         "localPresenceRequired" : false,
         "median" : {
            "register" : "3.17",
            "renewal" : "20.17",
            "transfer" : "8.17"
         },
         "name" : "com",
         "nameservers" : [
            {
               "host" : "a.gtld-servers.net",
               "ipv4" : "192.5.6.30",
               "ipv6" : "2001:503:a83e:0:0:0:2:30"
            },
            {
               "host" : "b.gtld-servers.net",
               "ipv4" : "192.33.14.30",
               "ipv6" : "2001:503:231d:0:0:0:2:30"
            },
            {
               "host" : "c.gtld-servers.net",
               "ipv4" : "192.26.92.30",
               "ipv6" : "2001:503:83eb:0:0:0:0:30"
            },
            {
               "host" : "d.gtld-servers.net",
               "ipv4" : "192.31.80.30",
               "ipv6" : "2001:500:856e:0:0:0:0:30"
            },
            {
               "host" : "e.gtld-servers.net",
               "ipv4" : "192.12.94.30",
               "ipv6" : "2001:502:1ca1:0:0:0:0:30"
            },
            {
               "host" : "f.gtld-servers.net",
               "ipv4" : "192.35.51.30",
               "ipv6" : "2001:503:d414:0:0:0:0:30"
            },
            {
               "host" : "g.gtld-servers.net",
               "ipv4" : "192.42.93.30",
               "ipv6" : "2001:503:eea3:0:0:0:0:30"
            },
            {
               "host" : "h.gtld-servers.net",
               "ipv4" : "192.54.112.30",
               "ipv6" : "2001:502:8cc:0:0:0:0:30"
            },
            {
               "host" : "i.gtld-servers.net",
               "ipv4" : "192.43.172.30",
               "ipv6" : "2001:503:39c1:0:0:0:0:30"
            },
            {
               "host" : "j.gtld-servers.net",
               "ipv4" : "192.48.79.30",
               "ipv6" : "2001:502:7094:0:0:0:0:30"
            },
            {
               "host" : "k.gtld-servers.net",
               "ipv4" : "192.52.178.30",
               "ipv6" : "2001:503:d2d:0:0:0:0:30"
            },
            {
               "host" : "l.gtld-servers.net",
               "ipv4" : "192.41.162.30",
               "ipv6" : "2001:500:d937:0:0:0:0:30"
            },
            {
               "host" : "m.gtld-servers.net",
               "ipv4" : "192.55.83.30",
               "ipv6" : "2001:501:b1f9:0:0:0:0:30"
            }
         ],
         "pricingUpdated" : "2023-02-04T11:04:33",
         "registerMaxYears" : 10,
         "registerMinYears" : 1,
         "registrars" : [
            {
               "currency" : "USD",
               "freeFeatures" : [
                  {
                     "name" : "dns"
                  },
                  {
                     "name" : "whois-privacy"
                  }
               ],
               "id" : "godaddy",
               "name" : "GoDaddy",
               "notes" : {
                  "feeIcann" : {
                     "addedToListPrice" : true,
                     "amount" : "0.18",
                     "pricetype" : [
                        "register",
                        "renewal",
                        "transfer"
                     ]
                  },
                  "feeTax" : [
                     {
                        "addedToListPrice" : false,
                        "amountRate" : "~",
                        "amountRateType" : "percent-varies-by-location",
                        "appliesToCustomers" : [
                           "eu"
                        ],
                        "type" : "vat"
                     },
                     {
                        "addedToListPrice" : false,
                        "amountRate" : "15",
                        "amountRateType" : "percent",
                        "appliesToCustomers" : [
                           "in"
                        ],
                        "type" : "gst"
                     },
                     {
                        "addedToListPrice" : false,
                        "amountRate" : "10",
                        "amountRateType" : "percent",
                        "appliesToCustomers" : [
                           "au"
                        ],
                        "type" : "gst"
                     }
                  ]
               },
               "prices" : {
                  "register" : "3.17",
                  "renewal" : "20.17",
                  "transfer" : "8.17",
                  "whoisPrivacy" : "0.00"
               },
               "pricesOriginal" : {
                  "register" : "10.18"
               },
               "promos" : [
                  {
                     "amount" : "2.99",
                     "code" : "GDD2dom",
                     "pricetype" : [
                        "register"
                     ],
                     "start" : "2023-01-01T00:00:00",
                     "type" : "price"
                  }
               ],
               "terms" : {
                  "limitPerCustomer" : {
                     "count" : 1,
                     "pricetype" : [
                        "register"
                     ]
                  }
               },
               "threeYearValueScore" : "5.76"
            },
            {
               "currency" : "USD",
               "freeFeatures" : [
                  {
                     "name" : "whois-privacy"
                  },
                  {
                     "name" : "dns"
                  }
               ],
               "id" : "epik",
               "name" : "Epik",
               "prices" : {
                  "register" : "9.99",
                  "renewal" : "10.99",
                  "restore" : "90.00",
                  "transfer" : "9.99",
                  "whoisPrivacy" : "0.00"
               },
               "threeYearValueScore" : "8.29"
            },
            {
               "currency" : "USD",
               "freeFeatures" : [
                  {
                     "name" : "whois-privacy"
                  },
                  {
                     "name" : "dns"
                  },
                  {
                     "name" : "email-forward"
                  },
                  {
                     "name" : "ssl-cert"
                  }
               ],
               "id" : "porkbun",
               "name" : "Porkbun",
               "prices" : {
                  "register" : "8.73",
                  "renewal" : "9.73",
                  "transfer" : "9.73",
                  "whoisPrivacy" : "0.00"
               },
               "pricesOriginal" : {
                  "register" : "9.73"
               },
               "promos" : [
                  {
                     "amount" : "1.00",
                     "code" : "AWESOMENESS",
                     "pricetype" : [
                        "register"
                     ],
                     "type" : "discount"
                  }
               ],
               "terms" : {
                  "limitPerCustomer" : {
                     "count" : 1,
                     "pricetype" : [
                        "register"
                     ]
                  }
               },
               "threeYearValueScore" : "16.03"
            }
         ],
         "registryUrl" : "http://www.verisigninc.com",
         "renewalMinYears" : 1,
         "rtl" : false,
         "sponsor" : {
            "address" : [
               "12061 Bluemont Way",
               "Reston Virginia 20190",
               "United States"
            ],
            "name" : "VeriSign Global Registry Services"
         },
         "syntax" : {
            "maxChars" : 63,
            "minChars" : 2
         },
         "type" : "gTLD",
         "whoisPrivacySupported" : true,
         "whoisServer" : "whois.verisign-grs.com",
         "wholesale" : {
            "register" : "8.97",
            "renewal" : "8.97",
            "transfer" : "8.97"
         }
      }
   ],
   "errors" : [],
   "seconds" : 0.068,
   "status" : "SUCCESS"
}

getNames

すべての拡張子名を返します。

APIエンドポイント:https://api.tld-list.com/v1/extension/getNames

応答時間:~1 second

リクエストパラメータ

キー タイプ 必須 説明
omitExtensionsWithoutRegistrars boolean trueの場合、結果にレジストラの価格データがないエクステンションは省略されます。デフォルトはfalseです。
wantPunycode boolean 返 さ れた IDN 拡張をすべて、 unicode のかわ り に punycode と し てエン コ ー ド し ます。デフォルトはfalse です。

応答オブジェクト

パス タイプ 説明
data array of strings 拡張子名の配列。

リクエスト/レスポンスの例

curl -X POST https://api.tld-list.com/v1/extension/getNames -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY", "wantPunycode": true, "omitExtensionsWithoutRegistrars": true}'

{
   "data" : [
      "2000.hu",
      "5g.in",
      "6g.in",
      "aaa.pro",
      "abc.br",
      "abkhazia.su",
      "abo.pa",
      "abogado",
      "abr.it",
      "abruzzo.it",
      "abudhabi",
      ...
      "xn--3bst00m",
      "xn--jvr189m",
      "xn--imr513n",
      "xn--j6w193g",
      "xn--t60b56a",
      "xn--mk1bu44c",
      "xn--3e0b707e"
   ],
   "errors" : [],
   "seconds" : 0.697,
   "status" : "SUCCESS"
}

getCheapestRegistrar

最も安いレジストラ/プロバイダ、それらの価格、中央値、およびドメイン拡張子ごとの平均価格を返します。どのレジストラでも販売されていない拡張子は返されません。

APIエンドポイント:https://api.tld-list.com/v1/extension/getCheapestRegistrar

応答時間:~8 seconds for all extensions, ~4 seconds < 2000 extensions, ~1 second < 100 extensions

リクエストパラメータ

キー タイプ 必須 説明
pricetypes array of strings

取得する価格設定の種類を指定します。省略された場合は、3つの価格タイプ(register, renewal, transfer)が返されます。

例: "pricetypes": ["register", "transfer"]
extensions array of strings

取得する拡張子を指定します。前にドットを付けないでください。拡張子名は unicode またはそれに相当する punycode です。省略すると、TLD-List にリストされているすべての拡張子が返されます。

例: "extensions": ["com", "io", "co.uk", "移动", "xn--p1ai"]
includeRegistrars array of strings

最も安い価格設定と集計計算を決定するときに含めるアクティブなレジストラの文字列ID。このパラメータで指定されていないレジストラは無視されます。TLD-List でアクティブにリストされているすべてのレジストラのIDのリストを取得するには、getIdsメソッドを使用します。

このパラメータが省略された場合、TLD-List でアクティブにリストされているすべてのレジストラが考慮されます。

例: "includeRegistrars": ["godaddy", "porkbun", "namecheap"]
excludeRegistrars array of strings

最も安い価格と集計計算を決定するときに除外するアクティブなレジストラの文字列ID。TLD-List にアクティブにリストされているすべてのレジストラのIDのリストを取得するには、getIdsメソッドを使用します。

このパラメータが省略された場合、無視されるレジストラはありません。

例: "excludeRegistrars": ["godaddy", "porkbun", "namecheap"]
omitExtensionsWithoutRegistrars boolean

trueの場合、結果にレジストラ価格データがない拡張は省略されます。この状況は、渡されたexcludeRegistrarsおよび/またはincludeRegistrarsパラメータによって、通常レジストラ価格データを持つ拡張が、一致するレジストラ価格データを持たない場合に発生します。これらの拡張はデフォルトで含まれますが、その価格データは空の配列になります。これらの拡張を結果から除外するにはtrueを設定します。

例: "omitExtensionsWithoutRegistrars": true

応答オブジェクト

パス タイプ 説明
data array of objects 各オブジェクトはドメイン拡張子を表します。
data[].name string ドメイン拡張子のユニコード名。
data[].punycode string ドメイン拡張子のピュニコード名。IDN拡張子の場合のみ存在します。
data[].currency string 価格データの3文字のISO 4217通貨コード。この値は現在 USD.
data[].registrarsIncluded number 返された価格データに含まれるレジストラの数。
data[].average object 含まれるレジストラの、価格種別ごとの拡張機能の平均価格を含むオブジェクト。
data[].average[pricetype] string pricetype]に対応する数値文字列としてのエクステンションの平均価格。[pricetype]のキーはregister, renewal, transfer 。
data[].median object 含まれるレジストラの、価格種別ごとの拡張機能の価格の中央値を含むオブジェクト。
data[].median[pricetype] string pricetype]に対応する数値文字列としてのエクステンションの価格の中央値。[pricetype]のキーはregister, renewal, transfer 。
data[].cheapest object 価格タイプ別に、その拡張子の最も安いレジストラを含むオブジェクト。
data[].cheapest[pricetype] array of objects

pricetype ]のキーがregister, renewal, transfer の場合、[pricetype]によって最も安いレジストラを含むRegistrarPricingオブジェクトの配列。

このデータが配列であるのは、拡張機能の最安値が複数のレジストラで同じである可能性があるためです。

リクエスト/レスポンスの例

curl -X POST https://api.tld-list.com/v1/extension/getCheapestRegistrar -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY", "includeRegistrars": ["godaddy", "namecheap", "porkbun", "namesilo", "netim"], "extensions": ["com", "co.uk"]}'

{
   "data" : [
      {
         "average" : {
            "register" : "7.85",
            "renewal" : "10.25",
            "transfer" : "11.99"
         },
         "cheapest" : {
            "register" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "email-forward"
                     },
                     {
                        "name" : "ssl-cert"
                     }
                  ],
                  "id" : "porkbun",
                  "name" : "Porkbun",
                  "price" : "4.96",
                  "priceOriginal" : "5.96",
                  "prices" : {
                     "register" : "4.96",
                     "renewal" : "5.96"
                  },
                  "pricesOriginal" : {
                     "register" : "5.96"
                  },
                  "pricetype" : "register",
                  "promo" : {
                     "amount" : "1.00",
                     "code" : "AWESOMENESS",
                     "type" : "discount"
                  },
                  "promos" : [
                     {
                        "amount" : "1.00",
                        "code" : "AWESOMENESS",
                        "type" : "discount"
                     }
                  ],
                  "terms" : {
                     "limitPerCustomer" : {
                        "count" : 1
                     }
                  },
                  "threeYearValueScore" : "18.36"
               }
            ],
            "renewal" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "email-forward"
                     },
                     {
                        "name" : "ssl-cert"
                     }
                  ],
                  "id" : "porkbun",
                  "name" : "Porkbun",
                  "price" : "5.96",
                  "prices" : {
                     "register" : "4.96",
                     "renewal" : "5.96"
                  },
                  "pricetype" : "renewal",
                  "threeYearValueScore" : "18.36"
               }
            ],
            "transfer" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     }
                  ],
                  "id" : "godaddy",
                  "name" : "GoDaddy",
                  "notes" : {
                     "feeTax" : [
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "~",
                           "amountRateType" : "percent-varies-by-location",
                           "appliesToCustomers" : [
                              "eu"
                           ],
                           "type" : "vat"
                        },
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "15",
                           "amountRateType" : "percent",
                           "appliesToCustomers" : [
                              "in"
                           ],
                           "type" : "gst"
                        },
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "10",
                           "amountRateType" : "percent",
                           "appliesToCustomers" : [
                              "au"
                           ],
                           "type" : "gst"
                        }
                     ]
                  },
                  "price" : "11.99",
                  "prices" : {
                     "register" : "6.49",
                     "renewal" : "11.99",
                     "transfer" : "11.99"
                  },
                  "pricetype" : "transfer",
                  "threeYearValueScore" : "3.46"
               }
            ]
         },
         "currency" : "USD",
         "median" : {
            "register" : "6.48",
            "renewal" : "10.78",
            "transfer" : "11.99"
         },
         "name" : "co.uk",
         "registrarsIncluded" : 4,
         "registrarsTotal" : 47
      },
      {
         "average" : {
            "register" : "8.90",
            "renewal" : "14.10",
            "transfer" : "9.30"
         },
         "cheapest" : {
            "register" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "whois-privacy"
                     }
                  ],
                  "id" : "godaddy",
                  "name" : "GoDaddy",
                  "notes" : {
                     "feeIcann" : {
                        "addedToListPrice" : true,
                        "amount" : "0.18"
                     },
                     "feeTax" : [
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "~",
                           "amountRateType" : "percent-varies-by-location",
                           "appliesToCustomers" : [
                              "eu"
                           ],
                           "type" : "vat"
                        },
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "15",
                           "amountRateType" : "percent",
                           "appliesToCustomers" : [
                              "in"
                           ],
                           "type" : "gst"
                        },
                        {
                           "addedToListPrice" : false,
                           "amountRate" : "10",
                           "amountRateType" : "percent",
                           "appliesToCustomers" : [
                              "au"
                           ],
                           "type" : "gst"
                        }
                     ]
                  },
                  "price" : "3.17",
                  "priceOriginal" : "10.18",
                  "prices" : {
                     "register" : "3.17",
                     "renewal" : "20.17",
                     "transfer" : "8.17",
                     "whoisPrivacy" : "0.00"
                  },
                  "pricesOriginal" : {
                     "register" : "10.18"
                  },
                  "pricetype" : "register",
                  "promo" : {
                     "amount" : "2.99",
                     "code" : "GDD2dom",
                     "start" : "2023-01-01T00:00:00",
                     "type" : "price"
                  },
                  "promos" : [
                     {
                        "amount" : "2.99",
                        "code" : "GDD2dom",
                        "start" : "2023-01-01T00:00:00",
                        "type" : "price"
                     }
                  ],
                  "terms" : {
                     "limitPerCustomer" : {
                        "count" : 1
                     }
                  },
                  "threeYearValueScore" : "5.76"
               }
            ],
            "renewal" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "whois-privacy"
                     },
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "email-forward"
                     },
                     {
                        "name" : "ssl-cert"
                     }
                  ],
                  "id" : "porkbun",
                  "name" : "Porkbun",
                  "price" : "9.73",
                  "prices" : {
                     "register" : "8.73",
                     "renewal" : "9.73",
                     "transfer" : "9.73",
                     "whoisPrivacy" : "0.00"
                  },
                  "pricetype" : "renewal",
                  "threeYearValueScore" : "16.03"
               }
            ],
            "transfer" : [
               {
                  "currency" : "USD",
                  "freeFeatures" : [
                     {
                        "name" : "dns"
                     },
                     {
                        "name" : "whois-privacy"
                     },
                     {
                        "name" : "email-forward"
                     }
                  ],
                  "id" : "namecheap",
                  "name" : "Namecheap",
                  "notes" : {
                     "feeIcann" : {
                        "addedToListPrice" : true,
                        "amount" : "0.18"
                     }
                  },
                  "price" : "7.16",
                  "prices" : {
                     "register" : "6.16",
                     "renewal" : "14.16",
                     "restore" : "13.98",
                     "transfer" : "7.16",
                     "whoisPrivacy" : "0.00"
                  },
                  "pricetype" : "transfer",
                  "terms" : {
                     "limitPerCustomer" : {
                        "count" : 1
                     }
                  },
                  "threeYearValueScore" : "10.15"
               }
            ]
         },
         "currency" : "USD",
         "median" : {
            "register" : "10.95",
            "renewal" : "10.95",
            "transfer" : "9.95"
         },
         "name" : "com",
         "registrarsIncluded" : 5,
         "registrarsTotal" : 59
      }
   ],
   "errors" : [],
   "seconds" : 0.126,
   "status" : "SUCCESS"
}

レジストラの方法

getIds

すべてのレジストラ ID を返します。各レジストラ ID は、TLD-List にアクティブに掲載されているレジストラを一意に識別します。

APIエンドポイント:https://api.tld-list.com/v1/registrar/getIds

応答時間:< 1 second

リクエストパラメータ

なし

応答オブジェクト

パス タイプ 説明
data array of strings 文字列のレジストラIDの配列。

リクエスト/レスポンスの例

curl -X POST https://api.tld-list.com/v1/registrar/getIds -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY"}'

{
   "data" : [
      "101domain",
      "123reg",
      "above.com",
      ...
      "upflare",
      "webnames.ca"
   ],
   "errors" : [],
   "seconds" : 0.001,
   "status" : "SUCCESS"
}