Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

NAVER API HUB overview

Prev Next

Available in Classic and VPC

NAVER API HUB is a NAVER Cloud Platform service that supports NAVER’s search results and search data analysis features. The NAVER API HUB service provides APIs for search, search keyword trends, and shopping insights in the RESTful format.

API key

The NAVER API HUB issues an API key, an identification tool, to each account so that only authorized users can call it. The API key is used as a parameter in the request header that is passed as authentication information when calling the API. Therefore, to use NAVER API HUB, you must first obtain an API key.

Register application

You can obtain an API key from the NAVER API HUB in the NAVER Cloud Platform console. To register your application:

  1. Access the NAVER Cloud Platform console.
  2. Click Region & Platform at the upper right corner of the console page.
  3. Select the Region and platform you're using, and then click [Apply].
  4. Click Menu at the upper left corner of the console page.
  5. Go to All Services > Application Services > NAVER API HUB.
  6. Click Application from the left side of the page.
  7. Click [Register application] when the Application Management page appears.
  8. Select the API you want to use, and then click [Next].
  9. Enter the application name, and then click [Complete].

Issue API key

You can obtain an API key from the NAVER API HUB in the NAVER Cloud Platform console. To issue them:

  1. Access the NAVER Cloud Platform console.
  2. Click Region & Platform at the upper right corner of the console page.
  3. Select the Region and platform you're using, and then click [Apply].
  4. Click Menu at the upper left corner of the console page.
  5. Go to All Services > Application Services > NAVER API HUB.
  6. Click Application from the left side of the page.
  7. When the Application Management page appears, select Application and click [Authentication information] under Manage API.
  8. When the Authentication information pop-up window appears, copy the Client ID and Client Secret respectively, and click [OK].

Reissue client secret.

If your client secret has been exposed to a third party or you suspect it has been compromised, you must reissue it. To reissue it:

  1. From the NAVER Cloud Platform console, go to Menu > All Services > Application Services > NAVER API HUB.
  2. Click Application from the left side of the page.
  3. When the Application Management page appears, select Application and click [Authentication information] under Manage API.
  4. When the Authentication information pop-up window appears, click [Reissue].
  5. When the Change client secret pop-up window appears, click [OK].

Common NAVER API HUB settings

The following describes commonly used request and response formats in NAVER API HUB APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://naverapihub.apigw.ntruss.com

Request headers

The following describes the request headers.

Field Required Description
X-NCP-APIGW-API-KEY-ID Required Client ID issued in NAVER Cloud Platform
X-NCP-APIGW-API-KEY Required Client secret mapped to a client ID
Content-Type Optional application/json
  • Search trends using the POST method with a request body are available only in the Shopping Insight API
  • They are not available in the GET-based search APIs.

Response

The following describes the common response format.

Response body

The error response body is returned in one of the following three formats, depending on the layer where the error occurred.

1. API Gateway errors
These are errors that occurred at the gateway layer, such as authentication failures or routing failures. They are returned wrapped in an error object.

Field Type Required Description
error.errorCode String - Error code
error.message String - Error message
error.details String - Error details

2. Search API errors
These are validation errors in the Search API request parameters. The results are returned in a flat structure.

Field Type Required Description
errorCode String Required Error code
errorMessage String Required Error message

3. Search Trend, Shopping Insight errors
These are request body validation errors. The results are returned in a flat structure.

Field Type Required Description
errMsg String Required Error message
errId String Required Error identifier (including time of occurrence)
body String Optional Request body that failed validation

Response status codes

The following describes the response status codes.

HTTP status code Code Message Description
300 300 No API Invalid API request URL
400 400 Invalid request
  • Missing required request parameters or incorrect request parameter names
  • Request parameter values sent without URL encoding
401 401 Authentication failed
  • Missing client ID and client secret, or incorrect values
  • Call made without correctly setting the client ID and client secret in the HTTP headers
  • API permissions not configured in the application
403 403 Call not permitted by the server
  • Call made via HTTP instead of HTTPS
  • Missing required request parameters or incorrect request parameter names
  • Request parameter values sent without URL encoding
429 429 Call limit exceeded Daily quota exceeded
500 500 Server error
  • Missing required request parameters or incorrect request parameter names
  • Request parameter values sent without URL encoding
  • API call was successful, but an error occurred due to API server maintenance or a system error.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

1. API Gateway errors

{
    "error": {
        "errorCode": "200",
        "message": "Authentication Failed",
        "details": "Authentication information are missing."
    }
}

2. Search API errors

{
    "errorCode": "SE02",
    "errorMessage": "Invalid display value."
}

3. Search Trend, Shopping Insight errors

{
    "errMsg": "TypeError:  -> should have required property 'category'",
    "errId": "2026-06-11T17:51:49+09:00/804742176-19029958",
    "body": "{\"startDate\":\"2026-01-01\",\"endDate\":\"2026-03-31\",\"timeUnit\":\"month\"}"
}

NAVER API HUB API

The following describes the APIs provided by the NAVER API HUB service.

Search

The following describes the search-related APIs.

API Description
Get news search result Get news search results from NAVER Search.
Get encyclopedia search result Get encyclopedia search results from NAVER Search.
Get blog search result Get blog search results from NAVER Search.
Identify adult search keywords Identify whether an entered search keyword is an adult search keyword.
Get typo conversion result Convert search keywords entered with incorrect Korean/English key.
Get web document search result Get web document search results from NAVER Search.
Get image search result Get image search results from NAVER Search.
Get Knowledge iN search result Get Knowledge iN search results from NAVER Search.
Get local search result Get search results for local service providers and organizations on NAVER.
Get Cafe post search result Get Cafe post search results from NAVER Search.
Search examples Shopping Insight API implementation examples

Search keyword trends

The following describes the APIs related to search keyword trends.

API Description
Get search keyword trends Get search trends for integrated searches grouped by topic keywords.
Search keyword trend examples Search Trend API implementation examples

Shopping insight

The following describes the shopping insight-related APIs.

API Description
Get trends by category Get search click trends by shopping category.
Get trends by device Get search click trends for a specific shopping category by device.
Get trends by gender Get search click trends for a specific shopping category by gender.
Get trends by age Get search click trends for a specific shopping category by age.
Get trends by keyword Get search click trends for a specific shopping category by keyword.
Get keyword trends by device Get search click trends by category and keyword by device.
Get keyword trends by gender Get search click trends by category and keyword by gender.
Get keyword trends by age Get search click trends by category and keyword by age.
Get keyword trends by age Get search click trends by category and keyword by age.
Shopping Insight examples Shopping Insight API implementation examples

NAVER API HUB related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand NAVER API HUB APIs.