{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper + Listing Change Monitor", "description": "Search public US Etsy listings, fetch exact public listing details, collect shop catalogs, or track verified listing changes with stable IDs and explicit coverage.", "version": "0.0", "x-build-id": "wEBgV6XKQwnVX47TZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luminar~etsy-product-shop-listing-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luminar-etsy-product-shop-listing-change-monitor", "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/luminar~etsy-product-shop-listing-change-monitor/runs": { "post": { "operationId": "runs-sync-luminar-etsy-product-shop-listing-change-monitor", "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/luminar~etsy-product-shop-listing-change-monitor/run-sync": { "post": { "operationId": "run-sync-luminar-etsy-product-shop-listing-change-monitor", "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": { "workflow": { "title": "What do you want to do?", "enum": [ "search_products", "analyze_shop", "scrape_exact_listings", "monitor" ], "type": "string", "description": "Choose the buyer job first. Search uses queries/categories, Shop uses public shop names/URLs, Exact uses listing IDs/URLs, and Track compares one of those same scopes over sequential runs.", "default": "search_products" }, "queries": { "title": "Search keywords", "minItems": 0, "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Used by Search and search monitoring. Each buyer-style keyword is visited independently; one listing can retain several query/page/rank placements without becoming duplicate paid rows.", "items": { "type": "string", "minLength": 1, "maxLength": 160 }, "default": [ "handmade silver ring" ] }, "maxListings": { "title": "Maximum unique listings", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Run-wide delivery cap. Search and Shop may return CAPPED with a useful prefix. Monitoring is additionally limited to 10,000 current listings so state and retry safety remain bounded.", "default": 25 }, "maxBuyerChargeUsd": { "title": "Maximum projected Actor charge", "minimum": 0.01, "maximum": 1000, "type": "number", "description": "Stops before source work when the maximum event vector could exceed this buyer ceiling. Lower the value for a tighter per-run spending limit.", "default": 5 }, "categoryUrls": { "title": "Etsy category or market URLs", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Used by Search and search monitoring. Only public first-party etsy.com category or market URLs are accepted.", "items": { "type": "string", "pattern": "^https://(?:www\\.)?etsy\\.com/(?:c|market)/", "maxLength": 600 } }, "shops": { "title": "Public Etsy shops", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Required by Shop and shop monitoring. Enter a public shop name or etsy.com/shop URL.", "items": { "type": "string", "minLength": 2, "maxLength": 400 } }, "listingTargets": { "title": "Exact listing IDs or URLs", "maxItems": 10000, "uniqueItems": true, "type": "array", "description": "Required by Exact and exact-listing monitoring. Enter numeric listing IDs or public etsy.com/listing URLs.", "items": { "type": "string", "minLength": 3, "maxLength": 600 } }, "marketCountry": { "title": "Ship-to country", "pattern": "^[A-Z]{2}$", "type": "string", "description": "Two-letter country code used for public Etsy market context and shipping filters.", "default": "US" }, "currency": { "title": "Currency", "pattern": "^[A-Z]{3}$", "type": "string", "description": "Three-letter currency requested from Etsy. No conversion or exchange-rate inference is performed.", "default": "USD" }, "minPrice": { "title": "Minimum price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Keep listings whose source-published current price reaches this amount." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Keep listings whose source-published current price does not exceed this amount." }, "itemType": { "title": "Product type", "enum": [ "all", "physical", "digital" ], "type": "string", "description": "Keep all products or require Etsy's explicit physical/digital signal. Missing signals do not pass a narrowed filter.", "default": "all" }, "handmadeOnly": { "title": "Handmade only", "type": "boolean", "description": "Keep only rows Etsy explicitly marks handmade; no handmade status is inferred from text.", "default": false }, "onSaleOnly": { "title": "On-sale only", "type": "boolean", "description": "Keep listings with a source-published original price above the current price.", "default": false }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Keep listings Etsy explicitly marks as free shipping for the selected market.", "default": false }, "includeAds": { "title": "Include sponsored listings", "type": "boolean", "description": "Keep explicitly labeled ad placements. Turn off to exclude them; unlabeled rows remain sponsored=null rather than guessed organic.", "default": true }, "minimumRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep rows whose source-published rating reaches this value." }, "minimumReviewCount": { "title": "Minimum review count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Keep rows whose source-published review count reaches this value." }, "shopLocation": { "title": "Shop location contains", "maxLength": 160, "type": "string", "description": "Case-insensitive deterministic filter on a source-published public shop location." }, "sort": { "title": "Sort results", "enum": [ "relevance", "most_recent", "lowest_price", "highest_price", "top_reviews", "carts", "recent_sales" ], "type": "string", "description": "Source-supported sorts are requested from Etsy. Cart and recent-purchase sorts deterministically reorder only explicit source signals; null values sort last.", "default": "relevance" }, "detailLevel": { "title": "Detail level", "enum": [ "core", "detailed", "complete" ], "type": "string", "description": "Core uses search or shop cards only. Detailed opens extra public listing pages, adds source requests and runtime, and replaces the core listing charge with a paid detailed-listing event only when enrichment succeeds. Complete performs the same detail work and can add separately priced shop-profile rows. Public review-row delivery is not yet supported.", "default": "core" }, "maxDetailListings": { "title": "Maximum detailed listings", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Used only by Detailed/Complete. Rows after this limit remain core and are not billed as detailed results.", "default": 25 }, "maxShopProfiles": { "title": "Maximum full shop profiles", "minimum": 0, "maximum": 100, "type": "integer", "description": "Used only by Complete when a workflow did not already open that shop page.", "default": 5 }, "monitorTargetType": { "title": "Monitoring target", "enum": [ "search", "shop", "listings" ], "type": "string", "description": "Chooses which target family Track changes compares. Search/shop absence is never deletion; exact listing 404 is still reported cautiously.", "default": "shop" }, "firstRunBehavior": { "title": "First monitoring run", "enum": [ "seed_only", "emit_current_as_new" ], "type": "string", "description": "Used only by Track changes. Both choices fetch the same public source scope. Seed-only stores the first baseline without paid NEW rows; Emit current returns those rows as paid NEW events and can cost more. Each repeat run compares with the saved same-scope baseline.", "default": "seed_only" }, "stateNamespace": { "title": "Monitoring scope name", "pattern": "^[A-Za-z0-9._~-]{1,64}$", "maxLength": 64, "type": "string", "description": "Separates independent baselines. Runs for the same exact namespace and scope must be sequential.", "default": "default" }, "maxPagesPerTarget": { "title": "Maximum pages per target", "minimum": 1, "maximum": 250, "type": "integer", "description": "Stops pagination for each query, category or shop while preserving useful rows and explicit coverage.", "default": 5 }, "maxRequests": { "title": "Request guard", "minimum": 1, "maximum": 105000, "type": "integer", "description": "Internal run-wide navigation ceiling.", "default": 105000 }, "maxSourceBytes": { "title": "Transfer guard", "minimum": 10000, "maximum": 24000000000, "type": "integer", "description": "Internal run-wide source transfer ceiling.", "default": 512000000 }, "maxRuntimeSecs": { "title": "Runtime guard", "minimum": 30, "maximum": 172800, "type": "integer", "description": "Internal source-work runtime ceiling.", "default": 1800 }, "detailConcurrency": { "title": "Detail concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Internal maximum concurrent detail/profile operations.", "default": 2 } } }, "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 } } }, "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 } } } } } } } } } }