# Etsy on Onekey

> 4 endpoints for Etsy (0 stable, 4 beta), 1 to 5 credits each. Category: E-commerce & marketplaces. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 2 of 4 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/etsy
Reference (Markdown): https://onekey.dev/docs/api/etsy.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 4 mapped Etsy endpoints return each:

- `entity.name` (string): 4
- `entity.description` (string): 3
- `entity.url` (URL): 3
- `listing.currency` (string): 3
- `content.createdAt` (ISO 8601 date): 2
- `content.id` (string): 2
- `engagement.likes` (integer): 2
- `engagement.views` (integer): 2
- `entity.tags` (list of strings): 2
- `entity.id` (string): 1
- `entity.stats.rating` (number): 1
- `entity.stats.ratingCount` (integer): 1
- `entity.type` (string): 1
- `listing.brand` (string): 1
- `listing.price` (number): 1
- `media.thumbnailUrl` (URL): 1
- plus 3 platform-specific fields under `ext.`

## Endpoints

### etsy.listing

One Etsy listing by id.
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/etsy/listing?listing_id=1234567890` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `listing_id` (string, required): Etsy listing id
- Fields returned: `content.id`, `entity.name`, `entity.description`, `entity.url`, `listing.currency`, `engagement.likes`, `engagement.views`, `content.createdAt`, `entity.tags`, `ext.priceMinor`, `ext.priceDivisor`
- Reference: https://onekey.dev/docs/api/etsy/listing.md

### etsy.listings

Search active Etsy listings (Open API v3).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/etsy/listings?q=ceramic%20mug` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `content.id`, `entity.name`, `entity.description`, `entity.url`, `listing.currency`, `engagement.likes`, `engagement.views`, `content.createdAt`, `entity.tags`, `ext.priceMinor`, `ext.priceDivisor`, `ext.shopId`
- Reference: https://onekey.dev/docs/api/etsy/listings.md

### etsy.product_similar

Listings similar to an Etsy product.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/etsy/product_similar?product_id=123456789` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `product_id` (string, optional): Product id as it appears on the product page URL
  - `url` (string, optional): Full URL of the product page (alternative to the id)
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `listing.brand`, `entity.stats.rating`, `entity.stats.ratingCount`
- Reference: https://onekey.dev/docs/api/etsy/product_similar.md

### etsy.search_suggestions

Etsy search suggestions.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/etsy/search_suggestions?query=headphones` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search query
- Fields returned: `entity.name`, `entity.type`
- Reference: https://onekey.dev/docs/api/etsy/search_suggestions.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/etsy/listing?listing_id=1234567890" \
  -H "x-api-key: YOUR_API_KEY"
```