API reference
Etsy Shop Listings API
The listings of an Etsy shop, with price, discount, badges and processing time.
Endpoint
/v1/etsy/shop-productslive · proven4 creditsParameters
Query parameters
Useful optional inputs
sort— Choose the documented source ordering before paging through results.Ordering keeps the normal endpoint price and does not guarantee exhaustive results.
limit— Bound the returned rows to what your task needs.A smaller limit does not necessarily reduce source calls or price; inspect the quote.
dry_run— Read a free estimate before fetching sources or scheduling paid work.Zero credits; cache status and availability are snapshots rather than guarantees.
| Name | Required | Description | Example |
|---|---|---|---|
shop | yes | Shop name, numeric id or URL | Qorux |
page | no | Page number | 1 |
limit | no | Up to 48 per page | 24 |
section_id | no | A section id from etsy/shop | |
sort | no | created, price_asc, price_desc or score Accepted values: created, price_asc, price_desc, score. Case, spaces, hyphens and underscores are interchangeable. | created |
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. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/etsy/shop-products?shop=Qorux" \ -H "x-api-key: mn_your_key_here"
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/shop-products?shop=Qorux",
{ 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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/etsy/shop-products?shop=Qorux",
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.
{
"success": true,
"platform": "etsy",
"endpoint": "/v1/etsy/shop-products",
"data": {
"count": 0,
"cursor": null,
"has_more": false,
"items": [
{
"available": false,
"bestseller": false,
"created_at": "2026-09-01T12:00:00Z",
"currency": "example",
"customizable": false,
"digital": false,
"has_video": false,
"id": "example",
"image": "https://example.com/example",
"images": [
"example"
],
"made_to_order": false,
"materials": [],
"platform": "example",
"price": 0,
"quantity": 0,
"shop": {
"id": "example",
"name": "example",
"url": "https://example.com/example"
},
"sold_out": false,
"star_seller": false,
"tags": [],
"thumbnail": "example",
"title": "example",
"type": "example",
"url": "https://example.com/example",
"vintage": false
}
],
"page": 0,
"shop": "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 |
|---|---|---|
count | number | null | Number of records in this response, not lifetime or total matches. |
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].available | boolean | null | Optional available supplied by this operation. Null means unknown. |
items[].bestseller | boolean | null | Optional bestseller supplied by this operation. Null means unknown. |
items[].created_at | string | null | Source creation time, not the API retrieval time. |
items[].currency | string | null | Optional currency supplied by this operation. Null means unknown. |
items[].customizable | boolean | null | Optional customizable supplied by this operation. Null means unknown. |
items[].digital | boolean | null | Optional digital supplied by this operation. Null means unknown. |
items[].has_video | boolean | null | Optional has video supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].image | string | null | Optional image supplied by this operation. Null means unknown. |
items[].images | array | null | Optional images supplied by this operation. Null means unknown. |
items[].made_to_order | boolean | null | Optional made to order supplied by this operation. Null means unknown. |
items[].materials | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].price | number | null | Source price. Currency, taxes and availability depend on the listing. |
items[].quantity | number | null | Optional quantity supplied by this operation. Null means unknown. |
items[].shop | object | null | Optional shop supplied by this operation. Null means unknown. |
items[].shop.id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].shop.name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].shop.url | string | null | Original source URL when supplied. |
items[].sold_out | boolean | null | Optional sold out supplied by this operation. Null means unknown. |
items[].star_seller | boolean | null | Optional star seller supplied by this operation. Null means unknown. |
items[].tags | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
items[].thumbnail | string | null | Optional thumbnail supplied by this operation. Null means unknown. |
items[].title | string | null | Source title when supplied. |
items[].type | string | null | Optional type supplied by this operation. Null means unknown. |
items[].url | string | null | Original source URL when supplied. |
items[].vintage | boolean | null | Optional vintage supplied by this operation. Null means unknown. |
page | number | null | Optional page supplied by this operation. Null means unknown. |
shop | string | null | Optional shop 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