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 products whose estimated sales grew the most, last 3 completed months against the 3 before. new: products listed in the last 90 days that already sell, most estimated monthly sales first.

Available options:
rising,
new
Example:

"rising"

category_id
string

An Etsy category ID (see /v1/categories); matches the category and every category under it.

Pattern: ^[1-9][0-9]{0,9}$
Example:

"1062"

price_min
string

Lowest price in USD.

Pattern: ^\d{1,9}(\.\d{1,2})?$
price_max
string

Highest price in USD.

Pattern: ^\d{1,9}(\.\d{1,2})?$
est_sales_min
string

Fewest estimated lifetime sales.

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

Most estimated lifetime sales.

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.