{ "openapi": "3.0.1", "info": { "title": "Etsy Shop Monitor (Beta) - Listings, Price, Sales & Reviews", "description": "Beta. Track competitor Etsy shops: new listings, price changes, sales started or ended, removed listings, total shop sales and new reviews since your last run. Changes only, no login. Etsy's anti-bot protection blocks some pages; blocked pages are not charged.", "version": "1.0", "x-build-id": "2y35mN5GLFnvicJCh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ivora~etsy-shop-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ivora-etsy-shop-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/ivora~etsy-shop-monitor/runs": { "post": { "operationId": "runs-sync-ivora-etsy-shop-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/ivora~etsy-shop-monitor/run-sync": { "post": { "operationId": "run-sync-ivora-etsy-shop-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": { "shops": { "title": "Etsy shops", "type": "array", "description": "Shop names or shop URLs, e.g. CaitlynMinimalist or https://www.etsy.com/shop/CaitlynMinimalist. ", "items": { "type": "string" } }, "listingUrls": { "title": "Single listings (optional)", "type": "array", "description": "Individual listing URLs (https://www.etsy.com/listing//...) to watch price, sale, stock and the listing's review count. Charged per listing checked.", "items": { "type": "string" } }, "maxPagesPerShop": { "title": "Max pages per shop", "minimum": 1, "maximum": 50, "type": "integer", "description": "Etsy shows 36 listings per page, in the order the shop chose. 3 pages = 108 listings. Pages after the first are more often blocked by Etsy. Removed-listing detection needs the whole shop, so set this high enough to cover all listings (e.g. 10 = 360 listings). More pages = longer run, same price per shop.", "default": 3 }, "firstRunBehavior": { "title": "First run of a monitor", "enum": [ "baseline", "outputListings" ], "type": "string", "description": "On the first run there is nothing to compare with. baseline = only remember the shop. outputListings = also output the listings that were read, charged per row.", "default": "baseline" }, "listingRowsLimit": { "title": "Listing rows limit on first run", "minimum": 0, "type": "integer", "description": "Caps listing rows per shop when first run outputs listings. 0 = no limit.", "default": 0 }, "changeTypes": { "title": "Change types", "type": "array", "description": "Which changes to output. Unselected changes are not output and not charged.", "items": { "type": "string", "enum": [ "newListing", "priceChange", "saleChange", "stockChange", "removedListing", "shopSales", "newReview", "listingReviews" ], "enumTitles": [ "New listings", "Price changes", "Sale started / ended", "Sold out / back in stock (single listings)", "Removed listings", "Shop total sales changed", "New shop reviews", "Listing review count changed (single listings)" ] }, "default": [ "newListing", "priceChange", "saleChange", "stockChange", "removedListing", "shopSales", "newReview", "listingReviews" ] }, "minPriceChangePct": { "title": "Min price change %", "minimum": 0, "type": "number", "description": "Ignore price changes smaller than this (e.g. 2 = only changes of 2% or more).", "default": 0 }, "stateStoreName": { "title": "Monitor name (state store)", "type": "string", "description": "Named key-value store that remembers the previous run. Use a different name for each independent monitor/task. Only a-z, 0-9 and -.", "default": "etsy-shop-monitor-state" }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Two-letter country of the residential IP. Prices and currency follow it (US = USD).", "default": "US" } } }, "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 } } } } } } } } } }