Skip to content
Docs

Get availability for multiple domains

POSThttps://api.vercel.com/v1/registrar/domains/availability
Get availability for multiple domains. If the domains are available, they can be purchased using the Buy a domain endpoint or the Buy multiple domains endpoint.
https://api.vercel.com/v1/registrar/domains/availability
const response = await fetch('https://api.vercel.com/v1/registrar/domains/availability?teamId=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "domains": []
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "results": [
    {
      "domain": "string",
      "available": "true"
    }
  ]
}
Errors
{
  "issues": [
    {
      "path": [],
      "message": "string"
    }
  ],
  "message": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional

Body

application/json
domainsarrayRequired
an array of at most 50 item(s)

Response

200Success
resultsarrayRequired

Errors

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