Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

q
string

Words to find in the shop name, title or categories; every word must match.

Example:

"mug"

category
string

The shop's main category by name, for example Home & Living (any letter case).

sub_category
string

The shop's sub-category by name (any letter case).

country
string

The shop's country, as an ISO 3166-1 alpha-2 code (US).

Pattern: ^[A-Za-z]{2}$
Example:

"US"

sales_min
string

Fewest sales (Etsy's count).

Pattern: ^\d{1,10}$
sales_max
string

Most sales (Etsy's count).

Pattern: ^\d{1,10}$
est_monthly_sales_min
string

Fewest estimated sales per month (average).

Pattern: ^\d{1,10}$
active_listings_min
string

Fewest active listings.

Pattern: ^\d{1,10}$
active_listings_max
string

Most active listings.

Pattern: ^\d{1,10}$
opened_after
string

Opened on Etsy at or after this time.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}(:\d{2}(\.\d{1,3})?)?(Z|[+-]\d{2}:\d{2}))?$
star_seller
enum<string>

Whether the shop is an Etsy Star Seller.

Available options:
true,
false
sort
enum<string>
default:relevance

relevance (default: best match for q, else most sales), or a field. Sorting by a field leaves out shops where that value is unknown.

Available options:
relevance,
sales,
est_monthly_sales,
est_revenue,
reviews,
newest
Example:

"sales"

order
enum<string>

desc (default) or asc. Not accepted with sort=relevance, which is always best match first.

Available options:
asc,
desc
limit
integer

Page size: default 25, at most 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Bound to the query, the workspace and the key.

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
total
object
required