{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper", "description": "Search Etsy by keyword and get prices, in-cart counts, last sale time, sponsored vs organic rank, stock, discounts, shop sales and badges. Optional tags, favorites and description. No login. Pay only for results.", "version": "1.0", "x-build-id": "g5k1lGvCgLEhwdYN4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-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/axlymxp~etsy-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-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/axlymxp~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Search Keywords", "type": "string", "description": "Primary search terms for Etsy listings" }, "limit": { "title": "Maximum Results", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of listings to collect (default 100, 0 = as many as the run can reach). Etsy answers about 36 listings per search, so the actor combines price bands and rankings to reach more; very popular keywords can return thousands, narrow keywords fewer. You are charged per listing.", "default": 100 }, "offset": { "title": "Starting Offset (ignored)", "minimum": 0, "type": "integer", "description": "Deprecated and ignored. Etsy's search has no paging; listings are collected price band by price band, and an interrupted run resumes by itself.", "default": 0 }, "minPrice": { "title": "Minimum Price (USD)", "minimum": 0, "type": "number", "description": "Minimum price filter in USD" }, "maxPrice": { "title": "Maximum Price (USD)", "minimum": 0, "type": "number", "description": "Maximum price filter in USD" }, "shipTo": { "title": "Shipping Destination", "type": "string", "description": "Shipping destination country code (e.g. US, GB, CA, AU, DE, FR, JP)", "default": "US" }, "sortOn": { "title": "Sort Order", "enum": [ "best_seller", "price_asc", "price_desc", "created_desc", "score" ], "type": "string", "description": "Which listings come first. Etsy's app search only honours relevance, newest first and price order, and the actor walks price bands in that order. 'Best Sellers' has no separate ranking on Etsy and behaves like Relevance; use the in_cart_count and is_bestseller columns to find top sellers.", "default": "score" }, "freeShipping": { "title": "Free Shipping Only", "type": "boolean", "description": "Only include listings with free shipping", "default": false }, "isDiscounted": { "title": "Discounted Items Only", "type": "boolean", "description": "Only include discounted listings", "default": false }, "instantDownload": { "title": "Digital Downloads Only", "type": "boolean", "description": "Only include digital download items", "default": false }, "includeReviews": { "title": "Include Review Data", "type": "boolean", "description": "Include detailed review information (slower processing)", "default": false }, "includeDetails": { "title": "Include tags, materials, favorites & description", "type": "boolean", "description": "Open every listing to add its 13 tags, materials, favorites count, full description and 'when made'. Slower (one extra request per listing) and charged as an extra 'listing details' event per listing that returns details.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Used only when 'Include tags, materials, favorites & description' is on: Etsy rate-limits the listing-detail endpoint from cloud IPs, so those requests go through an Apify proxy. Search results need no proxy.", "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 } } } } } } } } } }