WHwhmcs

GET /store/domain/spotlight

Retrieve a domain availability for spotlight TLDs.

Request

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

Query parameters

domainstring required
Example:example.com

Domain name

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.

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.