Skip to main content
cURL

Authorizations

Authorization
string
header
required

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

Query Parameters

type
enum<string>
default:rising

rising (default): the shops whose estimated sales grew the most, last 3 completed months against the 3 before. new: shops opened in the last 90 days that already sell, most estimated monthly sales first.

Available options:
rising,
new
Example:

"rising"

category
string

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

Example:

"Home & Living"

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}$
est_monthly_sales_max
string

Most estimated sales per month (average).

Pattern: ^\d{1,10}$
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
summary
object
required

The same on every page.