Omniplex Docs

Servers

These API endpoints are related to servers on Omniplex

Put server asset version

PUT
/servers/{id}/assets/{kind}

Records the content version of a server asset (avatar/banner) that was just uploaded to the CDN, so it is returned in the entity's asset_versions.

The file itself is uploaded through the frontend's upload gateway, not here. Returns a 204 on success.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The server's ID

kind*string

The asset kind: banner, or avatar for teams

Request Body

application/json
  1. body
version?string

Lowercase hex prefix (16 to 64 chars) of the uploaded file's SHA-256

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PUT 'https://spider.omniplex.gg/servers/string/assets/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get server page style

GET
/servers/{id}/page-style

The custom background, gradient and accent colour shown on the server's page. Only approved backgrounds are returned, and nothing is returned unless the server has premium. Returns null when the page isn't customised.

Path Parameters

id*string

The server's ID

Response Body

Success

application/json
  1. response
accent?string

The page's accent colour as #rrggbb, or null for the viewer's own accent

blur?integer

Background blur in pixels, 0 to 24

dim?integer

How much the background is darkened or lightened toward the page colour, 30 to 90 percent

fixed?boolean

Whether the background stays put while the page scrolls

gradient?string

A preset gradient ID, custom:#rrggbb:#rrggbb for a custom two-colour gradient, or null

image_position?string

top, center or bottom

image_version?string

The approved background image's version. The image is at {CDN}/backgrounds/{bots|servers}/{id}/{version}.webp

Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string/page-style'
Example Response
{  "accent": "string",  "blur": 0,  "dim": 0,  "fixed": true,  "gradient": "string",  "image_position": "string",  "image_version": "string"}

Update server page style

PATCH
/servers/{id}/page-style

Sets the gradient, accent colour and how the background image is shown, or removes the image with remove_image. Needs premium. The accent colour has to be readable on both light and dark mode.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The server's ID

Request Body

application/json
  1. body
accent?string
blur?integer
dim?integer
fixed?boolean
gradient?string
image_position?string
Value in"top""center""bottom"
remove_image?boolean

Remove the background image, including one waiting for review

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PATCH 'https://spider.omniplex.gg/servers/string/page-style' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}
GET
/servers/{id}/page-style/manage

The page style with everything an owner needs to edit it: a background waiting for review, why the last one was rejected, and whether the server has premium.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The server's ID

Response Body

Success

application/json
  1. response
accent?string

The page's accent colour as #rrggbb, or null for the viewer's own accent

blur?integer

Background blur in pixels, 0 to 24

dim?integer

How much the background is darkened or lightened toward the page colour, 30 to 90 percent

fixed?boolean

Whether the background stays put while the page scrolls

gradient?string

A preset gradient ID, custom:#rrggbb:#rrggbb for a custom two-colour gradient, or null

image_position?string

top, center or bottom

image_version?string

The approved background image's version. The image is at {CDN}/backgrounds/{bots|servers}/{id}/{version}.webp

pending_since?string

When the pending background was uploaded

Formatdate-time
pending_version?string

An uploaded background waiting for staff review

premium?boolean

Whether page styles are available: the listing has premium or an active Page Style pass. Page styles only show while they are

rejected_reason?string

Why staff rejected the last uploaded background

unlocked_until?string

When the listing's Page Style pass from the Credit shop runs out, if one is active

Formatdate-time
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string/page-style/manage'
Example Response
{  "accent": "string",  "blur": 0,  "dim": 0,  "fixed": true,  "gradient": "string",  "image_position": "string",  "image_version": "string",  "pending_since": "2019-08-24T14:15:22Z",  "pending_version": "string",  "premium": true,  "rejected_reason": "string",  "unlocked_until": "2019-08-24T14:15:22Z"}
PUT
/servers/{id}/page-style/image

Records a background image that was just uploaded through the website's upload gateway, which re-encodes it. It waits for staff review before it shows on the page. Needs premium.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The server's ID

Request Body

application/json
  1. body
version?string

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PUT 'https://spider.omniplex.gg/servers/string/page-style/image' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Set server card colour

PUT
/servers/{id}/card-color

Sets the colour that tints the server's card, or resets it with an empty colour. Needs the Card Theme from the shop. Returns 204 on success.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The server's ID

Request Body

application/json
  1. body
