Skip to main content

Domain

Check Domain Availability


Endpoint: /api/reseller/domain/check-availability

Method: POST

Request Parameters

Parameters

Type

Description

username

string


api_key

string


domain

string

It Should be valid domain

Response Parameters

Parameters

Type

Description

success

boolean (true, false)


message

string


errors

array

It will only be returned if success is false

data

array

It will only be returned when success is true

Example Request

{
  "username" : "test@navicosoft.com",
  "api_key" : "^H^HHGTG******)((",
  "domain" : "domain.com"
}

Example Response

Success

If is available is true then the domain is available and if it is false then it is not available

{
  "success": true,
  "message": "Domain availability checked",
  "data": {
    "domain": "domain.com",
    "is_available": true,
    "price": 20
  }
}

Response code 200

Errors

{
  "success": false,
  "message": "Validation Error",
  "errors": [
    "The domain field is required."
  ]
}

Response Code 422

If the given domain is incorrect or not properly formatted then this error will occur

Correct domain formats are eg. ( domain.com, domain.co.uk )

Incorrect domain formats eg. ( domain, www.domain.com, https://domian.com )

{
  "success": false,
  "message": "The given data is invalid.",
  "errors": [
    "The domain field format is invalid."
  ]
}

Response code 422

{
  "success": false,
  "message": "Whois lookup failed",
  "errors": []
}

Response code 401