Interface BotsQuery

Hierarchy

  • BotsQuery

Properties

fields? limit? offset? search? sort?

Properties

Optional fields

fields?: string | string[]

A list of fields to show.

Optional limit

limit?: number

The amount of bots to return. Max. 500

Optional offset

offset?: number

Amount of bots to skip

Optional search

search?: string | {
    avatar?: string;
    bannerUrl?: string;
    certifiedBot: string;
    date: string;
    defAvatar: string;
    discriminator: string;
    donatebotguildid: string;
    github?: string;
    guilds: string;
    id: string;
    invite?: string;
    lib: string;
    longdesc: string;
    monthlyPoints: string;
    owners: string;
    points: string;
    prefix: string;
    shortdesc: string;
    support?: string;
    tags: string;
    username: string;
    vanity?: string;
    website?: string;
}

A search string in the format of "field: value field2: value2"

Type declaration

  • Optional avatar?: string

    The avatar hash of the bot's avatar

  • Optional bannerUrl?: string

    The URL for the banner image

  • certifiedBot: string

    The certified status of the bot

  • date: string

    The date when the bot was approved (in ISO 8601)

  • defAvatar: string

    The cdn hash of the bot's avatar if the bot has none

  • discriminator: string

    The discriminator of the bot

  • donatebotguildid: string

    The guild id for the donatebot setup

  • Optional github?: string

    The link to the github repo of the bot

  • guilds: string

    The guilds featured on the bot page

  • id: string

    The id of the bot

  • Optional invite?: string

    The custom bot invite url of the bot

  • lib: string

    The library of the bot

    Deprecated

  • longdesc: string

    The long description of the bot. Can contain HTML and/or Markdown

  • monthlyPoints: string

    The amount of upvotes the bot has this month

  • owners: string

    The owners of the bot. First one in the array is the main owner

  • points: string

    The amount of upvotes the bot has

  • prefix: string

    The prefix of the bot

  • shortdesc: string

    The short description of the bot

  • Optional support?: string

    The support server invite code of the bot

  • tags: string

    The tags of the bot

  • username: string

    The username of the bot

  • Optional vanity?: string

    The vanity url of the bot

  • Optional website?: string

    The website url of the bot

Optional sort

sort?: string

The field to sort by. Prefix with "-"" to reverse the order

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc