{ "openapi": "3.0.1", "info": { "title": "Etsy Listings & Shop Export (Etsy Open API v3)", "description": "Export active Etsy listings by keyword or by shop with your own approved Etsy app and the Etsy Open API v3: price, views, favorites, tags, materials, photos and shop stats. No scraping, no proxy.", "version": "0.1", "x-build-id": "Rx7gBsAfWgNiS5X0i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cliqtomedia~etsy-listings-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cliqtomedia-etsy-listings-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/cliqtomedia~etsy-listings-api/runs": { "post": { "operationId": "runs-sync-cliqtomedia-etsy-listings-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/cliqtomedia~etsy-listings-api/run-sync": { "post": { "operationId": "run-sync-cliqtomedia-etsy-listings-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "apiKey": { "title": "Etsy API keystring", "type": "string", "description": "Keystring of your approved Etsy app from etsy.com/developers/your-apps. You can also paste keystring:shared_secret here. Stored encrypted; never written to the dataset, logs or run summary." }, "sharedSecret": { "title": "Etsy shared secret", "type": "string", "description": "Shared secret of the same app (shown next to the keystring). Etsy rejects requests without it. Stored encrypted." }, "mode": { "title": "What to export", "enum": [ "search", "shop" ], "type": "string", "description": "search = active listings matching your keywords across Etsy; shop = all active listings of the shops you name.", "default": "search" }, "keywords": { "title": "Keyword searches", "type": "array", "description": "Searches as you would type them on Etsy, one per line, up to 50. Used in mode search.", "items": { "type": "string" } }, "shopNames": { "title": "Shop names", "type": "array", "description": "Shop names or shop links (etsy.com/shop/), up to 200. Used in mode shop. Unknown shops are listed in the run summary.", "items": { "type": "string" } }, "maxItems": { "title": "Max listings per search or shop", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each search or shop after this many saved listings. Each saved listing is one paid result.", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "price_low", "price_high", "recently_updated" ], "type": "string", "description": "Order of the listings. Relevance works for keyword searches; for shops it means newest first.", "default": "relevance" }, "minPrice": { "title": "Min price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Only listings priced at least this much (keyword search only)." }, "maxPrice": { "title": "Max price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Only listings priced at most this much (keyword search only)." }, "shopLocation": { "title": "Shop location", "type": "string", "description": "Only shops in this place, for example United States or Canada (keyword search only)." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }