API reference

Etsy Listing API

One Etsy listing: title, description, price, availability, images, tags, materials, category, shop, favourites, views and recent reviews.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/etsy/productlive · proven4 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`id`	yes	Etsy listing id, or its URL	`4429284280`
`currency`	no	Currency code	`USD`
`region`	no	Two-letter region	`US`
`language`	no	Language	`en-US`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/etsy/product?id=4429284280" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/etsy/product?id=4429284280",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/etsy/product?id=4429284280",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "etsy",
  "endpoint": "/v1/etsy/product",
  "data": {
    "available": false,
    "bestseller": false,
    "category": {
      "taxonomy": "example"
    },
    "created_at": "2026-09-01T12:00:00Z",
    "currency": "example",
    "customizable": false,
    "description": "example",
    "digital": false,
    "favorites": 0,
    "id": "example",
    "image": "https://example.com/example",
    "images": [
      "example"
    ],
    "made_to_order": false,
    "materials": [
      "example"
    ],
    "platform": "example",
    "price": 0,
    "price_usd": 0,
    "quantity": 0,
    "recent_reviews": [],
    "reviews_summary": {
      "average_rating": 0,
      "rating_counts": {
        "All": 0
      },
      "tags": [
        {
          "name": "example",
          "negative": 0,
          "positive": 0
        }
      ],
      "total_reviews": 0
    },
    "section": "example",
    "ships_from": "example",
    "shop": {
      "avatar": "https://example.com/example",
      "id": "example",
      "name": "example",
      "url": "https://example.com/example"
    },
    "similar": [],
    "sold_out": false,
    "state": "example",
    "tags": [
      "example"
    ],
    "title": "example",
    "top_rated": false,
    "type": "example",
    "updated_at": "2026-09-01T12:00:00Z",
    "url": "https://example.com/example",
    "variation_pricing": false,
    "views": 0,
    "vintage": false,
    "when_made": "example"
  },
  "credits_used": 4,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`available`	`boolean \| null`	Optional available supplied by this operation. Null means unknown.
`bestseller`	`boolean \| null`	Optional bestseller supplied by this operation. Null means unknown.
`category`	`object \| null`	Optional category supplied by this operation. Null means unknown.
`category.taxonomy`	`string \| null`	Optional taxonomy supplied by this operation. Null means unknown.
`created_at`	`string \| null`	Source creation time, not the API retrieval time.
`currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`customizable`	`boolean \| null`	Optional customizable supplied by this operation. Null means unknown.
`description`	`string \| null`	Source description; null or absent means not supplied.
`digital`	`boolean \| null`	Optional digital supplied by this operation. Null means unknown.
`favorites`	`number \| null`	Optional favorites supplied by this operation. Null means unknown.
`id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`image`	`string \| null`	Optional image supplied by this operation. Null means unknown.
`images`	`array \| null`	Optional images supplied by this operation. Null means unknown.
`made_to_order`	`boolean \| null`	Optional made to order supplied by this operation. Null means unknown.
`materials`	`array \| null`	Optional materials supplied by this operation. Null means unknown.
`platform`	`string \| null`	Optional platform supplied by this operation. Null means unknown.
`price`	`number \| null`	Source price. Currency, taxes and availability depend on the listing.
`price_usd`	`number \| null`	Optional price usd supplied by this operation. Null means unknown.
`quantity`	`number \| null`	Optional quantity supplied by this operation. Null means unknown.
`recent_reviews`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`reviews_summary`	`object \| null`	Optional reviews summary supplied by this operation. Null means unknown.
`reviews_summary.average_rating`	`number \| null`	Optional average rating supplied by this operation. Null means unknown.
`reviews_summary.rating_counts`	`object \| null`	Optional rating counts supplied by this operation. Null means unknown.
`reviews_summary.rating_counts.All`	`number \| null`	Optional All supplied by this operation. Null means unknown.
`reviews_summary.tags`	`array \| null`	Optional tags supplied by this operation. Null means unknown.
`reviews_summary.tags[].name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`reviews_summary.tags[].negative`	`number \| null`	Optional negative supplied by this operation. Null means unknown.
`reviews_summary.tags[].positive`	`number \| null`	Optional positive supplied by this operation. Null means unknown.
`reviews_summary.total_reviews`	`number \| null`	Optional total reviews supplied by this operation. Null means unknown.
`section`	`string \| null`	Optional section supplied by this operation. Null means unknown.
`ships_from`	`string \| null`	Optional ships from supplied by this operation. Null means unknown.
`shop`	`object \| null`	Optional shop supplied by this operation. Null means unknown.
`shop.avatar`	`string \| null`	Optional avatar supplied by this operation. Null means unknown.
`shop.id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`shop.name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`shop.url`	`string \| null`	Original source URL when supplied.
`similar`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`sold_out`	`boolean \| null`	Optional sold out supplied by this operation. Null means unknown.
`state`	`string \| null`	Optional state supplied by this operation. Null means unknown.
`tags`	`array \| null`	Optional tags supplied by this operation. Null means unknown.
`title`	`string \| null`	Source title when supplied.
`top_rated`	`boolean \| null`	Optional top rated supplied by this operation. Null means unknown.
`type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`updated_at`	`string \| null`	Optional updated at supplied by this operation. Null means unknown.
`url`	`string \| null`	Original source URL when supplied.
`variation_pricing`	`boolean \| null`	Optional variation pricing supplied by this operation. Null means unknown.
`views`	`number \| null`	Optional views supplied by this operation. Null means unknown.
`vintage`	`boolean \| null`	Optional vintage supplied by this operation. Null means unknown.
`when_made`	`string \| null`	Optional when made supplied by this operation. Null means unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

Etsy Listing API

Query parameters

Make the request

Response fields and example

More Etsy reference

First call in under a minute