{ "openapi": "3.0.1", "info": { "title": "Etsy Keyword Research + Reverse Keyword Tool", "description": "Find the Etsy keywords actually worth chasing. Every term is scored on real demand (live carts, recent sales), competition and buyer intent, measured from Etsy instead of estimated. Reverse-keyword a competitor's listing or a whole shop to see the searches Etsy ties to them.", "version": "0.1", "x-build-id": "nGZ8ai4q9yhDKsG67" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yumitori~etsy-keyword-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yumitori-etsy-keyword-tool", "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/yumitori~etsy-keyword-tool/runs": { "post": { "operationId": "runs-sync-yumitori-etsy-keyword-tool", "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/yumitori~etsy-keyword-tool/run-sync": { "post": { "operationId": "run-sync-yumitori-etsy-keyword-tool", "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": { "seeds": { "title": "Seed keywords", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Enter one or more seed keywords (e.g. \"ceramic mug\", \"dog bandana\"). Each is expanded into its long-tail universe and scored on live demand, competition and opportunity. Leave empty if you're using Reverse keyword or Whole-shop below.", "items": { "type": "string" } }, "depth": { "title": "Expansion depth", "minimum": 1, "maximum": 3, "type": "integer", "description": "How many hops of autosuggest expansion: 1 = direct suggestions only; 2 = suggestions-of-suggestions (much wider); 3 explodes fast. Only affects seed keywords.", "default": 2 }, "maxKeywords": { "title": "Max keywords per seed", "minimum": 5, "maximum": 100, "type": "integer", "description": "Upper limit on keywords per seed (each is one scored row). It's a cap, not a guarantee — a seed only returns as many keywords as Etsy actually has autosuggest data for, and any keyword with no live listings is dropped. A run is also hard-capped at 200 keywords total, split evenly across seeds. Only affects seed keywords.", "default": 40 }, "reverseListingUrls": { "title": "Competitor listing URLs or IDs", "maxItems": 25, "uniqueItems": true, "type": "array", "description": "Paste competitor Etsy listing URLs (or numeric IDs). For each, the tool returns Etsy's own \"Related searches\" — the actual queries Etsy maps to that listing — scored like any keyword. Use this instead of, or alongside, seed keywords. (Leave empty if you're not doing reverse research.)", "items": { "type": "string", "pattern": "\\d{6,}" } }, "shopName": { "title": "Shop name or URL", "type": "string", "description": "Enter ONE Etsy shop (name, @handle, or URL) to reverse-keyword its whole catalog — every search Etsy associates with every listing, scored. ⚠️ This mode RUNS BY ITSELF: when this field has a value, the seed keywords and competitor listings above are IGNORED. It's request-heavy (~1 request per listing), so it's capped below. Brand-new listings won't return searches yet, so the count can be lower than the shop's listing total — that's expected." }, "maxShopListings": { "title": "Max listings to scan", "minimum": 5, "maximum": 200, "type": "integer", "description": "Upper limit on how many of the shop's listings to scan. Each listing is roughly one request, so this caps cost and runtime. Only used in whole-shop mode.", "default": 50 } } }, "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 } } } } } } } } } }