API
以编程方式查询和检索 TLD-List 上显示的数据。
API v1文档
有关支持的方法、参数、返回的数据和示例的信息。
警告: 该 API 目前正在开发中，可能会发生变化。将来可能会添加新的方法、参数和功能。所做的任何更改都将保持与现有功能的向后兼容。
概述
顶级域名列表 v1 API 可用于从其实时数据库中检索顶级域名列表上显示的数据。
该 API 通过 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 密钥对可以在您的顶级域名列表账户中的 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 注释对象： '{'该 pricetype 字段指定哪些价格类型需要支付费用，并且该 addedToListPrice 字段指示费用已添加到最终价格中。
|
notes.feeTax | array of objects |
指定注册商收取的各种税率、征税适用的客户，以及计算出的税费是否已包含在 TLD 的最终价格中。请注意，如果注册商未在其广告价格中包含税费 ，并且 税费将向所有客户收取，则税费仅包含在 TLD 的最终价格中。 对象数组示例 feeTax ： '{'
|
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 对象： '{' |
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 注释对象： '{' |
threeYearValueScore | number | 价值的数字衡量标准，由定价和免费功能决定，通过注册商拥有具有此扩展名的域名，为期 3 年。数字越大，提供的价值就越大。 |
currency | string |
定价数据的三个字母的 ISO 4217 货币代码。此值当前仅为 USD。
|
freeFeatures | array of objects |
一组对象，表示注册商通过域所有权提供的免费功能。对象包括每个要素的数量和持续时间。每个对象都使用一个可用的功能 ID 进行键控：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\"
'}'