{
  "openapi": "3.0.1",
  "info": {
    "title": "Etsy Keyword Research, Shop & Sales Analytics",
    "description": "Etsy keyword research, competitor shops and listing analytics with sales estimates. 21 tools: keyword metrics and history, shop profiles, top listings, sales charts. JSON for sellers and AI agents. Free Apify accounts accepted; $0.003 per completed analysis for paid accounts.",
    "version": "0.3",
    "x-build-id": "2pzdOEXpWMsG9agX6"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rustic_spear~tagavo-etsy-analytics/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rustic_spear-tagavo-etsy-analytics",
        "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/rustic_spear~tagavo-etsy-analytics/runs": {
      "post": {
        "operationId": "runs-sync-rustic_spear-tagavo-etsy-analytics",
        "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/rustic_spear~tagavo-etsy-analytics/run-sync": {
      "post": {
        "operationId": "run-sync-rustic_spear-tagavo-etsy-analytics",
        "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": [
          "tool"
        ],
        "properties": {
          "tool": {
            "title": "Etsy operation",
            "enum": [
              "etsy.keyword_metrics",
              "etsy.keyword_history",
              "etsy.related_keywords",
              "etsy.similar_keywords",
              "etsy.linked_keywords",
              "etsy.top_keywords",
              "etsy.keyword_listings",
              "etsy.keyword_compare",
              "etsy.keyword_demand",
              "etsy.search_shops",
              "etsy.browse_shops",
              "etsy.shop_profile",
              "etsy.shop_analysis",
              "etsy.shop_charts",
              "etsy.shop_top_listings",
              "etsy.search_listings",
              "etsy.listing_detail",
              "etsy.listings_batch",
              "etsy.listing_view_history",
              "etsy.taxonomies",
              "etsy.taxonomy_properties"
            ],
            "type": "string",
            "description": "Choose one read-only Etsy analysis. See the README for required arguments, returned fields and coverage limits."
          },
          "args": {
            "title": "Bounded arguments",
            "type": "object",
            "description": "JSON arguments for the chosen tool. The Actor checks required fields, limits and supported combinations before collecting data. See the README for each tool’s accepted arguments.",
            "properties": {
              "keyword": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100,
                "title": "Keyword",
                "editor": "textfield",
                "description": "Optional form field. Accepted only when selected operation supports keyword; exact bounds and combinations are checked by the Actor."
              },
              "limit": {
                "type": "integer",
                "minimum": 1,
                "maximum": 200,
                "title": "Limit",
                "editor": "number",
                "description": "Maximum records for tools that accept a limit: 1 to 25, except etsy.taxonomies, which accepts 1 to 200. Other tools reject this field."
              },
              "page": {
                "type": "integer",
                "minimum": 1,
                "maximum": 20,
                "title": "Page",
                "editor": "number",
                "description": "Optional form field. Accepted only when selected operation supports page; exact bounds and combinations are checked by the Actor."
              },
              "sort_by": {
                "type": "string",
                "enum": [
                  "sales",
                  "sales7d",
                  "sales28d",
                  "admirers",
                  "activeListings",
                  "estimatedMonthlyRevenueUSD",
                  "creationDate",
                  "relevant",
                  "trending",
                  "dailyViews",
                  "views",
                  "favorites",
                  "price"
                ],
                "title": "Sort by",
                "editor": "select",
                "description": "Optional form field. Accepted only when selected operation supports sort_by; exact bounds and combinations are checked by the Actor."
              },
              "order": {
                "type": "string",
                "enum": [
                  "asc",
                  "desc"
                ],
                "title": "Order",
                "editor": "select",
                "description": "Optional form field. Accepted only when selected operation supports order; exact bounds and combinations are checked by the Actor."
              },
              "keywords": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "minItems": 1,
                "maxItems": 5,
                "title": "Keywords",
                "editor": "json",
                "description": "Optional form field. Accepted only when selected operation supports keywords; exact bounds and combinations are checked by the Actor."
              },
              "period": {
                "type": "string",
                "enum": [
                  "1d",
                  "3d",
                  "7d",
                  "30d",
                  "7",
                  "30",
                  "90",
                  "365"
                ],
                "title": "Period",
                "editor": "select",
                "description": "For etsy.keyword_demand: 1d, 3d, 7d or 30d. For etsy.shop_charts: 7, 30, 90 or 365. Other tools reject this field."
              },
              "query": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100,
                "title": "Query",
                "editor": "textfield",
                "description": "Optional form field. Accepted only when selected operation supports query; exact bounds and combinations are checked by the Actor."
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100,
                "title": "Name",
                "editor": "textfield",
                "description": "Optional form field. Accepted only when selected operation supports name; exact bounds and combinations are checked by the Actor."
              },
              "country": {
                "type": "string",
                "minLength": 2,
                "maxLength": 2,
                "title": "Country",
                "editor": "textfield",
                "description": "Shop-browse country filter: two uppercase letters, for example FR."
              },
              "taxonomy_id": {
                "type": "integer",
                "minimum": 1,
                "maximum": 1000000000,
                "title": "Taxonomy id",
                "editor": "number",
                "description": "Optional form field. Accepted only when selected operation supports taxonomy_id; exact bounds and combinations are checked by the Actor."
              },
              "product_type": {
                "type": "string",
                "enum": [
                  "physical",
                  "download"
                ],
                "title": "Product type",
                "editor": "select",
                "description": "Optional form field. Accepted only when selected operation supports product_type; exact bounds and combinations are checked by the Actor."
              },
              "sales_min": {
                "type": "integer",
                "minimum": 0,
                "maximum": 1000000000,
                "title": "Sales min",
                "editor": "number",
                "description": "Optional form field. Accepted only when selected operation supports sales_min; exact bounds and combinations are checked by the Actor."
              },
              "sales_max": {
                "type": "integer",
                "minimum": 0,
                "maximum": 1000000000,
                "title": "Sales max",
                "editor": "number",
                "description": "Optional form field. Accepted only when selected operation supports sales_max; exact bounds and combinations are checked by the Actor."
              },
              "price_min": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000,
                "title": "Price min",
                "editor": "number",
                "description": "Optional form field. Accepted only when selected operation supports price_min; exact bounds and combinations are checked by the Actor."
              },
              "price_max": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000,
                "title": "Price max",
                "editor": "number",
                "description": "Optional form field. Accepted only when selected operation supports price_max; exact bounds and combinations are checked by the Actor."
              },
              "age_min": {
                "type": "integer",
                "minimum": 0,
                "maximum": 50000,
                "title": "Age min",
                "editor": "number",
                "description": "Optional form field. Accepted only when selected operation supports age_min; exact bounds and combinations are checked by the Actor."
              },
              "age_max": {
                "type": "integer",
                "minimum": 0,
                "maximum": 50000,
                "title": "Age max",
                "editor": "number",
                "description": "Optional form field. Accepted only when selected operation supports age_max; exact bounds and combinations are checked by the Actor."
              },
              "shop_name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "title": "Shop name",
                "editor": "textfield",
                "description": "Optional form field. Accepted only when selected operation supports shop_name; exact bounds and combinations are checked by the Actor."
              },
              "etsy_listing_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 20,
                "title": "Etsy listing id",
                "editor": "textfield",
                "description": "Optional form field. Accepted only when selected operation supports etsy_listing_id; exact bounds and combinations are checked by the Actor."
              },
              "etsy_listing_ids": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 20
                },
                "minItems": 1,
                "maxItems": 5,
                "title": "Etsy listing ids",
                "editor": "json",
                "description": "Optional form field. Accepted only when selected operation supports etsy_listing_ids; exact bounds and combinations are checked by the Actor."
              }
            },
            "default": {},
            "additionalProperties": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}