{ "openapi": "3.0.1", "info": { "title": "Etsy Keyword Suggestions - what Etsy's search box completes", "description": "Etsy's own search suggestions for your seed keywords, from the public endpoint the etsy.com search box uses: every completion, expanded letter by letter (seed + a-z, 0-9) and optionally one level deep. One row per unique suggestion with its seed, query and position. No login, no invented volumes.", "version": "0.1", "x-build-id": "K135MAvmVdIb1Mc4X" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vital_tuxedo~etsy-keyword-suggestions/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vital_tuxedo-etsy-keyword-suggestions", "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/vital_tuxedo~etsy-keyword-suggestions/runs": { "post": { "operationId": "runs-sync-vital_tuxedo-etsy-keyword-suggestions", "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/vital_tuxedo~etsy-keyword-suggestions/run-sync": { "post": { "operationId": "run-sync-vital_tuxedo-etsy-keyword-suggestions", "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": "Seed keywords", "type": "array", "description": "The keywords to expand. Each is sent to Etsy's search-suggestions endpoint as typed; with Expand on, each is also sent followed by a space and every letter a-z and digit 0-9 (36 more queries per seed).", "default": [ "candle" ], "items": { "type": "string" } }, "expand": { "title": "Expand letter by letter", "type": "boolean", "description": "Also query each seed followed by a space and each of a-z, 0-9. This is what surfaces the long tail (\"candle w\" -> \"candle warmer\", \"candle wedding favor\"). On by default; 36 extra queries per seed.", "default": true }, "depth": { "title": "Depth", "minimum": 0, "maximum": 2, "type": "integer", "description": "0: query the seeds only. 1: seeds plus their letter-by-letter expansion (when Expand is on). 2: additionally query every suggestion found so far as a seed of its own, one level deep. Depth 2 can be hundreds of queries per seed; bound it with Max queries.", "default": 1 }, "maxQueries": { "title": "Max queries", "minimum": 0, "type": "integer", "description": "Stop after this many suggestion requests. 0 means unbounded. Each request is one query event.", "default": 2000 }, "maxSuggestions": { "title": "Max suggestions", "minimum": 0, "type": "integer", "description": "Stop after this many unique suggestions have been pushed. 0 means unbounded. Each unique suggestion is one suggestion-row event.", "default": 10000 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many suggestion requests are in flight at once. Keep it low; Etsy is asked politely.", "default": 4 }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 1, "maximum": 60, "type": "integer", "description": "A request that does not answer within this many seconds is retried, then recorded as an error.", "default": 15 } } }, "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 } } } } } } } } } }