Skip to main content
POST
/
core
/
v1
/
domains:search
Search
curl --request POST \
  --url https://api.dev.name.com/core/v1/domains:search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "keyword": "mydomain",
  "timeout": 2500,
  "tldFilter": [
    "com",
    "net",
    "org"
  ]
}'
{
  "results": [
    {
      "domainName": "example.com",
      "premium": true,
      "purchasable": true,
      "purchasePrice": 10.99,
      "purchaseType": "registration",
      "renewalPrice": 10.99,
      "sld": "example",
      "tld": "com"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Body

application/json

SearchRequest is used to specify the search parameters.

​
keyword
string
required

Keyword is the search term to search for. It can be just a word, or a whole domain name.

Example:

"mydomain"

​
timeout
integer

Timeout is a value in milliseconds on how long to perform the search for. Valid timeouts are between 500ms to 12,000ms. If not specified, timeout defaults to 12,000ms. Since some additional processing is performed on the results, a response may take longer then the timeout.

Example:

2500

​
tldFilter
string[]

TLDFilter will limit results to only contain the specified TLDs. There is a maximum of 50 TLDs that can be used in this filter

Maximum length: 50
Example:
["com", "net", "org"]

Response

A successful response.

SearchResponse returns a list of search results.

​
results
object[]

Results of the search are returned here, the order should not be relied upon.

⌘I