Endpoints

All the official API endpoints for the dsc.gg API

All endpoints require your dsc.gg API token in the Authorization header

You can get an API token at https://dsc.gg/developers/dashboard

Response Codes Cheatsheet

These are all the possible response codes and what they mean

Code

Status

What this code means

payload_received

200

The content was successfully returned

rate_limit

429

You have hit a rate limit

invalid_key

401

The API key you provided is invalid or missing

not_found

404

The content was not found or returned blank

owner_blacklisted

403

The owner is blacklisted so nothing is returned

version_deprecated

410

The version of the API is no longer available

bad_request

400

Something in the request is not valid

link_taken

400

The link is not available, it is taken

link_created

201

Link was created successfully

owner_mismatch

403

You are not the owner so you can't do it

link_updated

200

The link was updated successfully

link_deleted

200

The link was deleted successfully

whitelist_only

403

The action is for whitelisted apps only

GET https://api.dsc.gg/v2/link/:slug

This endpoint allows you to get the publicly viewable information regarding the link Rate limit: 100 requests per 10 seconds Whitelist-only: no

Path Parameters

NameTypeDescription

slug

string

Slug of the link (dsc.gg/example would be "example")

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

{
    "success": true,
    "code": "payload_received",
    "payload": {
        "id": "the link id",
        "owner": "the link Discord owner id",
        "redirect": "the link redirect",
        "domain": "the link domain",
        "type": "server, bot, or template",
        "created_at": timestamp the link was created,
        "bumped_at": timestamp the link was bumped,
        "unlisted": true or false,
        "disabled": true or false,
        "meta": {
            "title": "the meta title",
            "saying": "the meta saying",
            "description": "the meta description",
            "color": "the meta color",
            "image": "the meta image"
        }
    }
}

POST https://api.dsc.gg/v2/link/:slug

This endpoint allows you to create a link under the owner of the developer application Rate limit: 3 requests per 60 seconds Whitelist-only: no

Path Parameters

NameTypeDescription

slug

string

Slug of the link (dsc.gg/example would be "example")

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

Request Body

NameTypeDescription

meta.image

string

link to the image for the

meta.description

string

description for the embed

meta.title

string

title for the embed

unlisted

boolean

defaults to False. set to True to make the link unsearchable, and have it not show up on the top links page

password

string

the password to add to the link. (don't specify for no password)

type

string

Either 'server', 'bot', or 'template'

redirect

string

the link to redirect to (must conform to type)

{
    "success": true,
    "code": "link_created",
    "message": "Link has been created successfully"
}

PATCH https://api.dsc.gg/v2/link/:slug

This endpoint allows you to update a link under the owner of the developer application Rate limit: 8 requests per 10 seconds Whitelist-only: no

Path Parameters

NameTypeDescription

slug

string

Slug of the link (dsc.gg/example would be "example")

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

Request Body

NameTypeDescription

type

string

Either 'server', 'bot' or 'template'

meta.color

string

color for the embed (in hex)

meta.image

string

link to the image for the embed (premium only)

meta.description

string

description for the embed

meta.title

string

title for the embed

unlisted

boolean

defaults to False. set to True to make the link unsearchable, and have it not show up on the top links page

password

string

the password to add to the link. (don't specify for no password)

redirect

string

the link to redirect to (must conform to type)

{
    "success": true,
    "code": "link_updated",
    "message": "Link has been updated successfully"
}

DELETE https://api.dsc.gg/v2/link/:slug

This endpoint allows you to delete a link belonging to the owner of the application Rate limit: 4 requests per 10 seconds Whitelist-only: no

Path Parameters

NameTypeDescription

slug

string

Slug of the link (dsc.gg/example would be "example")

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

{
    "success": true,
    "code": "link_deleted",
    "message": "This link has been deleted successfully"
}

Get User

GET https://api.dsc.gg/v2/user/:id

This endpoint allows you to get information on a specified user Rate limit: 50 requests per 10 seconds Whitelist-only: no

Path Parameters

NameTypeDescription

id

string

The Discord user id of the user.

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

{
    "success": true,
    "code": "payload_received",
    "payload": {
        "id": "users ID",
        "verified": true or false,
        "premium": true or false,
        "joined_at": timestamp that the user registered,
        "blacklisted": true or false
    }
}

GET https://api.dsc.gg/v2/user/:id/links

This endpoint allows you to get an array of a users links Rate limit: 50 requests per 10 seconds Whitelist-only: yes

Path Parameters

NameTypeDescription

id

string

The Discord user id of the user.

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

{
    "success": true,
    "code": "payload_received",
    "payload": [
        An array of links will be here
        ]
}

Get Users Apps

GET https://api.dsc.gg/v2/user/:id/apps

This endpoint allows you to get a users apps from dsc.gg/developer Rate limit: 50 requests per 10 seconds Whitelist-only: yes

Path Parameters

NameTypeDescription

id

string

The Discord user id of the user.

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

{
    "success": true,
    "code": "payload_received",
    "payload": [
        An array of apps will be here
        ]
}

Get a Developer App

GET https://api.dsc.gg/v2/app/:id

This endpoint allows you to get information on an app. The app API key will only be returned if you own the application. Otherwise only public information will be returned. Rate limit: 20 requests per 10 seconds Whitelist-only: no

Path Parameters

NameTypeDescription

id

string

The app id to fetch.

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

{
    "success": true,
    "code": "payload_received",
    "payload": {
        "id": "the app id",
        "owner": "the app owner Discord id",
        "created_at": timestamp it was created,
        "verified": true or false (aka. whitelisted),
        "key": "app key - will only return if you own the app"
    }
}

GET https://api.dsc.gg/v2/top

This endpoint allows you to search for specific links based on a query Rate limit: 20 requests per 10 seconds Whitelist-only: no

Path Parameters

NameTypeDescription

type

string

If you want to limit them to only a specific type. Can be bot, server, or template

{
    "success": true,
    "code": "payload_received",
    "payload": [
        an array with all top links will be here
    ]
}

GET https://api.dsc.gg/v2/search

This endpoint allows you to search for specific links based on a query Rate limit: 90 requests per 10 seconds Whitelist-only: yes

Path Parameters

NameTypeDescription

limit

string

If you want to limit the # of results. i.e: ?limit=10 for max of 10 results

type

string

If you want to narrow results, include ?type=bot, ?type=server, or ?type=template

q

string

The query to search

Headers

NameTypeDescription

Authorization

string

API token associated with your account (obtained at dsc.gg/developer)

{
    "success": true,
    "code": "payload_received",
    "payload": [
        an array of all the returned link results
    ]
}

Last updated