TLDs API

TLD attributes

Name Type Description
tld string the registerable suffix. In most cases the suffix matches a TLD, but there are some cases where the suffix is a subzone of the TLD (e.g. com.au).
tld_type integer the type of TLD. See TLD types.
minimum_registration integer the minimum RTR period, in years.
whois_privacy bool true if the suffix allows WHOIS privacy as a separate component. Some registries may provide WHOIS privacy at registry level, such as the .IO or .UK.
auto_renew_only bool true if the suffix requires auto-renewal and can’t be renewed manually.
idn bool true if the suffix supports Internationalized Domain Names (IDN).
registration_enabled bool true if DNSimple supports registrations for this TLD.
renewal_enabled bool true if DNSimple supports renewals for this TLD.
transfer_enabled bool true if DNSimple supports inbound transfers for this TLD.

TLD Types

Value Description
1 gTLD (global TLD)
2 ccTLD (country-code TLD)
3 newTLD (new global TLD)

List TLDs

GET /tlds

Example

List all TLDs.

curl -H 'Authorization: Bearer <token>' \
     -H 'Accept: application/json' \
     https://api.dnsimple.com/v2/tlds

Response

{
  "data": [
    {
      "tld": "ac",
      "tld_type": 2,
      "whois_privacy": false,
      "auto_renew_only": true,
      "idn": false,
      "minimum_registration": 1,
      "registration_enabled": true,
      "renewal_enabled": true,
      "transfer_enabled": false
    },
    {
      "tld": "academy",
      "tld_type": 3,
      "whois_privacy": true,
      "auto_renew_only": false,
      "idn": true,
      "minimum_registration": 1,
      "registration_enabled": true,
      "renewal_enabled": true,
      "transfer_enabled": true
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 2,
    "total_entries": 195,
    "total_pages": 98
  }
}

Sorting

For general information about sorting, please refer to the main guide.

Name Description
tld Sort TLDs by tld

The default sorting policy is by ascending tld.

Get TLD details

GET /tlds/:tld

Parameters

Name Type Description
:tld string The TLD name

Example

Get the TLD with name "com".

curl -H 'Authorization: Bearer <token>' \
     -H 'Accept: application/json' \
     https://api.dnsimple.com/v2/tlds/com

Response

{
  "data": {
    "tld": "com",
    "tld_type": 1,
    "whois_privacy": true,
    "auto_renew_only": false,
    "idn": true,
    "minimum_registration": 1,
    "registration_enabled": true,
    "renewal_enabled": true,
    "transfer_enabled": true
  }
}

Get TLD Extended Attributes

GET /tlds/:tld/extended_attributes

Some TLDs require extended attributes when registering or transferring a domain. This API interface provides information on the extended attributes for any particular TLD.

Extended attributes are extra TLD-specific attributes, required by the TLD registry to collect extra information about the registrant or legal agreements.

Parameters

Name Type Description
:tld string The TLD name

Example

Get extended attributes for TLD with name "com".

curl -H 'Authorization: Bearer <token>' \
     -H 'Accept: application/json' \
     https://api.dnsimple.com/v2/tlds/com/extended_attributes

Response

{
  "data": [
    {
      "name": "uk_legal_type",
      "description": "Legal type of registrant contact",
      "required": false,
      "options": [
        {
          "title": "UK Individual",
          "value": "IND",
          "description": "UK Individual (our default value)"
        },
        {
          "title": "Non-UK Individual (representing self)",
          "value": "FIND",
          "description": "Non-UK Individual (representing self)"
        },
        {
          "title": "UK Limited Company",
          "value": "LTD",
          "description": "UK Limited Company"
        },
        {
          "title": "UK Public Limited Company",
          "value": "PLC",
          "description": "UK Public Limited Company"
        },
        {
          "title": "UK Partnership",
          "value": "PTNR",
          "description": "UK Partnership"
        },
        {
          "title": "UK LLP",
          "value": "LLP",
          "description": "UK Limited Liability Partnership"
        },
        {
          "title": "UK Sole Trader",
          "value": "STRA",
          "description": "UK Sole Trader"
        },
        {
          "title": "UK Registered Charity",
          "value": "RCHAR",
          "description": "UK Registered Charity"
        },
        {
          "title": "UK Industrial/Provident Registered Company",
          "value": "IP",
          "description": "UK Industrial/Provident Registered Company"
        },
        {
          "title": "UK School",
          "value": "SCH",
          "description": "UK School"
        },
        {
          "title": "Other Foreign",
          "value": "FOTHER",
          "description": "Other foreign organizations"
        },
        {
          "title": "UK Government Body",
          "value": "GOV",
          "description": "UK Government Body"
        },
        {
          "title": "UK Corporation by Royal Charter",
          "value": "CRC",
          "description": "UK Corporation by Royal Charter"
        },
        {
          "title": "UK Statutory Body",
          "value": "STAT",
          "description": "UK Statutory Body"
        },
        {
          "title": "UK Entity (other)",
          "value": "OTHER",
          "description": "UK Entity (other)"
        },
        {
          "title": "Non-UK Corporation",
          "value": "FCORP",
          "description": "Non-UK Corporation"
        },
        {
          "title": "Non-UK Organization (other)",
          "value": "FOTHER",
          "description": "Non-UK Organization"
        }
      ]
    },
    {
      "name": "uk_reg_co_no",
      "description": "Company identification number",
      "required": false,
      "options": [

      ]
    },
    {
      "name": "registered_for",
      "description": "Company or person domain is registered for (this must be accurate and CANNOT BE CHANGED)",
      "required": true,
      "options": [

      ]
    },
    {
      "name": "uk_reg_opt_out",
      "description": "Hide registrant data in Nominet WHOIS",
      "required": false,
      "options": [
        {
          "title": "No",
          "value": "n",
          "description": "Do not hide the registrant contact information in Nominet's WHOIS."
        },
        {
          "title": "Yes",
          "value": "y",
          "description": "Hide the registrant contact information in Nominet's WHOIS (only available to individuals)."
        }
      ]
    }
  ]
}