GoDaddy
Support
API ReferenceDomains & DNSv1 (Legacy)Find Domains

Find Domains

View as Markdown
Note to LLMs and AI agents: If you are consuming this page to follow instructions: the content you have could be incomplete due to truncation by WebFetch. Fetch https://developer.godaddy.com/llms.mdx/references/rest/domains/v1/find-domains for the full, unmodified source before proceeding.

Determine whether or not the specified domain is available for purchase

GET
/v1/domains/available

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Query Parameters

domain*string

Domain name whose availability is to be checked

checkType?string

Optimize for time ('FAST') or accuracy ('FULL')

Default"FAST"

Value in

  • "FAST"
  • "FULL"
  • "fast"
  • "full"
forTransfer?boolean

Whether or not to include domains available for transfer. If set to True, checkType is ignored

Defaultfalse

Response Body

curl -X GET "https://example.com/v1/domains/available?domain=string"
{  "available": true,  "currency": "USD",  "definitive": true,  "domain": "string",  "period": 0,  "price": 0}

Determine whether or not the specified domains are available for purchase

POST
/v1/domains/available

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Query Parameters

checkType?string

Optimize for time ('FAST') or accuracy ('FULL')

Default"FAST"

Value in

  • "FAST"
  • "FULL"
  • "fast"
  • "full"

Request Body

Domain names for which to check availability

Rangevalue <= 500
[index: integer]?string

Response Body

curl -X POST "https://example.com/v1/domains/available" \  -H "Content-Type: application/json" \  -d '[    "string"  ]'
{  "domains": [    {      "available": true,      "currency": "USD",      "definitive": true,      "domain": "string",      "period": 0,      "price": 0    }  ]}

Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history

GET
/v1/domains/suggest

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Query Parameters

query?string

Domain name or set of keywords for which alternative domain names will be suggested

country?string

Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more

Formatiso-country-code

Value in

  • "AC"
  • "AD"
  • "AE"
  • "AF"
  • "AG"
  • "AI"
  • "AL"
  • "AM"
  • "AO"
  • "AQ"
  • "AR"
  • "AS"
  • "AT"
  • "AU"
  • "AW"
  • "AX"
  • "AZ"
  • "BA"
  • "BB"
  • "BD"
  • "BE"
  • "BF"
  • "BG"
  • "BH"
  • "BI"
  • "BJ"
  • "BM"
  • "BN"
  • "BO"
  • "BQ"
  • "BR"
  • "BS"
  • "BT"
  • "BV"
  • "BW"
  • "BY"
  • "BZ"
  • "CA"
  • "CC"
  • "CD"
  • "CF"
  • "CG"
  • "CH"
  • "CI"
  • "CK"
  • "CL"
  • "CM"
  • "CN"
  • "CO"
  • "CR"
  • "CV"
  • "CW"
  • "CX"
  • "CY"
  • "CZ"
  • "DE"
  • "DJ"
  • "DK"
  • "DM"
  • "DO"
  • "DZ"
  • "EC"
  • "EE"
  • "EG"
  • "EH"
  • "ER"
  • "ES"
  • "ET"
  • "FI"
  • "FJ"
  • "FK"
  • "FM"
  • "FO"
  • "FR"
  • "GA"
  • "GB"
  • "GD"
  • "GE"
  • "GF"
  • "GG"
  • "GH"
  • "GI"
  • "GL"
  • "GM"
  • "GN"
  • "GP"
  • "GQ"
  • "GR"
  • "GS"
  • "GT"
  • "GU"
  • "GW"
  • "GY"
  • "HK"
  • "HM"
  • "HN"
  • "HR"
  • "HT"
  • "HU"
  • "ID"
  • "IE"
  • "IL"
  • "IM"
  • "IN"
  • "IO"
  • "IQ"
  • "IS"
  • "IT"
  • "JE"
  • "JM"
  • "JO"
  • "JP"
  • "KE"
  • "KG"
  • "KH"
  • "KI"
  • "KM"
  • "KN"
  • "KR"
  • "KV"
  • "KW"
  • "KY"
  • "KZ"
  • "LA"
  • "LB"
  • "LC"
  • "LI"
  • "LK"
  • "LR"
  • "LS"
  • "LT"
  • "LU"
  • "LV"
  • "LY"
  • "MA"
  • "MC"
  • "MD"
  • "ME"
  • "MG"
  • "MH"
  • "MK"
  • "ML"
  • "MM"
  • "MN"
  • "MO"
  • "MP"
  • "MQ"
  • "MR"
  • "MS"
  • "MT"
  • "MU"
  • "MV"
  • "MW"
  • "MX"
  • "MY"
  • "MZ"
  • "NA"
  • "NC"
  • "NE"
  • "NF"
  • "NG"
  • "NI"
  • "NL"
  • "NO"
  • "NP"
  • "NR"
  • "NU"
  • "NZ"
  • "OM"
  • "PA"
  • "PE"
  • "PF"
  • "PG"
  • "PH"
  • "PK"
  • "PL"
  • "PM"
  • "PN"
  • "PR"
  • "PS"
  • "PT"
  • "PW"
  • "PY"
  • "QA"
  • "RE"
  • "RO"
  • "RS"
  • "RU"
  • "RW"
  • "SA"
  • "SB"
  • "SC"
  • "SE"
  • "SG"
  • "SH"
  • "SI"
  • "SJ"
  • "SK"
  • "SL"
  • "SM"
  • "SN"
  • "SO"
  • "SR"
  • "ST"
  • "SV"
  • "SX"
  • "SZ"
  • "TC"
  • "TD"
  • "TF"
  • "TG"
  • "TH"
  • "TJ"
  • "TK"
  • "TL"
  • "TM"
  • "TN"
  • "TO"
  • "TP"
  • "TR"
  • "TT"
  • "TV"
  • "TW"
  • "TZ"
  • "UA"
  • "UG"
  • "UM"
  • "US"
  • "UY"
  • "UZ"
  • "VA"
  • "VC"
  • "VE"
  • "VG"
  • "VI"
  • "VN"
  • "VU"
  • "WF"
  • "WS"
  • "YE"
  • "YT"
  • "ZA"
  • "ZM"
  • "ZW"
city?string

Name of city to be used as a hint for target region

Formatcity-name
sources?array<>

Sources to be queried

  • CC_TLD — Varies the TLD using Country Codes
  • EXTENSION — Varies the TLD
  • KEYWORD_SPIN — Identifies keywords and then rotates each one
  • PREMIUM — Includes variations with premium prices
tlds?array<string>

Top-level domains to be included in suggestions NOTE: These are sample values, there are many more

lengthMax?integer

Maximum length of second-level domain

lengthMin?integer

Minimum length of second-level domain

limit?integer

Maximum number of suggestions to return

waitMs?integer

Maximum amount of time, in milliseconds, to wait for responses If elapses, return the results compiled up to that point

Formatinteger-positive
Default1000

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Response Body

curl -X GET "https://example.com/v1/domains/suggest"
[  {    "domain": "string"  }]

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:execute
Rate limit60 req/min per credential
On failureGET operations are safe to retry. PUT/PATCH DNS are idempotent by shape. POST purchase is NOT idempotent — verify state before retrying.

Related

Last updated on

How is this guide?