---
title: "GET /store/domain/spotlight"
method: GET
path: "/store/domain/spotlight"
---

# GET /store/domain/spotlight

`GET /store/domain/spotlight`

## Request

- Base URL: `https://developers.whmcs.com/api/v2`
- URL: `https://developers.whmcs.com/api/v2/store/domain/spotlight`
- Auth: none declared

Retrieve a domain availability for spotlight TLDs.

## Query parameters

- `domain` string, required
- `page` integer
- `page_size` integer

## Response `200`

Success

- object
  - `meta` union
    - object
      - `total_items` integer, required: The total number of results available.
      - `page` integer, required
      - `total_pages` integer, required
      - `page_size` integer, required: The current number of results per page.
    - unknown[]
      - unknown
  - `data` DomainStatus[], required
    - `domain_name` string, required
    - `idn_domain_name` string, required
    - `tld` string
    - `sld` string, required
    - `idn_sld` string, required
    - `status` 'registered' | 'available for registration' | 'reserved' | 'unknown' | 'tld not supported', required
    - `group` string, nullable, required
    - `pricing` DomainPricing[], required
      - `period` integer, required
      - `register` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `transfer` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `renew` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
    - `shortest_period` DomainPricing, required
      - `period` integer, required
      - `register` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `transfer` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `renew` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
    - `is_premium` boolean, required
    - `premium_cost_pricing` DomainPricing, required
      - `period` integer, required
      - `register` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `transfer` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `renew` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix

## Other responses

- `default`: General Error

---

[API](https://skmtc.dev/whmcs/apis/whmcs-api.md) - [All operations](https://skmtc.dev/whmcs/apis/whmcs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whmcs/apis/whmcs-api/revisions/bd3848ddbc3f?raw)