color?string

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PUT 'https://spider.omniplex.gg/servers/string/card-color' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Record server View

POST
/servers/{id}/views

Records that a visitor opened this server's page. Each visitor counts once per server per day. Known crawlers, and people who manage the server, aren't counted. Signing in is optional. Always returns 204.

Authorization

User
headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The server's ID

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X POST 'https://spider.omniplex.gg/servers/string/views'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}
POST
/servers/{id}/invite-clicks

Records that a visitor opened this server's invite. Each visitor counts once per server per day. Known crawlers, and people who manage the server, aren't counted. Signing in is optional. Always returns 204.

Authorization

User
headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The server's ID

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X POST 'https://spider.omniplex.gg/servers/string/invite-clicks'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get All Servers

GET
/servers/@all

Gets approved and certified, publicly listed servers, filtered and sorted. Returns a set of paginated IndexServer objects

Query Parameters

page?string

The page number

sort?string

Sort order: new (default; newest first, with boosted listings on top), trending (net votes in the last 7 days, only servers with at least one vote in that window), votes (most votes this cycle) members (highest member count) or bumped (most recently bumped with /bump first).

tag?string

Only servers with this tag (case-insensitive).

certified?string

true to only return certified servers.

Response Body

Success

application/json
  1. response
count?integer
Range0 <= value <= 18446744073709552000
per_page?integer
Range0 <= value <= 18446744073709552000
results?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/@all'
Example Response
{  "count": 0,  "per_page": 0,  "results": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ]}

Get Servers Emojis

GET
/servers/@emojis

Gets a paginated list of servers that have opted in to showing their emojis/stickers

Query Parameters

page?string

The page number

Response Body

Success

application/json
  1. response
count?integer
Range0 <= value <= 18446744073709552000
per_page?integer
Range0 <= value <= 18446744073709552000
results?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/@emojis'
Example Response
{  "count": 0,  "per_page": 0,  "results": [    {      "avatar": "string",      "emojis": [        {          "animated": true,          "id": "string",          "name": "string",          "url": "string"        }      ],      "name": "string",      "server_id": "string",      "stickers": [        {          "format": "string",          "id": "string",          "name": "string",          "url": "string"        }      ]    }  ]}

Get Flat Emojis

GET
/servers/@emojis/flat

Gets a paginated, flat list of emojis across every server that has opted in to showing them

Query Parameters

page?string

The page number

Response Body

Success

application/json
  1. response
count?integer
Range0 <= value <= 18446744073709552000
per_page?integer
Range0 <= value <= 18446744073709552000
results?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/@emojis/flat'
Example Response
{  "count": 0,  "per_page": 0,  "results": [    {      "animated": true,      "id": "string",      "name": "string",      "server_avatar": "string",      "server_id": "string",      "server_name": "string",      "url": "string"    }  ]}

Get Flat Stickers

GET
/servers/@stickers/flat

Gets a paginated, flat list of stickers across every server that has opted in to showing them

Query Parameters

page?string

The page number

Response Body

Success

application/json
  1. response
count?integer
Range0 <= value <= 18446744073709552000
per_page?integer
Range0 <= value <= 18446744073709552000
results?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/@stickers/flat'
Example Response
{  "count": 0,  "per_page": 0,  "results": [    {      "format": "string",      "id": "string",      "name": "string",      "server_avatar": "string",      "server_id": "string",      "server_name": "string",      "url": "string"    }  ]}

Post Server Stats

POST
/servers/stats

This endpoint posts the stats of a server. Posting at all marks the server as self-managing its stats, which stops the periodic Infernoplex sync from overwriting total_members/online_members for it.

Authorization

server
headerServer-Auth<token>

Requires a server API session token. Should be prefixed with Server in Authorization header.

Request Body

application/json
  1. body
online_members?integer

The server's online member count

Range0 <= value <= 18446744073709552000
total_members?integer

The server's total member count

Range0 <= value <= 18446744073709552000

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X POST 'https://spider.omniplex.gg/servers/stats' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get Random Servers

GET
/servers/@random

Returns a list of servers from the database in random order

Response Body

Success

application/json
  1. response
servers?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/@random'
Example Response
{  "servers": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ]}

Get Servers Index

GET
/servers/@index

Gets the index of the server-side of the list. Returns a ListIndexServer object

Response Body

Success

