{ "openapi": "3.0.1", "info": { "title": "Etsy Keywords Research Tool", "description": "Collect public Etsy autocomplete suggestions from seed terms. Export suggestion text, ranks, source queries, market metadata, and Etsy search URLs for SEO research.", "version": "0.2", "x-build-id": "yCqeMXFkXTe6R0SbD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~etsy-keywords-research-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-etsy-keywords-research-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/maximedupre~etsy-keywords-research-tool/runs": { "post": { "operationId": "runs-sync-maximedupre-etsy-keywords-research-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/maximedupre~etsy-keywords-research-tool/run-sync": { "post": { "operationId": "run-sync-maximedupre-etsy-keywords-research-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Seed keywords", "type": "array", "description": "Etsy search terms to research. Use broad product, niche, or occasion phrases such as gift, wall art, birthday card, or handmade jewelry.", "items": { "type": "string", "minLength": 1 } }, "expandPrefixes": { "title": "Expand with characters", "type": "boolean", "description": "Collect suggestions for the seed keyword plus one-character suffixes, such as gift a and gift b, to find more long-tail keyword ideas.", "default": true }, "prefixCharacters": { "title": "Expansion characters", "type": "string", "description": "Letters or digits to append after each seed during expansion. Keep the default alphabet for a broad first pass. This value is ignored when expansion is off.", "default": "abcdefghijklmnopqrstuvwxyz" }, "maxResultsPerKeyword": { "title": "Suggestions per keyword", "minimum": 1, "type": "integer", "description": "Maximum unique Etsy keyword suggestions to save for each seed keyword. Leave it empty to return all available results until the source is exhausted, unless the total limit stops the run first." }, "maxTotalResults": { "title": "Total suggestions", "minimum": 1, "type": "integer", "description": "Maximum unique Etsy keyword suggestions to save across the whole run. Leave it empty to return all available results until the source is exhausted, unless the per-keyword limit stops the run first." }, "country": { "title": "Country", "type": "string", "description": "Two-letter market country code used for the run and saved as output metadata.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Language code used for the run and saved as output metadata.", "default": "en" }, "sortOutputBy": { "title": "Output order", "enum": [ "sourceOrder", "suggestion", "seedKeyword" ], "type": "string", "description": "Choose how accepted keyword suggestions are saved in the dataset.", "default": "sourceOrder" }, "includeSearchUrls": { "title": "Include Etsy search URLs", "type": "boolean", "description": "Add a ready-to-open Etsy search URL for each keyword suggestion.", "default": true }, "includeNormalizedKeyword": { "title": "Include normalized keywords", "type": "boolean", "description": "Add a lowercase normalized keyword field for analysis.", "default": 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 } } } } } } } } } }