# Search

Searches for domain name suggestions based on a keyword or term. Important: Do not encode the  in the path. Use , not .

Endpoint: POST /core/v1/domains:search
Version: 1.3.1
Security: BasicAuth

## Request fields (application/json):

  - `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` (array)
    TLDFilter will limit results to only contain the specified TLDs. There is a maximum of 50 TLDs that can be used in this filter
    Example: ["com","net","org"]

## Response 200 fields (application/json):

  - `results` (array)
    Results of the search are returned here, the order should not be relied upon.

  - `results.domainName` (string, required)
    DomainName is the punycode encoding of the result domain name.
    Example: "example.com"

  - `results.premium` (boolean)
    Premium indicates that this search result is a premium result and the purchase_price needs to be passed to the DomainCreate command. This parameter will only be returned for domains that are purchasable.
    Example: true

  - `results.purchasable` (boolean, required)
    Purchasable indicates whether the search result is available for purchase.
    Example: true

  - `results.purchasePrice` (number)
    PurchasePrice is the price for purchasing this domain for the minimum time period (typically 1 year). Purchase_price is always in USD. This parameter will only be returned for domains that are purchasable.
    Example: 10.99

  - `results.purchaseType` (string)
    PurchaseType indicates what kind of purchase this result is for. It should be passed to the DomainCreate command. This parameter will only be returned for domains that are purchasable.
    Example: "registration"

  - `results.renewalPrice` (number)
    RenewalPrice is the annual renewal price for this domain as it may be different than the purchase_price. This parameter will only be returned for domains that are purchasable.
    Example: 10.99

  - `results.sld` (string, required)
    SLD is first portion of the domain_name.
    Example: "example"

  - `results.tld` (string, required)
    TLD is the rest of the domain_name after the SLD.
    Example: "com"

## Response 400 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Bad Request"

  - `details` (string,null)
    Additional context or information about the error
    Example: "'domainName' cannot be null"

## Response 415 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error
    Example: "The 'Content-Type' header must be 'application/json' for this request."

## Response 429 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Rate Limit Exceeded"

## Response 500 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error.
    Example: "Internal Server Error"

  - `details` (string,null)
    Additional context or information about the error.
    Example: "Something went wrong."