Check the availability of one or more domains

Check if a domain name is available for purchase. You can check multiple domains at once.

GET /domains/status

PHP

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();



$response = $sdk->domains->checkStatus(
    domains: '<value>'
);

if ($response->responseBodies !== null) {
    // handle response
}

package main

import(
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := dubgo.New(
        dubgo.WithSecurity("DUB_API_KEY"),
    )

    res, err := s.Domains.CheckStatus(ctx, operations.CheckDomainStatusRequest{
        Domains: operations.CreateDomainsStr(
            "<value>",
        ),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

require 'dub'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Dub.new(
  security: Models::Shared::Security.new(
    token: 'DUB_API_KEY'
  )
)

req = Models::Operations::CheckDomainStatusRequest.new(
  domains: '<value>'
)
res = s.domains.check_status(request: req)

unless res.nil?
  # handle response
end

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.domains.checkStatus({
    domains: "<value>",
  });

  console.log(result);
}

run();

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.domains.check_status(request={
        "domains": "<value>",
    })

    # Handle response
    print(res)

curl --request GET \
  --url https://api.dub.co/domains/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dub.co/domains/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.get("https://api.dub.co/domains/status")
  .header("Authorization", "Bearer <token>")
  .asString();

200

[
  {
    "domain": "<string>",
    "available": true,
    "price": "<string>",
    "premium": true
  }
]

{
  "error": {
    "code": "bad_request",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#bad-request"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#forbidden"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#not-found"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#conflict"
  }
}

{
  "error": {
    "code": "invite_expired",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"
  }
}

{
  "error": {
    "code": "internal_server_error",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"
  }
}

Domain registration is only available for certain Enterprise customers. Please contact us to get access.

Authorizations

Authorization · string · header · required

Default authentication mechanism

Query Parameters

domains · string string[] · required

The domains to search. We only support .link domains for now.

Response

200

application/json

The domain status was retrieved.

domain · string · required

The domain name.

available · boolean · required

Whether the domain is available.

price · string | null · required

The price description.

premium · boolean | null · required

Whether the domain is a premium domain.