search - ニコニコAPIリストwiki

[Web API, 非ログイン可]

search

検索API。

出典

niconico コンテンツ検索APIドキュメント (魚拓)
- 2017/03/18からアクセスできなくなっている。仕様変更の可能性？

リクエスト URL

GET http://api.search.nicovideo.jp/api/v2/{service}/contents/search?{queryParameters}

例: http://api.search.nicovideo.jp/api/v2/video/contents/search?q=Haskell&targets=title,tags&fields=contentId,title,tags&_sort=-startTime

• {service}
  • video 動画
  • live 生放送
  • illust 静画(イラスト)
  • manga 静画(マンガ)
  • book 静画(書籍)
  • channel チャンネル
  • channelarticle ブロマガ記事(著名人)
  • news ニュース

• {queryParameters}

項目	必須	説明
q	*	検索キーワード。空白不可。書式詳細は＊1
targets	*	検索対象フィールド。title,description,tags,tagsExact,categoryTagsの5つから任意の数だけコンマ区切りで指定。
fields	*	取得したいフィールドを任意の数だけコンマ区切りで指定。
_sort	*	ソート基準フィールドを1つ選択。 +付きで昇順、-か記号なしで降順。
filters		フィルタ。書式詳細は＊3。
_offset		取得オフセット。デフォルト0。最大1600
_limit		1検索での最大件数。デフォルト10。最大100
_context		アプリケーション名。最大40字

＊1 クエリ詳細

機能名	例	説明
AND	猫 犬	猫 AND 犬
OR	猫 OR 犬	猫 OR 犬
ANDとOR	猫 OR 犬 雪	(猫 OR 犬) AND 雪。 ANDとORの組み合わせはORを先に書く。
フレーズ	"John Doe"	空白や演算子も含めて検索できる。
NOT	猫 -犬	猫 AND (NOT 犬)
^	-犬	NOT検索だけでは無効

＊2 フィールド詳細

フィールド名/説明	targets	fields	_sort	filters	補足
contentId コンテンツID	-	O	-	-	（http://nico.ms/{contentId}でコンテンツへのURL）
title タイトル	O	O	-	O
description 説明文	O*	O	-	O	newsではtargetsに指定不可
tags タグ一覧	O	O	-	O	空白区切りstring
tagsExact タグ（要完全一致）	O	-	-	O
categoryTags カテゴリタグ	O	O	-	O	以下では無効 - book - channel - channelarticle - news
viewCounter 再生数/来場者数	-	O	O	O	以下では無効 - channel, - channelarticle, - news
mylistCounter マイリスト数	-	O	O	O	live,channel,newsでは無効
commentCounter コメント数	-	O	O	O	channelでは無効
startTime 投稿時刻	-	O	O	O	ISO8601形式。 YYYY-MM-DDThh:mm:ss+09:00
thumbnailUrl サムネUrl	-	O	-	O	newsでは無効
communityIcon コミュアイコン	-	L	-	L	liveでのみ有効
scoreTimeshiftReserved タイムシフト予約数	-	L	L	L	liveでのみ有効
liveStatus 放送ステータス（past/onair/reserved）	-	L	-	L	liveでのみ有効

＊3 フィルタ例

タグ（完全一致）[フィールド名: tagsExact] に Java または Python を含む

filters[tags][]=Java&filters[tags][]=Python

再生数[フィールド名:viewCounter]が100万以上200万未満

filters[viewCounter][gte]=1000000&filters[viewCounter][lt]=2000000

（未満(<): lt、以下(<=): lte、以上(>=): gte、超過(>): gt）

データ形式

JSON 形式。

データサンプル

http://api.search.nicovideo.jp/api/v2/video/contents/search?q=Haskell&targets=title,tags&fields=contentId,title,tags&_sort=-startTime&_limit=2

正常な場合

変数	説明
meta.status	HTTPステータス（成功なら200）
meta.totalCount	総ヒット件数
data	ヒットしたコンテンツの配列

{
  "meta": {
    "status": 200,
    "totalCount": 44,
    "id": "ed90409b-23e3-47db-9eb9-203866f25786"
  },
  "data": [
    {
      "title": "移動型だるまさんがころんだゲームを作る５　やりこみ要素の追加",
      "contentId": "sm30276978",
      "tags": "Haskell ゲーム製作 ニコニコ技術部 自作ゲーム"
    },
    {
      "title": "移動型だるまさんがころんだゲームを作る４　敵のＡＩ更新",
      "contentId": "sm30106745",
      "tags": "Haskell ニコニコ技術部 ホラーゲーム 自作ゲーム"
    }
  ]
} 

エラーの場合

変数	説明
meta.status	HTTPステータス（エラーなら200以外）
meta.errorCode	エラーコード
meta.errorMessage	エラー内容

status: 400
不正なパラメータです。

{
  "meta": {
    "status": 400,
    "errorCode": "QUERY_PARSE_ERROR",
    "errorMessage": "query parse error"
  }
} 

status: 500
検索サーバの異常です。

{
  "meta": {
    "status": 500,
    "errorCode": "INTERNAL_SERVER_ERROR",
    "errorMessage": "please retry later."
  }
} 

status: 503
メンテナンス中です。

{
  "meta": {
    "status": 503,
    "errorCode": "MAINTENANCE",
    "errorMessage": "please retry later."
  }
} 

更新履歴

2017/03/18 記述