Skip to content
Docs

Get TLD

GEThttps://api.vercel.com/v1/registrar/tlds/{tld}
Get the metadata for a specific TLD.
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.domainsRegistrar.getTld({
    tld: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
  });


  console.log(result);
}


run();
Response
{
  "supportedLanguageCodes": {}
}
Errors
{
  "status": "400",
  "code": "tld_not_supported",
  "message": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

tldanyRequired

Query parameters

teamIdstringOptional

Response

200Success
supportedLanguageCodesobjectRequired
The language codes that are supported for the TLD. The key is the language code, and the value is the name of the language.

Errors

400There was something wrong with the request
statusnumberRequired
codestringRequired
messagestringRequired
401Unauthorized
statusnumberRequired
codestringRequired
messagestringRequired
reasonstringOptional
403NotAuthorizedForScope
statusnumberRequired
codestringRequired
messagestringRequired
429TooManyRequests
statusnumberRequired
codestringRequired
messagestringRequired
retryAfterobjectRequired
limitobjectRequired
500InternalServerError
statusnumberRequired
codestringRequired
messagestringRequired