API v1文檔

有關支援的方法、參數、返回的數據和示例的資訊。

警告: 該 API 目前正在開發中，可能會發生變化。將來可能會添加新的方法、參數和功能。所做的任何更改都將保持與現有功能的向後相容。

概述

頂級域名清單 v1 API 可用於從其實時資料庫中檢索頂級域名清單上顯示的數據。

該 API 透過 HTTP POST 接受並返回 JSON 編碼的數據。所有 API 方法要求的要求：

  • [
  • “
  • 必
  • 須
  • 使
  • 用
  • H
  • T
  • T
  • P
  • P
  • O
  • S
  • T
  • 方
  • 法
  • 發
  • 出
  • 請
  • 求
  • ”
  • ，
  • “
  • 請
  • 求
  • 必
  • 須
  • 具
  • 有
  • 包
  • 含
  • 用
  • 於
  • 身
  • 份
  • 驗
  • 證
  • 的
  • 有
  • 效
  • 公
  • 鑰
  • 和
  • 私
  • 鑰
  • 對
  • 的
  • J
  • S
  • O
  • N
  • 正
  • 文
  • ”
  • ，
  • “
  • 請
  • 求
  • 必
  • 須
  • 包
  • 含
  • 標
  • 頭
  • ：
  • ”
  • <
  • c
  • o
  • d
  • e
  • >
  • C
  • o
  • n
  • t
  • e
  • n
  • t
  • -
  • T
  • y
  • p
  • e
  • :
  • a
  • p
  • p
  • l
  • i
  • c
  • a
  • t
  • i
  • o
  • n
  • /
  • j
  • s
  • o
  • n
  • <
  • /
  • c
  • o
  • d
  • e
  • >
  • ]

參數作為 JSON 編碼請求正文中的鍵/值傳遞給 API。

所有 API 請求的基本 URL 為：

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

認證

通過將發佈到方法 URL 的 JSON 正文中的公有 API 金鑰和私有 API 金鑰傳遞來執行身份驗證。所有 API 呼叫都必須包含有效的 API 金鑰對。API 金鑰對可以在您的頂級域名清單帳戶中的 API 選項卡下生成。

訪問帳戶> API 以創建 API 金鑰。

API 金鑰使用 apiKeyPublic（您的公鑰）和 apiKeyPrivate（您的私鑰）在 JSON 請求正文中傳遞。

Example authentication parameters

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

回應

所有成功的 API 回應都將具有 200 SUCCESS HTTP 狀態代碼和 JSON 編碼正文。回應中的任何其他 HTTP 狀態代碼都指示請求失敗併發生錯誤。

API 傳回的所有 JSON 回應物件都將具有以下結構：

鑰匙 類型 說明
status string 指定請求的狀態。 SUCCESS 表示 API 呼叫成功， FAIL 表示請求失敗。
errors array of objects 表示發生的錯誤的物件陣列。每個錯誤物件將包含：

code：標識錯誤類型的字串

message：描述錯誤的人類可讀字串

parameter：可選取字串，指示請求中傳遞的特定參數存在問題。

如果未發生錯誤， errors 則陣列將為空。
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 註冊商對擴展的零售價（以數位字串形式表示）。
priceOriginal string 註冊商以數位字串形式顯示的擴展的正常零售價。僅當促銷價格時 price ，此欄位才會顯示。

注意： 僅當 RegistrarPricing 物件嵌套在價格類型的上下文中時（例如，在 getCheapestRegistrars 的回應中），此欄位才存在。
pricetype string 擴展定價的類型，為：register, renewal, transfer。
prices object 註冊商針對所有價格類型的擴展的零售定價。
prices[pricetype] string 註冊商對擴展程式和 [pricetype] 的最終零售價，其中 [pricetype] 鍵是register, renewal, transfer, restore, whoisprivacy。 例：

