TLDs

Download schema

Endpoints for listing TLDs.

List TLDs

GET

https://domain.chief.app/api/v1

/tlds

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List all registerable TLDs.

List TLDs › query Parameters

query

string · minLength: 1

Search query.

sort

string[] · maxItems: 5 · style: form

Sort by up to five fields, separated by commas. Prefix a field with - for descending order.

Enum values:

name

-name

order

-order

Default: ["order"]

page

integer · min: 1

Default: 1

per_page

integer · min: 1 · max: 100

Default: 50

List TLDs › Responses

Paginated set of TLD

TLD[] · required

object · required

GET/tlds

curl https://domain.chief.app/api/v1/tlds \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "name": "eu",
      "unicode_name": "eu",
      "handle_types": [
        "owner",
        "admin",
        "tech",
        "billing"
      ],
      "transfer_type": "transfer_type",
      "transfer_authorization": "transfer_authorization",
      "auth_code_validity_days": 5,
      "transfer_description": "You need the authorization code from the current registrar to transfer a .music domain.",
      "registration_price": 826,
      "renewal_price": 826,
      "transfer_price": 826,
      "is_converted_currency": true,
      "supports_dnssec": true,
      "supports_idn": true,
      "minimum_label_length": 0,
      "maximum_label_length": 0,
      "supported_dnssec_algorithms": [
        13
      ],
      "supports_whois_privacy": true,
      "whois_disclosure": "whois_disclosure",
      "whois_privacy_description": "Not needed, the registry does not publish registrant details",
      "is_trade_required": true,
      "is_auth_code_available": true,
      "requires_intended_use": true,
      "requirements": [
        {
          "type": "type",
          "operations": [
            "registration"
          ],
          "handle_types": [
            "owner"
          ],
          "description": "A .ie domain only works for registrants who can prove a connection to Ireland.",
          "url": "https://www.example.com/path/to/resource"
        }
      ]
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "url",
        "label": "label",
        "active": true
      }
    ],
    "path": "path",
    "per_page": 0,
    "to": 1,
    "total": 0
  }
}

json

application/json

Show TLD

GET

https://domain.chief.app/api/v1

/tlds/{tldName}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show a single registerable TLD.

Show TLD › path Parameters

tldName

string · required

Show TLD › Responses

TLD

TLD · required

GET/tlds/{tldName}

curl https://domain.chief.app/api/v1/tlds/:tldName \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "name": "eu",
    "unicode_name": "eu",
    "handle_types": [
      "owner",
      "admin",
      "tech",
      "billing"
    ],
    "transfer_type": "transfer_type",
    "transfer_authorization": "transfer_authorization",
    "auth_code_validity_days": 5,
    "transfer_description": "You need the authorization code from the current registrar to transfer a .music domain.",
    "registration_price": 826,
    "renewal_price": 826,
    "transfer_price": 826,
    "is_converted_currency": true,
    "supports_dnssec": true,
    "supports_idn": true,
    "minimum_label_length": 0,
    "maximum_label_length": 0,
    "supported_dnssec_algorithms": [
      13
    ],
    "supports_whois_privacy": true,
    "whois_disclosure": "whois_disclosure",
    "whois_privacy_description": "Not needed, the registry does not publish registrant details",
    "is_trade_required": true,
    "is_auth_code_available": true,
    "requires_intended_use": true,
    "requirements": [
      {
        "type": "type",
        "operations": [
          "registration"
        ],
        "handle_types": [
          "owner"
        ],
        "description": "A .ie domain only works for registrants who can prove a connection to Ireland.",
        "url": "https://www.example.com/path/to/resource"
      }
    ]
  }
}

json

application/json

Team