domains

Check a Domain Availability

Check if a domain name is available for purchase.

Query Parameters
  • name
    string
    required

    The name of the domain for which we would like to check the status.

    Exampleexample.com
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

  • 500
GET/v4/domains/status
fetch('https://api.vercel.com/v4/domains/status?name=example.com')
{
  "available": true
}

Check the price for a domain

Check the price to purchase a domain and how long a single purchase period is.

Query Parameters
  • name
    string
    required

    The name of the domain for which the price needs to be checked.

    Exampleexample.com
  • type
    string enum

    In which status of the domain the price needs to be checked.

    Examplenew
    • new
    • renewal
    • transfer
    • redemption
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

GET/v4/domains/price
fetch('https://api.vercel.com/v4/domains/price?name=example.com')
{
  "price": 20,
  "period": 1
}
v0.0.1
OAS 3.0.3

Vercel REST API

The Vercel REST API is a REST-styled API that gives you full control over the entire Vercel platform. You can use it with any programming language or framework that can send HTTP requests. You need to authenticate with a Vercel access token for every request.

Production API

No authentication selected
Client Libraries

Models