{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper", "description": "Scrape public Etsy public marketplace listings, prices, shops, and sponsored placements. Export structured listings, source URLs, IDs, and available details to CSV, JSON, or Excel for handmade marketplace price and placement research.", "version": "0.1", "x-build-id": "0hOPNALijgcAMJuqC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mlg14~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mlg14-etsy-scraper", "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/mlg14~etsy-scraper/runs": { "post": { "operationId": "runs-sync-mlg14-etsy-scraper", "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/mlg14~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-mlg14-etsy-scraper", "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": { "queries": { "title": "Search phrases", "minItems": 1, "maxItems": 50, "type": "array", "description": "One or more shopper phrases; each phrase opens its public market page. Short phrases work best.", "items": { "type": "string" }, "default": [ "ceramic mug", "linen apron" ] }, "maxPages": { "title": "Pages per phrase", "minimum": 1, "maximum": 30, "type": "integer", "description": "Number of market pages per phrase. These pages showed about eight listing cards each during testing.", "default": 5 }, "maxResults": { "title": "Maximum listings", "minimum": 0, "type": "integer", "description": "Stop after this many saved listings across all phrases. Set to 0 for no total cap.", "default": 0 }, "sort": { "title": "Sort order", "enum": [ "score", "created", "price-asc", "price-desc", "highest-reviews" ], "type": "string", "description": "Order listings using a sort supported by the public market pages.", "default": "score" }, "country": { "title": "Ship-to country", "enum": [ "US", "GB", "CA", "AU", "NZ", "DE", "FR", "IT", "ES", "NL", "IE", "BE", "AT", "PT", "JP", "BR", "MX", "CH", "SE", "NO", "DK", "PL" ], "type": "string", "description": "Destination country filter. Prices remain in the currency returned by the page.", "default": "US" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Keep listings whose current price is at least this amount in the returned currency." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Keep listings whose current price is at most this amount in the returned currency." }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Keep listings with a visible reduced price.", "default": false }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Keep listings marked with free shipping on the market page.", "default": false }, "includeAds": { "title": "Include sponsored listings", "type": "boolean", "description": "Include sponsored placements and report their visible page positions.", "default": true }, "dedupeAcrossQueries": { "title": "Deduplicate across phrases", "type": "boolean", "description": "Save each listing once when it appears under multiple phrases. The first phrase is retained.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Network routing for the page requests.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }