etsy.listings

beta Advanced

Search active Etsy listings (Open API v3).

GET /v1/etsy/listings

What you get#

A list of Etsy results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

Also known as: /etsy/shop/products on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/etsy/listings?q=ceramic%20mug" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Etsy response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "content": {
        "id": "1234567890",
        "createdAt": "2026-05-28T20:26:40Z"
      },
      "entity": {
        "name": "Handmade ceramic mug",
        "description": "Wheel thrown stoneware mug.",
        "url": "https://www.etsy.com/listing/1234567890/handmade-ceramic-mug",
        "tags": [
          "mug",
          "ceramic"
        ]
      },
      "ext": {
        "priceMinor": 2800,
        "priceDivisor": 100,
        "shopId": "555"
      },
      "listing": {
        "currency": "USD"
      },
      "engagement": {
        "likes": 412,
        "views": 9001
      }
    }
  ],
  "metadata": {
    "platform": "etsy",
    "endpoint": "listings",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`listing_id`	`content.id`	`toString`
`title`	`entity.name`	-
`description`	`entity.description`	-
`url`	`entity.url`	`safeUrl`
`price.amount`	`ext.priceMinor`	`toNumber`
`price.divisor`	`ext.priceDivisor`	`toNumber`
`price.currency_code`	`listing.currency`	-
`num_favorers`	`engagement.likes`	`toNumber`
`views`	`engagement.views`	`toNumber`
`creation_timestamp`	`content.createdAt`	`toIsoDate`
`tags`	`entity.tags`	-
`shop_id`	`ext.shopId`	`toString`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).