What you get#
Onekey exposes Etsy as 4 endpoints behind one API key: 1 endpoint return one record (data is an object) and 3 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Etsy also works for the rest of the e-commerce & marketplaces category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
listing | One Etsy listing by id. | listing_id* | 1 | beta |
listings | Search active Etsy listings (Open API v3). | q* | 5 | beta |
product_similar | Listings similar to an Etsy product. | product_id, url | 2 | beta needs a pack |
search_suggestions | Etsy search suggestions. | query* | 2 | beta needs a pack |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls etsy.listing (1 credit, beta). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/etsy/listing?listing_id=1234567890" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Etsy, with the same names as on every other platform. The count is how many of its 4 mapped endpoints return the field; a field the source lacks is null, never missing. 3 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
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 |
The full schema is in Unified schema.
Pricing#
Etsy calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.