__樣本__
pricesOriginal object 註冊商針對所有價格類型的擴展的常規零售定價。如果註冊商沒有活動的 promos。
pricesOriginal[pricetype] string 註冊商對擴展程式和 [pricetype] 的常規零售價，其中 [pricetype] 鍵register, renewal, transfer, restore, whoisprivacy。
promo object 表示已應用於此擴展的註冊商價格的促銷定價的物件。如果未應用促銷，則此欄位將不存在。促銷物件示例： 

__樣本__
promos array of objects RegistrarPromo 對象的陣列，表示註冊商為此擴展提供的所有有效促銷定價。
terms object 表示適用於註冊商定價的特殊條款的物件集合。如果沒有特殊條款適用，則此欄位將不存在。每個子物件都使用術語 ID 進行鍵控：

limitPerCustomer - 指定定價僅對每個客戶一定數量的域有效。
newCustomerOnly - 指定定價僅對新客戶有效。
affiliateLink - 指定定價僅在客戶通過會員鏈接訪問註冊商的網站時有效。
nameserverLockIn - 指定購買的域只能使用註冊商的名稱伺服器。
idSubmissionRequired - 指定客戶必須提交帶照片的身份證件或商業登記才能完成購買。

範例術語物件： 

__樣本__
terms[term].count number 術語限制客戶的數量。 例如，如果 ，則 count = 1客戶在指定價格下只能使用1個域。如果不適用，則此欄位將不存在。
terms[term].pricetype array of strings 該術語適用的價格類型：register, renewal, transfer。僅當未指定註冊器定價物件的價格類型時，此欄位才會出現。
notes object 表示與註冊商定價相關的註釋的物件集合。如果沒有定價說明，則此值將為空物件。每個子物件都使用註解 ID 進行鍵控：currencyExchangeRate, feeIcann, feeTax, feePayment
notes.feeIcann object 指定ICANN費用是否已添加到TLD的最終價格中（通常為0.18美元 USD）。如果存在此說明，則表示註冊商不會在其廣告價格中包含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 字串值指示該amountRate值'percent'為數位百分比。字串值'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 字串值指示該amountRate值'percent'為數位百分比。字串值'percent-varies-by-method'指示費用是一個百分比，因客戶的付款方式而異。
notes.feePayment.addedToListPrice boolean 指示計算出的費用金額是否已添加到最終價格中。
notes.currencyExchangeRate object 指定註冊商的價格以另一種國家/地區貨幣列出，並且已轉換為 USD。貨幣換算的詳細資訊表示為：

base：註冊商的定價貨幣為 3 個字母的代碼（即歐元）
quote：價格轉換為的貨幣（始終為 USD）
rate：用於進行貨幣轉換的匯率。

範例 currencyExchangeRate 註解物件： 

{
    "currencyExchangeRate": {
        "base": "GBP",
        "quote": "USD",
        "rate": "1.2482"
    }
}
threeYearValueScore number 價值的數位衡量標準，由定價和免費功能決定，通過註冊商擁有具有此擴展名的域名，為期 3 年。數位越大，提供的價值就越大。
currency string 定價數據的三個字母的 ISO 4217 貨幣代碼。此值目前僅為 USD。
freeFeatures array of objects 一組物件，表示註冊商通過域擁有權提供的免費功能。物件包括每個要素的數量和持續時間。每個物件都使用可用的功能代碼進行鍵控：

dns - 免費域名系統服務。
whois-privacy - WHOIS隱私服務。
email-account - 免費電子郵件帳戶。
email-forward - 免費電子郵件轉發。
ssl-cert - 免費的基本SSL證書。

範例自由特徵陣列： 

__樣本__
freeFeatures[].count number 註冊商免費提供的功能數量。如果此欄位不適用，則此欄位將不存在。
freeFeatures[].duration number 註冊商免費提供該功能的天數。如果為 duration = 365，則功能免費提供1年。如果不適用，則此欄位將不存在。

RegistrarPromo

描述註冊商提供的活動促銷。例： 

