{ "openapi": "3.0.1", "info": { "title": "Etsy Listings Scraper (search, shops, listing details, prices)", "description": "Etsy scraper for listings by keyword, category URL, shop or listing id: price and variant price range, currency, shop, rating and reviews, seller tags, category path, availability, ad flag. Monitor mode alerts on price and stock changes. $5 per 1,000 listings, no login, no charge for empty runs.", "version": "0.1", "x-build-id": "yya2QUjEl1KFqnfIS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datahamster~etsy-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datahamster-etsy-listings", "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/datahamster~etsy-listings/runs": { "post": { "operationId": "runs-sync-datahamster-etsy-listings", "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/datahamster~etsy-listings/run-sync": { "post": { "operationId": "run-sync-datahamster-etsy-listings", "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": { "keywords": { "title": "Keywords", "type": "array", "description": "Etsy search queries, e.g. \"ceramic lamp\". Each search page returns up to 48 listing rows (id, title, price, currency, shop, image, ad flag).", "default": [ "ceramic lamp" ], "items": { "type": "string" } }, "categoryUrls": { "title": "Category or search URLs", "type": "array", "description": "Etsy category or search URLs, e.g. \"https://www.etsy.com/c/home-and-living/lighting\" or \"https://www.etsy.com/search?q=ceramic+lamp\". Paged the same way as keywords.", "items": { "type": "string" } }, "shops": { "title": "Shops", "type": "array", "description": "Etsy shop names exactly as they appear in etsy.com/shop/, e.g. \"DEBARROceramics\". Returns that shop's listings.", "items": { "type": "string" } }, "listingIds": { "title": "Listing ids or URLs", "type": "array", "description": "Etsy listing ids or full listing URLs, e.g. \"1769625985\" or \"https://www.etsy.com/listing/1769625985\". Each one is opened as a listing page, so the row also has tags, category, description, review count and the variant price range.", "items": { "type": "string" } }, "searchPages": { "title": "Pages per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many result pages to open per search query, shop or category URL, e.g. 1. Each page holds up to 48 listings.", "default": 1 }, "fetchDetails": { "title": "Open listing pages", "type": "boolean", "description": "If true, open every search hit's listing page to add tags, category, description, review count and priceMax. Costs one extra request per listing. Example: false.", "default": false }, "locale": { "title": "Locale", "type": "string", "description": "Accept-Language header value that decides the language of titles and categories, e.g. \"en-US\" or \"de-DE\".", "default": "en-US" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many pushed rows, e.g. 30. You are charged only for rows actually pushed.", "default": 30 }, "mode": { "title": "Mode", "enum": [ "scrape", "monitor" ], "type": "string", "description": "\"scrape\" returns every listing found; \"monitor\" returns only listings whose price, availability or review count changed since the previous run of the same saved Task, with changedFields and previous attached. Example: \"scrape\".", "default": "scrape" }, "monitorStateId": { "title": "Monitor state id", "type": "string", "description": "Optional state id when not running as a saved task (monitor mode)" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL that receives a POST with the monitor-mode change summary (JSON), e.g. \"https://hooks.zapier.com/hooks/catch/123/abc\". Leave empty to skip." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Optional Telegram bot token used to send monitor-mode change summaries, e.g. \"123456789:AAF...\". Leave empty to skip Telegram." }, "telegramChatId": { "title": "Telegram chat id", "type": "string", "description": "Optional Telegram chat id that receives monitor-mode summaries, e.g. \"-1001234567890\". Required only when telegramBotToken is set." } } }, "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 } } } } } } } } } }