{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper: Product Listings, Prices, Tags, Shop Sales", "description": "Etsy product research: full listings for keywords or URLs, $7.20 per 1,000, 10% under the most used Etsy scraper's $8, whose input works as is. Price, sale price, favorites, rating, tags, materials, variations, shipping and shop sales in every row; review text $4.50 per 1,000. Free error rows.", "version": "0.1", "x-build-id": "EuJEjRDi0zBqwto8I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arcadium~etsy-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arcadium-etsy-products", "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/arcadium~etsy-products/runs": { "post": { "operationId": "runs-sync-arcadium-etsy-products", "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/arcadium~etsy-products/run-sync": { "post": { "operationId": "run-sync-arcadium-etsy-products", "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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search Etsy for, for example \"ceramic mug\" or \"personalized necklace\". Each term is searched on its own; every listing keeps the term and its position in the results. Also read from queries, searchQueries, searchQuery, search or keywords (other Etsy actors' names).", "items": { "type": "string" } }, "startUrls": { "title": "Etsy URLs or listing ids", "type": "array", "description": "Listing URLs or ids (e.g. https://www.etsy.com/listing/962939986 or 962939986) for full details, and search or category URLs (e.g. https://www.etsy.com/c/jewelry/necklaces) to read their results. Also read from listingUrls, urls or listingIds; objects with a url field work too.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Listings per search term or search/category URL, e.g. 50 (the default). Each page holds 40 to 64 results; Etsy pages up to about 250 pages deep. Also read from maxResults, maxResultsPerTerm, maxListings or maxPages (x 36)." }, "maxItems": { "title": "Max rows in total", "minimum": 1, "type": "integer", "description": "Optional cap on charged rows (listings plus reviews) for the whole run, e.g. 500. Empty means no cap beyond the per-search limit." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "price_asc", "price_desc", "top_reviews" ], "type": "string", "description": "Order of search results: relevance (Etsy's default), newest, price_asc, price_desc or top_reviews, for example newest. Also read from sort, sortOrder or sortOn (other Etsy actors' names and values)." }, "minPrice": { "title": "Minimum price", "type": "number", "description": "Only listings priced at or above this amount, in the shopper currency (US dollars for the default US storefront), e.g. 20." }, "maxPrice": { "title": "Maximum price", "type": "number", "description": "Only listings priced at or below this amount, in US dollars, e.g. 60." }, "shipTo": { "title": "Ships to", "type": "string", "description": "Two-letter country code the items must ship to, e.g. US, GB or DE. Empty means any." }, "freeShipping": { "title": "Free shipping only", "type": "boolean", "description": "Only listings that ship for free (to the US storefront)." }, "onSale": { "title": "On sale only", "type": "boolean", "description": "Only listings with a running discount (salePrice and discountPercent are filled)." }, "includeAds": { "title": "Include paid placements", "type": "boolean", "description": "Also return the sponsored listings shown among the results (isAd: true, no rank). Off by default; they do not count towards the per-search limit.", "default": false }, "maxReviewsPerListing": { "title": "Reviews per listing", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Newest reviews to return per listing as separate review rows (text, rating, date, shop reply; no reviewer names), e.g. 20. 0 = none (the default); the rating summary is always on the listing." }, "reviewSort": { "title": "Review order", "enum": [ "newest", "relevance", "highest", "lowest" ], "type": "string", "description": "Which reviews come first when reviews are requested: newest, relevance, highest or lowest rating.", "default": "newest" }, "description": { "title": "Description", "enum": [ "short", "full", "none" ], "type": "string", "description": "Listing description in the output: short (first 300 characters, the default), full, or none. Emails and phone numbers are removed." }, "includeShipping": { "title": "Shipping details", "type": "boolean", "description": "Adds the shipping block per listing: ships from, free or cost, delivery estimate to the US and the returns policy.", "default": true }, "includeErrorRows": { "title": "Add a row for inputs that failed", "type": "boolean", "description": "Adds a free row for every input that returned nothing or could not be read, so a failure is never silent.", "default": true }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How often a request is retried after a temporary error, e.g. 3 (the default).", "default": 3 }, "proxyConfiguration": { "title": "Proxy (advanced)", "type": "object", "description": "Leave empty. The actor picks the cheapest proxy that works for each kind of page." } } }, "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 } } } } } } } } } }