__樣本__
路徑 類型 說明
promo.code string 客戶必須在結帳時輸入的促銷代碼才能獲得折扣促銷。
promo.amount string 促銷定價的數字金額。根據促銷的類型，這可能是折扣價 （）、從正常價格中減去的金額 （pricediscount） 或從正常價格中減去的百分比金額 （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 回應物件可以包含一個或多個描述錯誤錯誤的物件。下面是可以在錯誤物件的 code 欄位中設置的識別錯誤代碼的非完整清單。

代碼 說明
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
速率限制 每 15 分鐘的最大請求數100
每個 API 金鑰的用戶端 IP 位址 每個金鑰每 1440 分鐘5個唯一的用戶端 IP 位址

擴展方法

get

返回附加資訊及其關聯的定價和詳細信息數據。此方法類似於檢索一個或多個 TLD 詳細資訊頁面上顯示的數據（例如， .com），但“最便宜的價格歷史記錄”數據除外，此方法不會返回這些數據（有關歷史數據，請參閱 getAggregateHistory 方法）。

介面連接點: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。如果省略，將返回頂級域名清單上列出的所有擴展名。

例: "extensions": ["com", "io", "co.uk", "移动", "xn--p1ai"]
includeFields array of strings 指定要按鍵名返回的某些數據。未在此參數中提交的金鑰將被省略。默認情況下，將返回所有可用欄位。有關 可用欄位的清單，請參閱回應表。不支援嵌套欄位。

例: "includeFields": ["name", "registrars", "dnssecSupported"]
excludeFields array of strings 指定要按鍵名稱排除的 cetain 數據。在此參數中提交的鍵將被省略。默認情況下，不排除任何欄位。有關 可用欄位的清單，請參閱回應表。不支援嵌套欄位。

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

要包含在結果中的活動註冊商的字串ID。使用 getIds 方法獲取頂級域名清單上主動列出的所有註冊商的 ID 清單。

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

要在結果中排除的活動註冊商的字串ID。使用 getIds 方法獲取頂級域名清單上主動列出的所有註冊商的 ID 清單。

例: "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 物件 start 和 end 日期時間範圍代表TLD's日出階段（商標所有人可以開始申請註冊適用功能變數名稱）。例： 

__樣本__
data[].available.trademark object 代表TLD's商標階段的物件 start 和 end 日期時間範圍（如果註冊了與其商標匹配的域名，商標資訊交換所將通知商標持有人的時間段）。例： 

__樣本__
data[].available.other array of objects 表示 TLD 的各個啟動階段及其日期時間範圍的物件陣列，例如“Land Rush”和“合格啟動計劃”。例： 

__樣本__
data[].average object 包含所包含註冊商的擴展平均價格（按價格類型）的物件。
data[].average[pricetype] string 擴展程式的平均價格，作為 [pricetype] 的數位字串，其中 [pricetype] 鍵register, renewal, transfer, restore, whoisprivacy。
data[].category string 頂級功能變數名稱已歸入的類別。陣列中的每個物件表示一個類別，並包含以下欄位：

id - 頂級域名清單內部使用的整數類別ID。
idstr - 備用字串類別 ID。
name - 英文類別名稱。
desc - 英文類別描述。

範例類別陣列： 

__樣本__
data[].dnssecSupported boolean 如果註冊表的 DNS 區域支援 DNS 安全擴展 （DNSSEC）。
data[].hasPremiumDomains object [pricetype] 鍵和布爾值的物件，表示註冊局是否對選定的“高級”域名收取更高的價格。例：

__樣本__
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 包含所包含註冊商的擴展的中位數價格（按價格類型）的物件。
data[].median[pricetype] string 擴展程式的中位數價格，作為 [pricetype] 的數位字串，其中 [pricetype] 鍵register, renewal, transfer, restore, whoisprivacy。
data[].name string 域擴展名的 Unicode 名稱。
data[].nameservers array 註冊機構的根名稱伺服器，用於存儲已註冊域的權威名稱伺服器。範例名稱伺服器陣列： 

__樣本__
data[].parentTld string 擴展程式的父頂級域。如果這是 TLD，則此欄位將不存在。
data[].pricingUpdated string 上次檢查和更新 TLD's 註冊商定價的 ISO 8601 日期時間（UTC 時區）。 注意： 新 updated.pricing 日期並不一定表示發生了任何數據更改。它僅指示上次檢查和設置數據的時間。
data[].punycode string 域擴展名的 Punycode 名稱。僅適用於IDN擴展。
data[].registerMaxYears integer 購買時功能變數名稱可以註冊的最長年限。
data[].registerMinYears integer 功能變數名稱在購買時可以註冊的最短年限。
data[].registrarsIncluded integer 返回 registrars 的陣列中包含的註冊器計數。
data[].registrarsTotal integer 銷售擴展的活躍註冊商總數。
data[].registrars array of objects 包含註冊商定價和功能數據的 註冊商定價 對象的陣列。
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管理組織的實際位置。範例地址陣列： 

__樣本__
data[].sponsorParentCompany string 在發起組織中擁有控股權益的實體的名稱。
data[].romanized string 頂級功能變數名稱轉錄為拉丁字元。如果語言基於英語或未知，則此欄位將不存在。
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 已基於英語，或者翻譯未知，則此值將不存在。
data[].type string 由以下字串之一標識的 TLD 類型：

gTLD: 通用頂級域。
ccTLD: 國家/地區代碼頂級功能變數名稱。
grTLD: 受通用限制的頂級域。
sTLD: 讚助頂級功能變數名稱。
data[].wholesale object 按價格類型包含擴展的批發價格的物件。批發價格是註冊局就域名購買向註冊商收取的價格。
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

返回所有擴展名。

介面連接點:https://api.tld-list.com/v1/extension/getNames

回應時間:~1 second

請求參數

鑰匙 類型 必填 說明
omitExtensionsWithoutRegistrars boolean 當 true時，結果中沒有註冊商定價數據的擴展將被省略。預設值為 false。
wantPunycode boolean 將所有返回的IDN擴展編碼為punycode而不是 unicode。預設值為 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

返回最便宜的註冊商/供應商、其定價、中位數價格和每個域名後綴的平均價格。未由任何註冊商出售的擴展不會退還。

介面連接點: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。如果省略，將返回頂級域名清單上列出的所有擴展名。

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

在確定最便宜的價格和匯總計算時要包含的活動註冊商的字串ID。此參數中未指定的註冊器將被忽略。使用 getIds 方法獲取頂級域名清單上活躍列出的所有註冊商的清單。

如果省略此參數，則將考慮頂級域名清單上活躍的所有註冊商。

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

在確定最便宜的定價和匯總計算時要排除的活動註冊商的字串ID。將考慮此參數中未指定的所有註冊商。使用 getIds 方法獲取頂級域名清單上活躍列出的所有註冊商的清單。

如果省略此參數，則不會忽略任何註冊器。

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

當 true時，結果中沒有註冊商定價數據的擴展將被省略。當傳遞 excludeRegistrars 的和/或 includeRegistrars 參數導致通常具有註冊商定價數據的擴展沒有匹配的註冊商定價數據時，就會發生這種情況。默認情況下包含這些擴展，但其定價數據為空陣列。設置為 以 true 從結果中省略這些擴展。

例: "omitExtensionsWithoutRegistrars": true

回應物件

路徑 類型 說明
data array of objects 對象陣列，每個物件表示一個域擴展名。
data[].name string 域擴展名的 Unicode 名稱。
data[].punycode string 域擴展名的 Punycode 名稱。僅適用於IDN擴展。
data[].currency string 定價數據的三個字母的 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] 列出的最便宜的註冊商，其中 [pricetype] 鍵register, renewal, transfer。

此數據是一個數位，因為擴展的最便宜價格可能是多個註冊商提供的價格。

示例請求/回應

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唯一標識頂級域名清單上主動列出的註冊商。

介面連接點: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"
}