Skip to content

Check a prefix

GEThttps://api.vidmoat.com/v1/interactive-sites/availability
Bearer tokenScope projects.readFreeTry it in the playground

Whether a prefix is allowed and free for this account, and if not, why.

Query parameters#

  • prefixstringrequired
    The name to check.

Response#

Returns 200.

Response fields#

  • availableboolean
    Whether it can be taken.
  • prefixstring
    The name as it would be stored (lower case).
  • codestring
    When not: shape, length, punycode, reserved, brand, phishing, taken, held or yours.
  • reasonstring
    When not: why, in a sentence.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
429rate_limitedMore than 40 checks in 10 minutes on the account.