application/json
  1. response
certified?array<>

The certified servers (if any)

featured?array<>

Servers with an active featured_until from a shop purchase

most_viewed?array<>

The most viewed servers, usually limited to 12

premium?array<>

The premium servers, usually limited to 12

recently_added?array<>

The recently added servers, usually limited to 12

recently_bumped?array<>

Servers most recently bumped with /bump

spotlight?array<>

Servers with an active spotlighted_until, set by staff

top_voted?array<>

The top voted servers, usually limited to 12

Example Request
curl -X GET 'https://spider.omniplex.gg/servers/@index'
Example Response
{  "certified": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ],  "featured": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ],  "most_viewed": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ],  "premium": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ],  "recently_added": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ],  "recently_bumped": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ],  "spotlight": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ],  "top_voted": [    {      "approximate_votes": 0,      "asset_versions": {        "property1": "string",        "property2": "string"      },      "avatar": "string",      "boosted_until": "2019-08-24T14:15:22Z",      "card_color": "string",      "clicks": 0,      "featured_until": "2019-08-24T14:15:22Z",      "hidden_stats": [        "string"      ],      "highlighted": true,      "invite_clicks": 0,      "name": "string",      "nsfw": true,      "online_members": 0,      "premium": true,      "server_id": "string",      "short": "string",      "spotlighted_until": "2019-08-24T14:15:22Z",      "state": "string",      "supporter_badge": true,      "tags": [        "string"      ],      "total_members": 0,      "type": "string",      "vanity": "string",      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",      "views_30d": 0,      "votes": 0    }  ]}

Get Server Meta

GET
/servers/meta

Resolves a Discord invite link to a preview of the server it points to (name, icon, member counts, and whether it's already listed), without adding it to the database. Used by Add Server to show the server being added before the user submits.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Query Parameters

invite*string

The Discord invite link or code to resolve

Response Body

Success

application/json
  1. response
already_listed?boolean

Whether this server is already in the database

avatar?string

The server's icon URL, empty if the server has no icon set

bot_invite_url?string

A ready-to-use invite link for the tracking bot, shown when bot_present is false. Empty if Infernoplex couldn't be reached

bot_present?boolean

Whether the tracking bot (Infernoplex) is currently a member of this server. Several features (emoji/sticker sync, real invites, live member counts) don't work until it's invited

list_type?string

If already_listed, the server's current list type (e.g. pending/approved/certified/denied)

name?string

The server's name

online_members?integer

The server's approximate online member count

server_id?string

The server's ID, resolved from the invite

total_members?integer

The server's approximate total member count

Example Request
curl -X GET 'https://spider.omniplex.gg/servers/meta?invite=string'
Example Response
{  "already_listed": true,  "avatar": "string",  "bot_invite_url": "string",  "bot_present": true,  "list_type": "string",  "name": "string",  "online_members": 0,  "server_id": "string",  "total_members": 0}

Add Server

PUT
/servers

Adds a server to the database from an invite link. Resolves the guild via the invite (the tracking bot does not need to already be in the server). Returns 204 on success

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Request Body

application/json
  1. body
extra_links?array<>
invite?string
long?string
nsfw?boolean
short?string
tags?array<string>
team_owner?string

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PUT 'https://spider.omniplex.gg/servers' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get Server

GET
/servers/{id}

Gets a server by id

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The servers ID

Query Parameters

target?string

No longer used. Views and invite clicks are recorded with POST /servers/{id}/views and POST /servers/{id}/invite-clicks.

include?string

What extra fields to include, comma-seperated. long => server long description

team_includes?string

What entities of the servers team to include

Response Body

Success

application/json
  1. response
approval_note?string

The note for the bot's approval

approximate_votes?integer

The bot's approximate vote count, used for home page listing etc.

asset_versions?

Content versions of uploaded CDN assets by kind (avatar/banner). Append as ?v= to the asset URL. A missing kind means unknown, not absent

auto_votes?integer

How many of this month's upvotes came from Auto-vote

auto_votes_opt_out?boolean

Whether the bot refuses automatic votes from auto-vote subscribers

boosted_until?string

If set and in the future, the bot gets priority placement in listings until this time

Formatdate-time
bot_id?string

The bot's ID

captcha_opt_out?boolean

Whether the bot should have captchas shown if the user has captcha_sponsor_enabled

card_color?string

The bot's Card Theme colour as #rrggbb, empty when it has no Card Theme or no colour set

card_theme?boolean

Whether the bot has bought the Card Theme, which unlocks card_color

cert_reason?string

The reason for the bot being certified

claimed_by?string

The user who claimed the bot

clicks?integer

The bot's total click count

client_id?string

The bot's associated client ID validated using that top-secret Oauth2 API! Used in anti-abuse measures.

created_at?string

The bot's creation date

Formatdate-time
extra_links?array<>

The bot's links that it wishes to advertise

featured_until?string

If set and in the future, the bot appears in the home page's Featured section until this time

Formatdate-time
hidden_stats?array<>

Stats the owner chose to hide. Hidden stats are returned as zero unless you manage this listing

highlighted?boolean

Whether the bot has an active Highlighted Card from the shop

highlighted_until?string

If set and in the future, the bot's card has an accent glow until this time

Formatdate-time
invite?string

The bot's invite URL. Must be present

invite_clicks?integer

The bot's invite click count (via users inviting the bot from IBL)

itag?string

The bot's internal ID. An artifact of database migrations.

Formatuuid
last_claimed?string

The bot's last claimed date

Formatdate-time
last_japi_update?string

The last time the bot was updated via JAPI

Formatdate-time
last_stats_post?string

The list time the bot posted stats to the list. Null if never posted

Formatdate-time
library?string

The bot's library

long?string

The bot's long description in raw format (HTML/markdown etc. based on the bots settings). May not always be present (e.g. 'long' not in include)

moderation_categories?array<>

Which moderation categories were flagged (e.g. sexual, harassment), empty if not flagged or moderation wasn't run

moderation_flagged?boolean

Whether OpenAI's moderation endpoint flagged the bot's short/long description at submission time. A signal for reviewers, not a verdict

nsfw?boolean

Whether the bot is NSFW or not

owner?

The bot owner's user information. If in a team, this will be null and team_owner will instead be set

prefix?string

The bot's prefix

premium?boolean

Whether the bot is a premium bot or not

premium_period_length?integer

The period of premium for the bot in nanoseconds

Formatint64
servers?integer

The bot's server count

shard_list?array<>

The number of servers per shard

shards?integer

The bot's shard count

short?string

The bot's short description

spotlighted_until?string

If set and in the future, the bot appears in the home page's Spotlight section until this time

Formatdate-time
start_premium_period?string
Formatdate-time
supporter_badge?boolean

Whether the bot's owner has purchased the cosmetic supporter badge from the shop

tags?array<>

The bot's tags (e.g. music, moderation, etc.)

team_owner?

If the bot is in a team, who owns the bot. If not in a team, this will be null and owner will instead be set

total_uptime?integer

The bot's all-time number of uptime checks. Includes older checks that weren't reliable, so use uptime_percent to show uptime

type?string

The bot's type (e.g. pending/approved/certified/denied etc.). Note that we do not filter out denied/banned bots in API

unique_clicks?integer

The bot's unique click count based on SHA256 hashed IPs

Formatint64
updated_at?string

The bot's last update date

Formatdate-time
uptime?integer

The bot's all-time number of successful uptime checks. Includes older checks that weren't reliable, so use uptime_percent to show uptime

uptime_checks?integer

How many uptime checks ran in the last 30 days

uptime_last_checked?string

The bot's last uptime check

Formatdate-time
uptime_percent?number

The share of uptime checks in the last 30 days where the bot was online, from 0 to 100. Null when it hasn't been seen online in that time

Formatdouble
user?

The bot's user information

users?integer

The bot's user count

vanity?string

The bot's vanity URL

vanity_ref?string

The corresponding vanities itag, this also works to ensure that all bots have an associated vanity

Formatuuid
views_30d?integer

Views in the last 30 days, counting each visitor once per listing per day

vote_banned?boolean

Whether the bot is vote banned or not

vote_blitz_until?string

If set and in the future, the bot's vote cooldown is halved until this time

Formatdate-time
votes?integer

The bot's vote count

Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string'
Example Response
{  "approval_note": "string",  "approximate_votes": 0,  "asset_versions": {    "property1": "string",    "property2": "string"  },  "auto_votes": 0,  "auto_votes_opt_out": true,  "boosted_until": "2019-08-24T14:15:22Z",  "bot_id": "string",  "captcha_opt_out": true,  "card_color": "string",  "card_theme": true,  "cert_reason": "string",  "claimed_by": "string",  "clicks": 0,  "client_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "extra_links": [    {      "name": "string",      "value": "string"    }  ],  "featured_until": "2019-08-24T14:15:22Z",  "hidden_stats": [    "string"  ],  "highlighted": true,  "highlighted_until": "2019-08-24T14:15:22Z",  "invite": "string",  "invite_clicks": 0,  "itag": "6b5f8e7b-1e8c-4611-b693-ee8faa950c62",  "last_claimed": "2019-08-24T14:15:22Z",  "last_japi_update": "2019-08-24T14:15:22Z",  "last_stats_post": "2019-08-24T14:15:22Z",  "library": "string",  "long": "string",  "moderation_categories": [    "string"  ],  "moderation_flagged": true,  "nsfw": true,  "owner": {    "avatar": "string",    "bot": true,    "display_name": "string",    "extra_data": {      "property1": null,      "property2": null    },    "flags": [      "string"    ],    "id": "string",    "status": "string",    "username": "string"  },  "prefix": "string",  "premium": true,  "premium_period_length": 0,  "servers": 0,  "shard_list": [    0  ],  "shards": 0,  "short": "string",  "spotlighted_until": "2019-08-24T14:15:22Z",  "start_premium_period": "2019-08-24T14:15:22Z",  "supporter_badge": true,  "tags": [    "string"  ],  "team_owner": {    "approximate_votes": 0,    "asset_versions": {      "property1": "string",      "property2": "string"    },    "created_at": "2019-08-24T14:15:22Z",    "entities": {      "bots": [        {          "approximate_votes": 0,          "asset_versions": {            "property1": "string",            "property2": "string"          },          "boosted_until": "2019-08-24T14:15:22Z",          "bot_id": "string",          "card_color": "string",          "clicks": 0,          "created_at": "2019-08-24T14:15:22Z",          "featured_until": "2019-08-24T14:15:22Z",          "hidden_stats": [            "string"          ],          "highlighted": true,          "invite_clicks": 0,          "library": "string",          "nsfw": true,          "premium": true,          "servers": 0,          "shards": 0,          "short": "string",          "spotlighted_until": "2019-08-24T14:15:22Z",          "supporter_badge": true,          "tags": [            "string"          ],          "type": "string",          "user": {            "avatar": "string",            "bot": true,            "display_name": "string",            "extra_data": {              "property1": null,              "property2": null            },            "flags": [              "string"            ],            "id": "string",            "status": "string",            "username": "string"          },          "vanity": "string",          "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",          "views_30d": 0,          "vote_blitz_until": "2019-08-24T14:15:22Z",          "votes": 0        }      ],      "members": [        {          "created_at": "2019-08-24T14:15:22Z",          "data_holder": true,          "flags": [            "string"          ],          "itag": "6b5f8e7b-1e8c-4611-b693-ee8faa950c62",          "mentionable": true,          "service": "string",          "team_id": "string",          "user": {            "avatar": "string",            "bot": true,            "display_name": "string",            "extra_data": {              "property1": null,              "property2": null            },            "flags": [              "string"            ],            "id": "string",            "status": "string",            "username": "string"          }        }      ],      "servers": [        {          "approximate_votes": 0,          "asset_versions": {            "property1": "string",            "property2": "string"          },          "avatar": "string",          "boosted_until": "2019-08-24T14:15:22Z",          "card_color": "string",          "clicks": 0,          "featured_until": "2019-08-24T14:15:22Z",          "hidden_stats": [            "string"          ],          "highlighted": true,          "invite_clicks": 0,          "name": "string",          "nsfw": true,          "online_members": 0,          "premium": true,          "server_id": "string",          "short": "string",          "spotlighted_until": "2019-08-24T14:15:22Z",          "state": "string",          "supporter_badge": true,          "tags": [            "string"          ],          "total_members": 0,          "type": "string",          "vanity": "string",          "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",          "views_30d": 0,          "votes": 0        }      ],      "targets": [        "string"      ]    },    "extra_links": [      {        "name": "string",        "value": "string"      }    ],    "id": "string",    "name": "string",    "nsfw": true,    "service": "string",    "short": "string",    "tags": [      "string"    ],    "updated_at": "2019-08-24T14:15:22Z",    "vanity": "string",    "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",    "vote_banned": true,    "votes": 0  },  "total_uptime": 0,  "type": "string",  "unique_clicks": 0,  "updated_at": "2019-08-24T14:15:22Z",  "uptime": 0,  "uptime_checks": 0,  "uptime_last_checked": "2019-08-24T14:15:22Z",  "uptime_percent": 0.1,  "user": {    "avatar": "string",    "bot": true,    "display_name": "string",    "extra_data": {      "property1": null,      "property2": null    },    "flags": [      "string"    ],    "id": "string",    "status": "string",    "username": "string"  },  "users": 0,  "vanity": "string",  "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",  "views_30d": 0,  "vote_banned": true,  "vote_blitz_until": "2019-08-24T14:15:22Z",  "votes": 0}

Delete Server

DELETE
/servers/{id}

Deletes a server from the list. This is irreversible. You must have 'Delete Servers' in the server's team. Returns 204 on success.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

Server ID

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X DELETE 'https://spider.omniplex.gg/servers/string'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get Server Bumps

GET
/servers/{id}/bumps

Returns when a server was last bumped with /bump, when it can next be bumped, how many bumps it got in the last 30 days and its top bumpers.

Path Parameters

id*string

The server's ID

Response Body

Success

application/json
  1. response
bumped_at?string

When the server was last bumped, null if never

Formatdate-time
bumps_30d?integer

How many times the server was bumped in the last 30 days

next_bump_at?string

When the server can next be bumped, null if it can be bumped now

Formatdate-time
top_bumpers?array<>

The members who bumped the server most in the last 30 days

Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string/bumps'
Example Response
{  "bumped_at": "2019-08-24T14:15:22Z",  "bumps_30d": 0,  "next_bump_at": "2019-08-24T14:15:22Z",  "top_bumpers": [    {      "bumps": 0,      "user": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      }    }  ]}

Get Server Analytics

GET
/servers/{id}/analytics

Returns the server's daily votes, views, invite clicks and counts over time. You must have 'Edit Servers' in the server's team.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

The server's ID

Query Parameters

days?string

How many days to return, ending today (UTC). Between 7 and 365, defaults to 30.

Response Body

Success

application/json
  1. response
days?array<>

One entry per day, oldest first, ending today (UTC)

tracked_since?string

The first day views, invite clicks and counts were recorded, null if not yet. Votes are available for the whole range.

Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string/analytics'
Example Response
{  "days": [    {      "auto_votes": 0,      "day": "string",      "invite_clicks": 0,      "online_members": 0,      "servers": 0,      "total_members": 0,      "users": 0,      "views": 0,      "votes": 0    }  ],  "tracked_since": "string"}
GET
/servers/@changelogs

A sitewide feed of updates from approved and certified servers, newest first.

Query Parameters

page?string

The page number

q?string

Search the title, content and server name (up to 100 characters)

tag?string

Only servers with this tag (case-insensitive)

server?string

Only this server's updates (server ID)

Response Body

Success

application/json
  1. response
count?integer
Range0 <= value <= 18446744073709552000
per_page?integer
Range0 <= value <= 18446744073709552000
results?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/@changelogs'
Example Response
{  "count": 0,  "per_page": 0,  "results": [    {      "avatar": "string",      "content": "string",      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "name": "string",      "server_id": "string",      "title": "string",      "version": "string"    }  ]}

Get Server Changelogs

GET
/servers/{id}/changelogs

Gets the updates a server's owners have posted, newest first.

Authorization

User
headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

Server ID

Response Body

Success

application/json
  1. response
changelogs?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string/changelogs'
Example Response
{  "changelogs": [    {      "content": "string",      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "id": "string",      "title": "string",      "version": "string"    }  ]}

Create Server Changelog

POST
/servers/{id}/changelogs

Posts an update for a server, shown on its page and in the Feed. Needs 'Edit Server Settings' in the server's team.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

Server ID

Request Body

application/json
  1. body
content?string
title?string
version?string

Response Body

Success

application/json
  1. response
content?string
created_at?string
Formatdate-time
created_by?string
id?string
title?string
version?string
Example Request
curl -X POST 'https://spider.omniplex.gg/servers/string/changelogs' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "content": "string",  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "id": "string",  "title": "string",  "version": "string"}

Delete Server Changelog

DELETE
/servers/{id}/changelogs/{changelog_id}

Removes a server update. Needs 'Edit Server Settings' in the server's team.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

Server ID

changelog_id*string

Changelog entry ID

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X DELETE 'https://spider.omniplex.gg/servers/string/changelogs/string'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get Server Vote Messages

GET
/servers/{id}/vote-channel

Gets the channel the Infernoplex bot posts new votes in, and the server's channels to choose from. Needs 'Edit Server Settings'.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

Server ID

Response Body

Success

application/json
  1. response
available?boolean

Whether the Infernoplex bot can see the server. When false, channels is empty

channel_id?string

The channel vote messages are posted in, or null if they're off

channels?array<>

The server's text and announcement channels

Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string/vote-channel'
Example Response
{  "available": true,  "channel_id": "string",  "channels": [    {      "id": "string",      "name": "string"    }  ]}

Set Server Vote Messages

PUT
/servers/{id}/vote-channel

Sets the channel the Infernoplex bot posts new votes in, or turns vote messages off with a null channel_id. The bot posts a test message first and the change is only saved if that works. Needs 'Edit Server Settings'.

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

Server ID

Request Body

application/json
  1. body
channel_id?string

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PUT 'https://spider.omniplex.gg/servers/string/vote-channel' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}

Get Server SEO Info

GET
/servers/{id}/seo

Gets the minimal SEO information about a server for embed/search purposes. Used by v4 website for meta tags

Path Parameters

id*string

The server ID

Response Body

Success

application/json
  1. response
avatar?string

The entities resolved avatar URL (not just hash)

id?string

ID of the entity

name?string

Name of the entity

short?string

Short description of the entity

vanity?string

The entity's vanity code, used to build its canonical URL. Omitted when it has none

Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string/seo'
Example Response
{  "avatar": "string",  "id": "string",  "name": "string",  "short": "string",  "vanity": "string"}

Get Similar Servers

GET
/servers/{id}/similar

Returns up to 6 other approved/certified, publicly listed servers sharing at least one tag with this server (case-insensitive), ranked by shared tags with rarer tags weighted higher, then votes. NSFW servers are only included when this server is NSFW.

Path Parameters

id*string

Server ID

Response Body

Success

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://spider.omniplex.gg/servers/string/similar'
Example Response
[  {    "approximate_votes": 0,    "asset_versions": {      "property1": "string",      "property2": "string"    },    "avatar": "string",    "boosted_until": "2019-08-24T14:15:22Z",    "card_color": "string",    "clicks": 0,    "featured_until": "2019-08-24T14:15:22Z",    "hidden_stats": [      "string"    ],    "highlighted": true,    "invite_clicks": 0,    "name": "string",    "nsfw": true,    "online_members": 0,    "premium": true,    "server_id": "string",    "short": "string",    "spotlighted_until": "2019-08-24T14:15:22Z",    "state": "string",    "supporter_badge": true,    "tags": [      "string"    ],    "total_members": 0,    "type": "string",    "vanity": "string",    "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",    "views_30d": 0,    "votes": 0  }]

Update Server Settings

PATCH
/servers/{id}/settings

Updates a servers settings. You must have 'Edit Server Settings' in the team if the bot is in a team. Returns 204 on success

Authorization

headerUser-Auth<token>

Requires a user token. Should be prefixed with User in Authorization header.

Path Parameters

id*string

Server ID

Request Body

application/json
  1. body
auto_votes_opt_out?boolean
captcha_opt_out?boolean
card_color?string
extra_links?array<>
hidden_stats?array<>

Stats to hide from public view: members, boosts, views and invites. Leave it out to keep the current choice

login_required_for_invite?boolean

Whether the server requires a login to be invited to it

long?string
nsfw?boolean
short?string
show_emojis?boolean

Whether to show this server's emojis and stickers on its listing page. Requires the tracking bot to be in the server to actually have anything to show

state?string
Value in"public""private""unlisted""defunct"
tags?array<string>

Response Body

Success

application/json
  1. response
context?

Context of the error. Usually used for validation error contexts

message?string

Message of the error

Example Request
curl -X PATCH 'https://spider.omniplex.gg/servers/string/settings' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "context": {    "property1": "string",    "property2": "string"  },  "message": "string"}