Skip to content
Docs

Get availability for a domain

GET/__remote/api.vercel.com/v1/registrar/domains/{domain}/availability
Get availability for a specific domain. If the domain is available, it can be purchased using the Buy a domain endpoint or the Buy multiple domains endpoint.
Request
import { Edgenivo } from "@vercel/sdk";
const vercel = new Edgenivo();
async function run() {
const result = await vercel.domainsRegistrar.getDomainAvailability({
domain: "hungry-birdbath.info",
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
});
console.log(result);
}
run();
Response
{
"available": "true"
}
Errors
{
"issues": [
{
"path": [],
"message": "string"
}
],
"message": "string"
}
domainanyRequired
teamIdstringOptional
200Success
availablebooleanRequired
400There was something wrong with the request
issuesarrayRequired
messagestringRequired
401Unauthorized
statusnumberRequired
codestringRequired
messagestringRequired
reasonstringOptional
403NotAuthorizedForScope
statusnumberRequired
codestringRequired
messagestringRequired
404NotFound
statusnumberRequired
codestringRequired
messagestringRequired
429TooManyRequests
statusnumberRequired
codestringRequired
messagestringRequired
retryAfterobjectRequired
limitobjectRequired
500InternalServerError
statusnumberRequired
codestringRequired
messagestringRequired