POST /store/domain/suggestions

Query a list of domain suggestions.

Request

Base URL
https://developers.whmcs.com/api/v2
Auth
none declared

Query parameters

pageinteger

Example:1

Page number

page_sizeinteger

Example:10

Number of items per page. The maximum allowed value is 500. The default value is 50.

Request body

termstring required

domain, keyword, or phrase to use as the basis for suggestions depending on the Lookup Provider capabilities

tldsstring[] nullable

an optional array of top level domains (TLDs) to check for suggestions (not all Lookup Providers support this)

maximum_lengthinteger nullable

the optional maximum number of characters for the suggested domain names (not all Lookup Providers support this)

filter_sensitive_contentboolean nullable

whether to filter out sensitive words from the suggestions (not all Lookup Providers support this)

Example request

{
  "term": "example.com, example, or 'A automotive repair shop in New York'",
  "tlds": [
    "com"
  ],
  "maximum_length": 10
}

Response

Success

Example response

{
  "meta": {
    "total_items": 10,
    "page": 1,
    "total_pages": 1,
    "page_size": 50
  },
  "data": [
    {
      "pricing": [
        {
          "register": {
            "value": "19.99",
            "code": "USD",
            "display_value": "$19.99 USD",
            "prefix": "$",
            "suffix": " USD"
          },
          "transfer": {
            "value": "19.99",
            "code": "USD",
            "display_value": "$19.99 USD",
            "prefix": "$",
            "suffix": " USD"
          },
          "renew": {
            "value": "19.99",
            "code": "USD",
            "display_value": "$19.99 USD",
            "prefix": "$",
            "suffix": " USD"
          }
        }
      ],
      "shortest_period": {
        "register": {
          "value": "19.99",
          "code": "USD",
          "display_value": "$19.99 USD",
          "prefix": "$",
          "suffix": " USD"
        },
        "transfer": {
          "value": "19.99",
          "code": "USD",
          "display_value": "$19.99 USD",
          "prefix": "$",
          "suffix": " USD"
        },
        "renew": {
          "value": "19.99",
          "code": "USD",
          "display_value": "$19.99 USD",
          "prefix": "$",
          "suffix": " USD"
        }
      },
      "premium_cost_pricing": {
        "register": {
          "value": "19.99",
          "code": "USD",
          "display_value": "$19.99 USD",
          "prefix": "$",
          "suffix": " USD"
        },
        "transfer": {
          "value": "19.99",
          "code": "USD",
          "display_value": "$19.99 USD",
          "prefix": "$",
          "suffix": " USD"
        },
        "renew": {
          "value": "19.99",
          "code": "USD",
          "display_value": "$19.99 USD",
          "prefix": "$",
          "suffix": " USD"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.