文档 API v2listCatalogCharacters

listCatalogCharacters

列出角色

keyset 分页的角色。需要应用密钥。ids=/refs= 是批量车道，不分页。include=gender,birthday,height_cm,weight_kg,measurements,blood_type,instance_of_id,image,figure,traits,aliases,intros,refs 在每条车道都填充，view=full 即它们全部；traits 按默认 spoiler 上限截断并遵循 nsfw 门，与详情面完全一致。

get/v2/catalog/characters

scope catalog:readAuthorization: Bearer nmk_live_…（v2 应用密钥,门户自助铸造,无需申请）

参数

参数	类型	位置	说明
`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。

响应

facetsmap<string, object[]>
具名 facet 桶。仅在请求 facets= 时出现。
- «key»object[] 可空
itemsobject[] 必填
本页成员。空数组，从不为 null。
- aliasesobject[]
  本角色名的别名拼写。在 include=aliases 时出现，仅详情面。没有则为空数组。
- birthdaystring
  MM-DD。在 view=full 时出现。未记录则为 null。不是日期：没有年份。
- blood_typestring
  在 view=full 时出现。未记录则为 null。
  枚举ababo
- display_namestring 必填
  不得用作判别条件。
- figureobject
- genderstring
  在 view=full 时出现。未记录则为 null。
  枚举malefemaleother
- height_cmintegerint64
  在 view=full 时出现。未记录则为 null。
- idstring 必填
  catalog 角色 id。
- imageobject
- instance_of_idstring
  本行所实例化的另一角色。在 view=full 时出现。没有则为 null。
- introsobject[]
  角色描述，每种语言一条。在 include=intros 时出现，仅详情面。没有则为空数组。
- langstringbcp47 必填可空
  display_name 的 BCP-47 语言标签。未记录则为 null。不得用作判别条件。
- latinstring 必填可空
  未记录则为 null。不得用作判别条件。
- localizedmap<string, object> 必填
  BCP-47 键。没有则为空对象。不得用作判别条件。
- measurementsobject
- objectstring 必填
  类型判别字段。恒为 character。
  枚举character
- refsobject[]
  此角色的 exact 上游锚。在 include=refs 时出现，仅详情面。没有则为空数组。
- traitsobject[]
  仅当 include=traits 时出现，且仅在详情面。没有则为空数组。
- weight_kgintegerint64
  在 view=full 时出现。未记录则为 null。
missingstring[]
已请求但不可见的 ids。仅出现在 ids=/refs= 批量车道。
next_cursorstring
不透明 keyset cursor。末页省略。
objectstring 必填
类型判别字段。恒为 list。
枚举list
totalintegerint64
仅当 include_total=true 时出现。与 items 同一可见性闸。

请求示例

cURL

curl "https://api.nextmoe.dev/v2/catalog/characters" \
  -H "Authorization: Bearer nmk_live_<YOUR_KEY>"