Programmatic Domain Management

The domains registrar API enables you to programmatically manage your domain lifecycle from search to renewal.

You can start using the REST API by:

1. Creating a token

2. Using the token in either of the following ways:

   • Use the Vercel SDK

   In the following example, use the Vercel SDK to get the supported TLDs.

   index.ts

   import { Vercel } from '@vercel/sdk';
    
   const vercel = new Vercel({
     bearerToken: '<YOUR_BEARER_TOKEN_HERE>',
   });
    
   const result = await vercel.domainsRegistrar.getSupportedTlds();

   • Use the language of your choice by calling the endpoints directly and providing your token.

   In the following example, we use cURL to get the supported TLDs.

   terminal

   curl --request GET \
     --url https://api.vercel.com/v1/registrar/tlds/supported \
     --header 'Authorization: Bearer <token>'

You can use the domains registrar API to do the following:

• List all supported top-level domains (TLDs)
• Get pricing for specific TLDs
• Retrieve per-domain pricing information

• Check single domain availability
• Perform bulk availability checks for multiple domains

• Purchase a domain
• Execute bulk domain purchases
• Fetch order status by ID

• Retrieve authorization codes for domain transfers
• Initiate domain transfers to Vercel
• Track transfer status and completion

• Renew domains before expiration
• Enable or disable automatic renewal
• Update nameserver configurations
• Fetch TLD-specific contact information schemas

The following legacy domains API endpoints are now deprecated and will be sunset on November 8, 2025:

• Purchase a domain
• Check the price for a domain
• Check a Domain Availability
• Get domain transfer info

If you are currently using the Vercel CLI for domain purchases, pricing, or availability, upgrade to CLI version 48.2.8 or later.