{
  "openapi": "3.0.1",
  "info": {
    "title": "Naver DataLab Scraper - Shopping Insight & Keyword Trends API",
    "description": "Naver Shopping Insight category and keyword click trends plus Naver search trends via the official NAVER API HUB, run with your own key. Compare 5+ keywords on one scale, split by device, gender and age, growth %.",
    "version": "0.0",
    "x-build-id": "SwdVcWMFns9Ymm5Mr"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/koreadata-lab~naver-shopping-insight-search-trends/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-koreadata-lab-naver-shopping-insight-search-trends",
        "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/koreadata-lab~naver-shopping-insight-search-trends/runs": {
      "post": {
        "operationId": "runs-sync-koreadata-lab-naver-shopping-insight-search-trends",
        "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/koreadata-lab~naver-shopping-insight-search-trends/run-sync": {
      "post": {
        "operationId": "run-sync-koreadata-lab-naver-shopping-insight-search-trends",
        "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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "shoppingCategory",
              "shoppingKeyword",
              "shoppingCategoryDevice",
              "shoppingCategoryGender",
              "shoppingCategoryAge",
              "shoppingKeywordDevice",
              "shoppingKeywordGender",
              "shoppingKeywordAge"
            ],
            "type": "string",
            "description": "search = Naver search query volume trend (relative). shoppingCategory / shoppingKeyword = Naver Shopping click trends (Shopping Insight). The 'by device / gender / age' modes split one category (each entry in Shopping categories) or each keyword (in the first category) into PC/mobile, male/female or 10s-60s segments, with each segment's share.",
            "default": "search"
          },
          "keywordGroups": {
            "title": "Keyword groups",
            "maxItems": 50,
            "type": "array",
            "description": "For search / shoppingKeyword mode. List of groups: [{\"name\": \"humidifier\", \"keywords\": [\"가습기\", \"가열식가습기\"]}]. A plain string is treated as a group with one keyword. More than 5 groups are split into batches and re-scaled with an anchor so all values share one scale. Max 50 groups. For 'Shopping keyword by device/gender/age' each group is one call and only its first keyword is used."
          },
          "shoppingCategories": {
            "title": "Shopping categories (IDs)",
            "maxItems": 30,
            "type": "array",
            "description": "For shoppingCategory mode: [{\"name\": \"Digital & appliances\", \"id\": \"50000003\"}]. For shopping keyword modes only the FIRST id is used; category breakdown modes make one call per id. Category IDs are in the Naver Shopping URL (catId=...). Top-level IDs: 50000000 Fashion apparel, 50000001 Fashion accessories, 50000002 Cosmetics & beauty, 50000003 Digital & appliances, 50000004 Furniture & interior, 50000005 Maternity & baby, 50000006 Food, 50000007 Sports & leisure, 50000008 Living & health, 50000009 Leisure & convenience, 50000010 Duty free."
          },
          "anchorKeyword": {
            "title": "Anchor keyword (for > 5 groups)",
            "type": "string",
            "description": "Keyword included in every batch to put batches on a common scale. Pick something with stable, non-zero volume. Defaults to the first group.",
            "default": ""
          },
          "startDate": {
            "title": "Start date",
            "type": "string",
            "description": "YYYY-MM-DD. Earliest allowed: 2016-01-01 (search) / 2017-08-01 (shopping). Default: 365 days ago.",
            "default": ""
          },
          "endDate": {
            "title": "End date",
            "type": "string",
            "description": "YYYY-MM-DD. Default: yesterday (KST).",
            "default": ""
          },
          "completePeriodsOnly": {
            "title": "Complete periods only",
            "type": "boolean",
            "description": "When no end date is given, stop at the last complete week or month (weeks are Monday-Sunday). A half-finished last week would otherwise look like a sudden drop.",
            "default": true
          },
          "timeUnit": {
            "title": "Time unit",
            "enum": [
              "date",
              "week",
              "month"
            ],
            "type": "string",
            "description": "Granularity of the series.",
            "default": "week"
          },
          "device": {
            "title": "Device",
            "enum": [
              "",
              "pc",
              "mo"
            ],
            "type": "string",
            "description": "Filter by device.",
            "default": ""
          },
          "gender": {
            "title": "Gender",
            "enum": [
              "",
              "m",
              "f"
            ],
            "type": "string",
            "description": "Filter by gender.",
            "default": ""
          },
          "ages": {
            "title": "Age groups",
            "type": "array",
            "description": "Empty = all ages. Search mode codes: 1=0-12, 2=13-18, 3=19-24, 4=25-29, 5=30-34, 6=35-39, 7=40-44, 8=45-49, 9=50-54, 10=55-59, 11=60+. Shopping mode uses decades: 10,20,30,40,50,60.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "20",
                "30",
                "40",
                "50",
                "60"
              ]
            },
            "default": []
          },
          "outputFormat": {
            "title": "Output format",
            "enum": [
              "series",
              "points"
            ],
            "type": "string",
            "description": "series is best for dashboards and AI agents; points is best for spreadsheets/BI tools.",
            "default": "series"
          },
          "apiProvider": {
            "title": "API provider",
            "enum": [
              "auto",
              "apihub",
              "legacy"
            ],
            "type": "string",
            "description": "NAVER API HUB (Naver Cloud Platform) is the primary path. Legacy NAVER Developers keys keep working only until 2027-06-30 and no new ones are issued.",
            "default": "auto"
          },
          "apiHubClientId": {
            "title": "NAVER API HUB Client ID",
            "type": "string",
            "description": "Naver Cloud Platform console > Services > NAVER API HUB > Application > 인증 정보. Add 검색어 트렌드 and/or 쇼핑인사이트 to the application. Sent only as the X-NCP-APIGW-API-KEY-ID header."
          },
          "apiHubClientSecret": {
            "title": "NAVER API HUB Client Secret",
            "type": "string",
            "description": "Client Secret of the same API HUB application. Sent only as the X-NCP-APIGW-API-KEY header."
          },
          "legacyClientId": {
            "title": "Legacy NAVER Developers Client ID (fallback)",
            "type": "string",
            "description": "Optional. An existing developers.naver.com app key. Used only if API HUB keys are missing or rejected, and only until 2027-06-30."
          },
          "legacyClientSecret": {
            "title": "Legacy NAVER Developers Client Secret (fallback)",
            "type": "string",
            "description": "Optional. Client Secret of the same legacy app."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}