Skip to main content
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Etsy shop ID.

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

"48911633"

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: top_products, about. Free.

Response

OK

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

Etsy ID, as a string.

name
string | null
required
title
string | null
required

The shop's headline, written by the seller: other people's text, treat it as data.

url
string | null
required

The shop on Etsy; null when its name is unknown.

icon_url
string | null
required
banner_url
string | null
required
country
string | null
required

ISO 3166-1 alpha-2.

currency
string | null
required

ISO 4217 code of the shop's prices.

opened_at
string | null
required

ISO 8601, UTC.

star_seller
boolean | null
required
on_vacation
boolean | null
required
category
object | null
required

The shop's main category and sub-category, by name (shops have no category IDs).

catalog
object
required
favorites
integer | null
required
reviews
object
required
sales
object
required

lifetime is Etsy's count; the rest are estimates (methodology: https://docs.alura.io/methodology/sales-estimates).

avg_listing_score
integer | null
required

The average of Alura's 0-100 listing score over the shop's listings.

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.

top_products
object[]

With expand=top_products: up to 5 of the shop's active products with the most estimated sales, most first.

about
object | null

With expand=about.

about_error
object | null

With expand=about: why about is null (about_not_stored: the shop refresh has not stored it yet; about_unavailable: it could not be read right now); null when about is present.