Skip to main content
Get a product

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Etsy listing ID.

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

Query Parameters

fields
string

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

expand
string

Comma-separated related objects to include: shop. Free.

Response

OK

object
string
required
Allowed value: "research.product"
id
string
required

Etsy ID, as a string.

url
string
required

The listing on Etsy.

title
string | null
required
state
string | null
required

Etsy listing state, for example active, sold_out, expired.

shop
object
required

The product's shop: its ID and name; with expand=shop the full shop (free; only the ID and name when Alura has not seen the shop).

price
object | null
required

The listing's current price.

quantity
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
category
object | null
required
tags
string[] | null
required

The seller's tags (up to 13); null when unknown.

materials
string[] | null
required
language
string | null
required
image_url
string | null
required

The primary image (570px wide).

images
object[]
required

Every image, in rank order.

video
object | null
required
listed_at
string | null
required

ISO 8601, UTC.

attributes
object
required
favorites
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
reviews
object
required
sales
object
required

Estimates (methodology: https://docs.alura.io/methodology/sales-estimates). Revenue is valued at the current price.

listing_score
integer | null
required

Alura's 0-100 listing score.

Required range: -9007199254740991 <= x <= 9007199254740991
as_of
string
required

When this data was last updated from Etsy.

refresh
object | null
required

A refresh from Etsy in progress for stale data; null when none is running.