Get web document search result

Available in Classic and VPC

Get web document search results from NAVER Search.

Note

Web document searches use the Search API, which has a daily call limit of 25,000.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/search/v1/webkr

Request headers

For information about the headers common to NAVER API HUB, see NAVER API HUB request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`query`	String	Required	Search keyword Encoded with UTF-8
`display`	Integer	Optional	Number of search results to display at a time `1`-`100` (default: `10`)
`start`	Integer	Optional	Search start location `1`-`1000` (default: `1`)
`format`	String	Optional	Response format `json` (default) \| `xml`

Request example

The request example is as follows:

curl --location --request GET https://naverapihub.apigw.ntruss.com/search/v1/webkr?query=Coffee&display=2&start=1&format=json
--header X-NCP-APIGW-API-KEY-ID: {Client ID}
--header X-NCP-APIGW-API-KEY: {Client Secret}

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`lastBuildDate`	String	-	Time the search results were generated
`total`	Integer	-	Total number of search results
`start`	Integer	-	Starting location for the search
`display`	Integer	-	Number of search results to display at a time
`items`	Array	-	List of individual search results: items

items

The following describes items.

Field	Type	Required	Description
`title`	String	-	Web document title Portions matching the search keyword are wrapped in `<b>` tags.
`link`	String	-	Web document URL
`description`	String	-	Passage information summarizing the web document content Portions matching the search keyword are wrapped in `<b>` tags.

Response status codes

The following describes the response status codes.

HTTP status code	Code	Message	Description
400	`SE01`	Incorrect query request	Check for errors in the API request URL, such as the protocol or parameters.
400	`SE02`	Invalid display value.	Check that the `display` value is within the allowed range.
400	`SE03`	Invalid start value	Check that the `start` value is within the allowed range.
400	`SE04`	Invalid sort value	Check the `sort` value for typos.
400	`SE06`	Malformed encoding	Encode the search keyword in UTF-8.
404	`SE05`	Invalid search API	Check the API request URL for typos.
500	`SE99`	System error	An error occurred internally on the server.

Note

For information about the HTTP status codes common to all NAVER API HUB, see NAVER API HUB response status codes.

Response example

The response example is as follows:

{
    "lastBuildDate": "Thu, 11 Jun 2026 18:43:28 +0900",
    "total": 94515854,
    "start": 1,
    "display": 2,
    "items": [
        {
            "title": "<b>Coffee</b> - Namuwiki",
            "link": "https://namu.wiki/w/%EC%BB%A4%ED%94%BC",
            "description": "<b>Coffee</b> is a beverage made by roasting and grinding the seeds (beans) of the <b>coffee</b> tree."
        },
        {
            "title": "<b>Coffee</b> - Wikipedia (Korean)",
            "link": "https://ko.wikipedia.org/wiki/%EC%BB%A4%ED%94%BC",
            "description": "<b>Coffee</b> (English: coffee, 咖啡, 珈琲, gabae; North Korean: heukcha, black tea), <b>coffee</b> tea or <b>coffee</b> beverage is a bitter, dark brown beverage made by roasting the seeds (<b>coffee</b> beans) of the <b>coffee</b> tree and grinding them into powder, which is then brewed with hot or cold water or steam. Dark in color, bitter in taste, and slightly acidic, <b>coffee</b> is the main..."
        }
    ]
}

Documentation Index