Search domains for purchase

GET https://app.ecwid.com/api/v3/{storeId}domains/search?keyword={keyword}

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Query params

Request works with one required query param.

Name	Type	Description
keyword	boolean	Search term for the domain name. Required

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Response JSON

A JSON object with the following fields:

Field	Type	Description
keyword	string	Keyword used for the search request.
domains	object domains	Domains found by keyword.

domains

Field	Type	Description
name	string	Domain name, for example. "mysuperstore.info" or "mysuperstore.com"
status	string	Status of domain. Possible values: "available" if domain is available to buy, "taken" otherwise
price	number	Domain price.
currency	string	Currency used to buy domain, e.g. "USD"
priceFormatted	string	Domain price in a string format, including price and currency, e.g. "$100.00"