Skip to main content
cURL
Cost: 1 API credit per item returned.
Needs a plan with full historic data, Growth and above. Other plans get 403 plan_required.

Ask for several histories

Every ID comes back once. Its history is in data, the same object as Get product history or Get shop history returns. An ID that alone would answer 404 is in not_found: Alura hasn’t seen it, or doesn’t serve it. Nothing is fetched.

Read the months

Each history holds every completed UTC calendar month, oldest first. The month still running is never included. A month Alura has no values for is listed with null, never 0. With months, data_through names the last month with an estimated sales value within them. Estimates can change as more data arrives. methodology_version and methodology_url name the method; see sales estimates methodology.

Authorizations

Authorization
string
header
required

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

Query Parameters

kind
enum<string>
required

Whose histories: products (by listing ID) or shops (by shop ID); one kind per call.

Available options:
product,
shop
Example:

"shop"

ids
string[]
required

Etsy listing IDs (kind=product) or shop IDs (kind=shop), comma-separated (ids=1,2) or repeated (ids=1&ids=2); 1 to 20.

Example:
months
string

Only the last this many completed months of each history (1 to 120); default every month Alura has.

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

"12"

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
pending
string[]
required

Never-seen IDs being fetched now; ask again later. Free.

unfetched
object[]
required

Never-seen IDs that were not fetched, with the reason and when to retry. Free.

not_found
string[]
required

IDs that do not exist on Etsy or are not available. Free.