{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper Goat", "description": "Scrape Etsy listings, shops, and search results without a login. Pull a shop's full catalog, search results for any keyword, or a single listing in full detail with price, rating, reviews, and image gallery. Walks pagination up to your chosen limit.", "version": "0.1", "x-build-id": "kt0P9H5qCZdJErDY3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/goat255~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-goat255-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/goat255~etsy-scraper/runs": { "post": { "operationId": "runs-sync-goat255-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/goat255~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-goat255-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": { "shops": { "title": "Shops (catalog mode)", "type": "array", "description": "Shop names to pull listings from. With or without the shop/ prefix, or a full shop URL. Example: example_shop, https://www.etsy.com/shop/example_shop.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries (search mode)", "type": "array", "description": "Keyword searches to run across the marketplace. Example: ceramic mug, handmade earrings.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs or IDs (detail mode)", "type": "array", "description": "Specific listing links or IDs to fetch in full detail. Example: https://www.etsy.com/listing/1234567890/example-title or 1234567890.", "items": { "type": "string" } }, "maxResultsPerSource": { "title": "Max results per source", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Cap on listings returned per shop or search query. Pagination is walked across multiple pages until this is reached or the source is exhausted. Listing-detail mode always returns one listing per input.", "default": 100 }, "enrichListings": { "title": "Enrich shop and search listings with full detail", "type": "boolean", "description": "When on, each listing returned by shop and search modes is also opened for its full detail (description, rating, reviews, image gallery). Off by default to keep runs fast and cheap. Listing-detail mode is always full detail.", "default": false }, "includeShopProfile": { "title": "Include a shop profile record", "type": "boolean", "description": "When on, shop mode also returns one profile record per shop with location, owner, rating, and review count. Profile records are not billed.", "default": true }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many sources to process in parallel. Higher is faster but puts more load on proxies.", "default": 5 }, "proxyConfig": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy. RESIDENTIAL is the default and recommended option for the most reliable results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }