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.

カフェ投稿検索結果の照会

Prev Next

Classic/VPC環境で利用できます。

NAVER検索のカフェ投稿検索結果を照会します。

参考

カフェ投稿検索には検索 APIが使用され、検索 APIの1日あたりの呼び出し上限は25,000回です。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /search/v1/cafearticle

リクエストヘッダ

NAVER API HUBで共通して使用されるヘッダの詳細は、NAVER API HUBのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
query String Required 検索キーワード
  • UTF-8でエンコード
display Integer Optional 一度に表示する検索結果の数
  • 1~100 (デフォルト: 10)
start Integer Optional 検索の開始位置
  • 1~1000 (デフォルト: 1)
sort String Optional 検索結果のソート方法
  • sim (デフォルト) | date
    • sim: 正確度降順
    • date: 日付降順
format String Optional レスポンス結果
  • json(デフォルト) | xml

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
lastBuildDate String - 検索結果が生成された時間
total Integer - 検索結果の総数
start Integer - 検索の開始位置
display Integer - 一度に表示する検索結果の数
items Array - 個々の検索結果リスト: items

items

itemsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
title String - カフェ投稿の見出し
  • 検索キーワードと一致する部分は<b>タグで囲む
link String - カフェ投稿の URL
description String - カフェ投稿の内容を要約したパッセージ情報
  • 検索キーワードと一致する部分は<b>タグで囲む
cafename String - 投稿があるカフェの名前
cafeurl String - 投稿があるカフェの URL

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
400 SE01 Incorrect query request (無効なクエリリクエストです) APIリクエスト URLのプロトコルやパラメータなどにエラーがないか確認
400 SE02 Invalid display value (無効な displayの値です) displayの値が有効な範囲内であるか確認
400 SE03 Invalid start value (無効な startの値です) startの値が有効な範囲内であるか確認
400 SE04 Invalid sort value (無効な sortの値です) sortの値に誤字がないか確認
400 SE06 Malformed encoding (無効な形式のエンコードです) 検索キーワードを UTF-8でエンコード
404 SE05 Invalid search api (存在しない検索 apiです) APIリクエスト URLに誤字がないか確認
500 SE99 System Error (システムエラー) サーバ内部でエラー発生
参考

NAVER API HUBで共通して使用されるレスポンスステータスコードの詳細は、NAVER API HUBのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "lastBuildDate": "Thu, 11 Jun 2026 18:43:27 +0900",
    "total": 18906061,
    "start": 1,
    "display": 2,
    "items": [
        {
            "title": "おうちカフェ初心者向け<b>コーヒー</b>豆のおすすめを教えてください",
            "link": "https://cafe.naver.com/{cafeId}/{articleId}",
            "description": "最近おうちカフェを始めたのですが、<b>コーヒー</b>豆のおすすめをお願いします。酸味のある豆とコクのある豆の中で... ",
            "cafename": "{カフェ名}",
            "cafeurl": "https://cafe.naver.com/{cafeId}"
        },
        {
            "title": "今日の<b>コーヒー</b>オフ会レポート",
            "link": "https://cafe.naver.com/{cafeId}/{articleId}",
            "description": "定期オフ会で<b>コーヒー</b>を飲みながらお話ししたレポートです。今回はハンドドリップ... ",
            "cafename": "{カフェ名}",
            "cafeurl": "https://cafe.naver.com/{cafeId}"
        }
    ]
}