Interface VideoSearchQuery

Query Parameters for https://holodex.stoplight.io/docs/holodex/7ef9a63c3d44a-create-a-search-video-search

Hierarchy

  • VideoSearchQuery

Properties

channels? conditions? lang? limit? offset? org? paginated? sort? target? topic?

Properties

Optional channels

channels?: string[]

Videos with all the specified channel ids. If two or more channel IDs are specified, will only return their collabs, or if one channel is a clipper, it will only show clips of the other vtubers made by this clipper

Optional conditions

conditions?: {
    text: "string";
}[]

Match all the following conditions

Type declaration

  • text: "string"

    Look for text in video title or description

Optional lang

lang?: string[]

If set, will filter clips to only show clips with these langs + all vtuber streams (provided target is not set to filter out streams)

Example: ["en", "ja"]

Optional limit

limit?: number

Default: 25

Optional offset

offset?: number

Optional org

org?: string[]

Videos of channels in any of the specified orgs, or clips that involve a channel in the specified org.

Optional paginated

paginated?: boolean

If paginated is set to true, return an object with total, otherwise returns an array. Default

Optional sort

sort?: "oldest" | "newest"

Default: newest

Optional target

target?: ("stream" | "clip")[]

Target types of videos

Optional topic

topic?: string[]

Return videos that match one of the provided topics

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc