naver

Get Naver Shopping click trend for keywords inside a category (쇼핑인사이트)

Returns a relative click-share time series for up to 5 search keywords WITHIN one Naver Shopping category, under data.results[].data[] as {period, ratio} pairs. Each keyword gets its OWN comparable series, so this is the endpoint for questions like which product term is gaining share inside 패션의류. Set breakdown to split a single keyword by device, gender, or age. ratio is a relative index within the requested window, not an absolute count. Shopping Insight history starts 2017-08-01 (later than search-trend's 2016-01-01); an earlier start_date is clamped up to it. A keyword with no measurable clicks returns no data points and is not charged.

get/naver/shopping-insight/keyword

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/naver/shopping-insight/keyword
  • Auth: API key in header x-api-key

Query parameters

category_codestring required

A single Naver Shopping category id to search within (e.g. 50000000). Required.

keywordstring required

Comma-separated keywords, up to 5, each returned as its own comparable series inside that category. Required. When breakdown is set, only the first keyword is used.

start_datestring

Window start, YYYY-MM-DD. Defaults to 12 months before end_date. Clamped up to 2017-08-01, the earliest Shopping Insight data Naver holds.

end_datestring

Window end, YYYY-MM-DD. Defaults to today.

time_unit'date' | 'week' | 'month'

Aggregation bucket: date, week, or month (default month).

device'pc' | 'mo'

Restrict to pc or mo (mobile). Omit for both.

gender'f' | 'm'

Restrict to f or m. Omit for both.

agesstring

Comma-separated age buckets: 10, 20, 30, 40, 50, 60. NOTE these differ from search-trend, which takes 1-11.

breakdown'device' | 'gender' | 'age'

Split a single keyword by device, gender, or age instead of comparing several keywords.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "naver",
  "endpoint": "/v1/naver/shopping-insight/keyword",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.