文档 API v2searchCatalog

searchCatalog

搜索 catalog 实体

跨实体搜索。object= 选择族。命中为带 target_object 的 search_result 行。可匿名调用，按 IP 地址限流；应用密钥或带 catalog:read 的用户访问令牌各有更高的额度。cursor= 翻页。不接受 ids=。page= 选择 page 模式（见 page 参数）。object=trait 的命中带 trait_path（根分组与直接父节点）。未带 nsfw=true 时，性相关族的特征文档不进入结果，也不计入 total。命中只带名字、sources 与 content_rating：要按标题匹配作品，并在同一次请求里拿到封面、发售日、companies、intros、tags、ratings、playtimes 或 refs，请用 GET /v2/catalog/works?q= 配合 include= 或 view=full。

get/v2/catalog/search

scope catalog:read可匿名调用（不带凭据按 IPv4 地址或 IPv6 /64 限流（默认 30 次/分钟、1,000 次/天）；带 nmk_ 应用密钥或带 catalog:read 的用户访问令牌则走各自更高的额度）

参数

参数	类型	位置	说明
`cursor`	`string`	`query`	来自先前 next_cursor 的不透明 keyset cursor。必须以 cur_ 开头。
`limit`	`string`	`query`	页大小 1-100，缺省 20。超过 100 为 400 LIMIT_TOO_LARGE，不钳制。
`view`	`string`	`query`	basic（默认）或 full。封闭词表。
`include`	`string`	`query`	逗号分隔的块。未知 token 返回 400 UNKNOWN_INCLUDE。
`fields`	`string`	`query`	view/include 之后逗号分隔的顶层键。未知 token 返回 400 UNKNOWN_FIELD。object 与 id 始终保留。
`ids`	`string`	`query`	逗号分隔的 id，最多 100 个。批量车道：无分页。
`refs`	`string`	`query`	逗号分隔的 source:external_id，最多 100 个。批量车道：无分页。
`include_total`	`string`	`query`	true 则包含 total。仅 true 或 false。
`facets`	`string`	`query`	逗号分隔的 facet 名称。未知 token 返回 400 UNKNOWN_FACET。
`sort`	`string`	`query`	各集合封闭的排序键。
`nsfw`	`string`	`query`	true 包含 r18。false 或缺省则隐藏 r18。仅 true 或 false。
`page`	`string`	`query`	从 1 开始的页码。选择 page 模式：响应携带 total 与 total_relation，且无 next_cursor。page 乘 limit 不得超过 10000；最后可到达的页为 min(ceil(total/limit), floor(10000/limit))。不能与 cursor、ids 或 refs 组合。
`q`	`string`	`query`	搜索字符串。为空则按人气序列出该家族。
`object`	`string`	`query`	必填家族：work、character、credit_name、company、tag、series、engine、trait。
`locale`	`string`	`query`	zh 或 ja。对作品忽略。不得用作判别条件。

响应

facetsmap<string, object[]>
具名 facet 桶。仅在请求 facets= 时出现。
- «key»object[] 可空
itemsobject[] 必填
本页成员。空数组，从不为 null。
- content_ratingstring 必填可空
  仅在 work 命中上设置。否则为 null。
  枚举all_agessensitiver18
- display_namestring 必填
  不得用作判别条件。
- idstring 必填
  命中项的 catalog id。
- is_sexualboolean 必填可空
  仅在 trait 命中上设置。否则为 null。
- latinstring 必填可空
  未记录则为 null。不得用作判别条件。
- localizedmap<string, object> 必填
  BCP-47 键。没有则为空对象。不得用作判别条件。
- objectstring 必填
  类型判别字段。恒为 search_result。
  枚举search_result
- sourcesstring[] 必填
  开放词表来源。空数组，从不为 null。
- tag_kindstring 必填可空
  仅在 tag 命中上设置。否则为 null。
  枚举contentmeta
- target_objectstring 必填
  命中所属的族。
  枚举workcharactercredit_namecompanytagseriesenginetrait
- tierstring 必填可空
  仅在 tag 命中上设置。否则为 null。
  枚举corelongtailhidden
- trait_pathobject 必填可空
  仅在 trait 命中上设置。否则为 null。
missingstring[]
已请求但不可见的 ids。仅出现在 ids=/refs= 批量车道。
next_cursorstring
不透明 keyset cursor。末页省略。
objectstring 必填
类型判别字段。恒为 list。
枚举list
totalintegerint64
include_total=true 时出现；页码模式（page=）下恒在。与 items 同一个可见性闸。
total_relationstring
仅在 page 模式出现。eq：total 为精确值。gte：total 为下界。
枚举eqgte

请求示例

cURL

curl "https://api.nextmoe.dev/v2/catalog/search"