web-shapes

Mobile View (Beta)The Docs page is optimized for desktop. Display errors may occur on small screens.

API Reference

Base URL

All API requests are made to the following base URL:

http
https://api.vcodes.xyz/

API Versioning

vCodes exposes different versions of the API. Specify the version in the request path:

http
https://api.vcodes.xyz/v{version_number}

Version number is required for all requests.

The current supported API version is v1.

Authentication

Authentication is performed with the Authorization HTTP header using a Bot Token obtained when you submit a bot.

Format

http
Authorization: Bot YOUR_TOKEN

Example

http
Authorization: Bot eyJhbGciOiJIUzI1NiJ9.eyJpZCI6IjEyMzQ1NiIsImlhdCI6MTY0MH0.abc123

Bots

Endpoints for listing and querying all bots on the platform.

GET
https://api.vcodes.xyz/v1/bots

Returns a paginated list of bots with optional filtering and sorting.

Query Parameters

FieldTypeDescription
pageintegerPage number (default: 1)
limitintegerResults per page (default: 10, max: 50)
sortstringSort by: createdAt, votes, servers, alphabetical
qstringSearch query string
certifiedbooleanFilter certified bots only (true/false)
tagsstringFilter by tag, or 'all'

Responses

json
{
    "success": true,
    "message": "Successfully fetched bots",
    "data": {
        "queries": {
            "page": 1,
            "limit": 10,
            "sort": "createdAt",
            "q": "",
            "certified": "false",
            "tags": "all",
            "maxPage": 1
        },
        "data": [
            {
                "provider": "discord",
                "id": "779641401482805289",
                "profile": {
                    "avatar": "3f609d39758d9e04b50efce8b0938429",
                    "avatarURL": "https://cdn.discordapp.com/avatars/779641401482805289/3f609d39758d9e04b50efce8b0938429.png",
                    "username": "Allegro",
                    "discriminator": "2830",
                    "banner": "https://i.ibb.co/rkDjcHX/infm32feghu9wxlc77tdg.png"
                },
                "prefix": "/",
                "information": {
                    "overview": "Cheer up your own server with music",
                    "tags": ["Music", "Web Dashboard"]
                },
                "statistics": {
                    "servers": 162,
                    "monthlyVotes": 0,
                    "totalVotes": 9
                },
                "state": 1,
                "inviteURL": "https://discord.com/oauth2/authorize?client_id=...",
                "ratings": { "average": null, "total": 0 },
                "createdAt": "2022-12-13T21:31:25.028Z"
            }
        ]
    },
    "passingTime": "36ms"
}

Bot

Fetch a single bot by its Discord ID.

GET
https://api.vcodes.xyz/v1/bot/:id

Returns the full profile for a specific bot.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired

Responses

json
{
    "success": true,
    "data": {
        "id": "779641401482805289",
        "profile": {
            "username": "Allegro",
            "avatar": "3f609d39758d9e04b50efce8b0938429"
        },
        "prefix": "/",
        "information": {
            "description": "<p>Full HTML description</p>",
            "overview": "Cheer up your own server with music",
            "tags": ["Music", "Web Dashboard"]
        },
        "statistics": {
            "servers": 162,
            "monthlyVotes": 0,
            "totalVotes": 9
        }
    }
}

Vote

Endpoints for retrieving vote information.

GET
https://api.vcodes.xyz/v1/bot/:id/voters

Returns a list of users who have voted for this bot.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired

Query Parameters

FieldTypeDescription
pageintegerPage number (default: 1)
limitintegerResults per page (default: 10)

Responses

json
{ "success": true, "data": [ ... ] }
GET
https://api.vcodes.xyz/v1/bot/:id/voters/:userId

Check whether a specific user has voted for this bot.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired
userIdsnowflakeThe Discord ID of the userrequired

Responses

json
{ "voted": true }

Commands

Manage the command list displayed on a bot's profile page.

GET
https://api.vcodes.xyz/v1/bot/:id/commands

Returns all commands registered for a bot.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired

Responses

json
{ "success": true, "data": [ ... ] }
POST
https://api.vcodes.xyz/v1/bot/:id/commands

Add a new command to the bot or update an existing one.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired

Headers

FieldTypeDescription
AuthorizationstringBot TOKENrequired
Content-Typestringapplication/jsonrequired

Request Body

FieldTypeDescription
namestringCommand namerequired
descriptionstringCommand descriptionrequired
categorystringCategory label

Responses

json
{ "success": true }
DELETE
https://api.vcodes.xyz/v1/bot/:id/commands/:commandId

Delete a command from the bot's command list.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired
commandIdstringThe unique command identifierrequired

Headers

FieldTypeDescription
AuthorizationstringBot TOKENrequired

Responses

json
{ "success": true }

Announcements

Post and manage announcements shown on a bot's profile page.

GET
https://api.vcodes.xyz/v1/bot/:id/announcements

Returns all announcements for a bot, sorted by date.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired

Responses

json
{ "success": true, "data": [ ... ] }
POST
https://api.vcodes.xyz/v1/bot/:id/announcements

Publish a new announcement for the bot.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired

Headers

FieldTypeDescription
AuthorizationstringBot TOKENrequired
Content-Typestringapplication/jsonrequired

Request Body

FieldTypeDescription
titlestringAnnouncement titlerequired
contentstringAnnouncement contentrequired

Responses

json
{ "success": true }
DELETE
https://api.vcodes.xyz/v1/bot/:id/announcements/:announcementId

Delete a specific announcement.

Path Parameters

FieldTypeDescription
idsnowflakeThe Discord ID of the botrequired
announcementIdstringThe announcement identifierrequired

Headers

FieldTypeDescription
AuthorizationstringBot TOKENrequired

Responses

json
{ "success": true }

JavaScript Library

Official npm GitHub

The official Node.js API wrapper for the vCodes API. Simplify vote webhooks, bot statistics, and more.

Installation

Available via npm. Requires Node.js.

bash
npm install vcodes.js

Usage

javascript
const { Client } = require("vcodes.js");

const client = new Client("Your-Bot-Token");

// Listen for votes
client.on("vote", (data) => {
    console.log(`${data.userId} voted for ${data.botId}`);
});

Functions

FieldTypeDescription
getBot(id)Promise<Bot>Fetch a bot by Discord ID
getBots(options)Promise<Bot[]>Fetch paginated list of bots
getVoters(id)Promise<User[]>Get voters for a bot
hasVoted(id, userId)Promise<boolean>Check if a user has voted
postStats(id, servers)Promise<void>Update server count statistics

Events

FieldTypeDescription
voteVoteDataFired when a user votes for a bot — requires webhook setup
errorErrorFired when an API error or network error occurs

© 2019 - 2026 vCodes, All rights reserved.

Made with by CodeVis Community, and modified by NilsCraftHD