# Query a list of domain suggestions.

Query a list of domain suggestions.

Endpoint: POST /store/domain/suggestions
Version: 2.0.0

## Query parameters:

  - `page` (integer)
    Page number
    Example: 1

  - `page_size` (integer)
    Number of items per page. The maximum allowed value is 500. The default value is 50.
    Example: 10

## Request fields (application/json):

  - `body` (DomainSuggestionRequest (object), required)
    - `term` (string, required)
      domain, keyword, or phrase to use as the basis for suggestions depending on the Lookup Provider capabilities
      Example: "example.com, example, or 'A automotive repair shop in New York'"
    - `tlds` (array,null)
      an optional array of top level domains (TLDs) to check for suggestions (not all Lookup Providers support this)
      Example: ["com"]
    - `maximum_length` (integer,null)
      the optional maximum number of characters for the suggested domain names (not all Lookup Providers support this)
      Example: 10
    - `filter_sensitive_content` (boolean,null)
      whether to filter out sensitive words from the suggestions (not all Lookup Providers support this)

## Response 200 fields (application/json):

  - `meta` (any)
    - `total_items` (integer, required)
      The total number of results available.
      Example: 10
    - `page` (integer, required)
      Example: 1
    - `total_pages` (integer, required)
      Example: 1
    - `page_size` (integer, required)
      The current number of results per page.
      Example: 50

  - `data` (array, required)

  - `data.domain_name` (string, required)

  - `data.idn_domain_name` (string, required)

  - `data.tld` (string)

  - `data.sld` (string, required)

  - `data.idn_sld` (string, required)

  - `data.status` (string, required)
    Enum: "registered", "available for registration", "reserved", "unknown", "tld not supported"

  - `data.group` (string,null, required)

  - `data.pricing` (array, required)

  - `data.pricing.period` (integer, required)

  - `data.pricing.register` (object,null, required)

  - `data.pricing.register.value` (string, required)
    Example: "19.99"

  - `data.pricing.register.code` (string, required)
    Example: "USD"

  - `data.pricing.register.display_value` (string, required)
    Example: "$19.99 USD"

  - `data.pricing.register.prefix` (string, required)
    Optional currency prefix
    Example: "$"

  - `data.pricing.register.suffix` (string, required)
    Optional currency prefix
    Example: " USD"

  - `data.pricing.transfer` (object,null, required)

  - `data.pricing.transfer.value` (string, required)
    Example: "19.99"

  - `data.pricing.transfer.code` (string, required)
    Example: "USD"

  - `data.pricing.transfer.display_value` (string, required)
    Example: "$19.99 USD"

  - `data.pricing.transfer.prefix` (string, required)
    Optional currency prefix
    Example: "$"

  - `data.pricing.transfer.suffix` (string, required)
    Optional currency prefix
    Example: " USD"

  - `data.pricing.renew` (object,null, required)

  - `data.pricing.renew.value` (string, required)
    Example: "19.99"

  - `data.pricing.renew.code` (string, required)
    Example: "USD"

  - `data.pricing.renew.display_value` (string, required)
    Example: "$19.99 USD"

  - `data.pricing.renew.prefix` (string, required)
    Optional currency prefix
    Example: "$"

  - `data.pricing.renew.suffix` (string, required)
    Optional currency prefix
    Example: " USD"

  - `data.shortest_period` (object, required)

  - `data.is_premium` (boolean, required)

  - `data.premium_cost_pricing` (object,null, required)

  - `data.premium_cost_pricing.period` (integer, required)

  - `data.premium_cost_pricing.register` (object,null, required)

  - `data.premium_cost_pricing.register.value` (string, required)
    Example: "19.99"

  - `data.premium_cost_pricing.register.code` (string, required)
    Example: "USD"

  - `data.premium_cost_pricing.register.display_value` (string, required)
    Example: "$19.99 USD"

  - `data.premium_cost_pricing.register.prefix` (string, required)
    Optional currency prefix
    Example: "$"

  - `data.premium_cost_pricing.register.suffix` (string, required)
    Optional currency prefix
    Example: " USD"

  - `data.premium_cost_pricing.transfer` (object,null, required)

  - `data.premium_cost_pricing.transfer.value` (string, required)
    Example: "19.99"

  - `data.premium_cost_pricing.transfer.code` (string, required)
    Example: "USD"

  - `data.premium_cost_pricing.transfer.display_value` (string, required)
    Example: "$19.99 USD"

  - `data.premium_cost_pricing.transfer.prefix` (string, required)
    Optional currency prefix
    Example: "$"

  - `data.premium_cost_pricing.transfer.suffix` (string, required)
    Optional currency prefix
    Example: " USD"

  - `data.premium_cost_pricing.renew` (object,null, required)

  - `data.premium_cost_pricing.renew.value` (string, required)
    Example: "19.99"

  - `data.premium_cost_pricing.renew.code` (string, required)
    Example: "USD"

  - `data.premium_cost_pricing.renew.display_value` (string, required)
    Example: "$19.99 USD"

  - `data.premium_cost_pricing.renew.prefix` (string, required)
    Optional currency prefix
    Example: "$"

  - `data.premium_cost_pricing.renew.suffix` (string, required)
    Optional currency prefix
    Example: " USD"

## Response default fields (application/json):

  - `message` (string)