Only this pageAll pages
Powered by GitBook
1 of 9

vCodes

Loading...

RESOURCES

Loading...

Loading...

Loading...

Loading...

Loading...

LIBRARIES

Loading...

Vote

Get Voters

GET /bot/:id/voters

Path Parameters

Name
Type
Description

Query Parameters

Name
Type
Description

Get Specific Vote

GET /bot/:id/voters/:userId

Path Parameters

Name
Type
Description

String

It specifies which bot data you will withdraw.

page

String

limit

String

How many data will appear on each page.

id

String

It specifies which bot data you will withdraw.

userId

String

{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}

Bot

Get Bot

GET /bot/:id

Path Parameters

Name
Type
Description

API Reference

Base URL

https://api.vcodes.xyz/

API Versioning

vCodes exposes different versions of our API. You should specify which version to use by including it in the request path like https://api.vcodes.xyz/v{version_number}.

VERSION
STATUS
DEFAULT

Version number is required.

Authentication

Authentication is performed with the Authorization HTTP header in the format Authorization: Bot TOKEN. Using a bot token gained by .

Example Bot Token Authorization Header

id

String

It specifies which bot data you will withdraw.

{
   error: "You entered invalid bot token."
}
{
    success: 'Certificate successfully applied.'
}
{
    // Response
}

0

Discontinued

1

Available

✓

submit a bot
Authorization: Bot eyJhbGciOiJIUzI1NiJ9....

Bots

Get bots

GET /bots

Query Parameters

Name
Type
Description

Example Response

ids

String

Just the id of the bots you want to see. Ex: 123,456

limit

Number

The amount of the bots return. Max: 100, Default: 12

page

Number

To navigate between pages divided by limit.

q

To search among bots

sort

String

Specific data you will use to sort bots

{
    // Response
}
{
    // Response
}
// https://api.vcodes.xyz/v1/bots

{
    "success": true,
    "message": "Successfully fetched bots",
    "data": {
        "queries": {
            "page": 1,
            "limit": 10,
            "sort": "createdAt",
            "q": "",
            "certified": "false",
            "tags": "all",
            "ids": 0,
            "maxPage": 1,
            "isSafety": false
        },
        "data": Array[1][
            {
                "provider": "discord",
                "id": "779641401482805289",
                "profile": {
                    "avatar": "3f609d39758d9e04b50efce8b0938429",
                    "avatarURL": "https://cdn.discordapp.com/avatars/779641401482805289/3f609d39758d9e04b50efce8b0938429.png",
                    "username": "Allegro",
                    "discriminator": "2830",
                    "tag": "Allegro#2830",
                    "banner": "https://i.ibb.co/rkDjcHX/infm32feghu9wxlc77tdg.png"
                },
                "prefix": "/",
                "information": {
                    "description": "<iframe style=\"height: 700px; width: 100%\" src=\"https://allegrobot.me/\"></iframe>\n",
                    "overview": "Cheer up your own server with 🎶",
                    "creator": {
                        "isTeam": false,
                        "id": "714451348212678658"
                    },
                    "tags": Array[2][
                        "Music",
                        "Web Dashboard"
                    ]
                },
                "statistics": {
                    "servers": 162,
                    "dailyVotes": 0,
                    "weeklyVotes": 0,
                    "monthlyVotes": 0,
                    "totalVotes": 9
                },
                "state": 1,
                "certificate": 1,
                "inviteURL": "https://discord.com/oauth2/authorize?client_id=779641401482805289&permissions=2263926592&scope=bot%20applications.commands",
                "ratings": {
                    "average": null,
                    "total": 0
                },
                "vanity": null,
                "theme": {
                    "enabled": true,
                    "automatic": false,
                    "color": "#000dff",
                    "colorLighter": "#6673ff"
                },
                "status": 0,
                "createdAt": "2022-12-13T21:31:25.028Z",
                "updatedAt": "2022-12-14T19:50:13.970Z"
            }
        ]
    },
    "passingTime": "36ms"
}

Commands

Get Commands

GET /bot/:id/commands

Path Parameters

Name
Type
Description

Add Command

POST /bot/:id/commands

Path Parameters

Name
Type
Description

Headers

Name
Type
Description

Request Body

Name
Type
Description

Edit Command

POST /bot/:id/commands

Path Parameters

Name
Type
Description

Headers

Name
Type
Description

Request Body

Name
Type
Description

Delete Command

DELETE /bot/:id/commands/:commandId

Path Parameters

Name
Type
Description

Headers

Name
Type
Description

Javascript

Official vCodes.xyz Javascript API Wrapper

Edit on Github this Package

vcodes.js

Installation

This is a module available through the . Installation is done using the :

Usage

Functions

Usage
Params
@returns

Events

Name

syntax*

String

Usage of command

id*

string

It specifies which bot data you will withdraw.

id

String

It specifies which bot data you will withdraw.

Authorization*

String

name*

String

Name of command

description*

String

Description of command

syntax*

String

Usage of command

category

String

Category of command

id

String

It specifies which bot data you will withdraw.

Authorization*

String

id*

String

ID of command

category

String

Category of command

name*

String

Name of command

description*

String

Description of command

id

String

It specifies which bot data you will withdraw.

commandId

String

Authorization*

String

{
  voted: true/false
}
{
 "error": "You entered an invalid bot token."
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}

No params needed

Promise<>

client.addAnnouncement({})

title, description

Promise<>

client.deleteAnnouncement(id)

id

Promise<>

client.addCommand({})

name, description, syntax, category?

Promise<>

client.getCommands(id)

id

Promise<>

client.editCommand({})

id, name, description, syntax, category?

Promise<>

client.deleteCommand(id)

No params needed

Promise<>

client.setUses({})

id, uses

Promise<>

client.getVoters()

No params needed

Promise<>

client.checkVote(userId)

userId

Promise<>

ready

reconnected

reconnecting

reminder

vote

Node.js
npm registry
npm install command

client.getAnnouncements()

$ npm install vcodes.js
const { Client } = require("vcodes.js");
const client = new Client("Your-Token");
NPM Version
NPM Downloads

Announcements

Get Announcements

GET /bot/:id/announcements

Path Parameters

Name
Type
Description

Add Announcement

POST /bot/:id/announcements

Path Parameters

Name
Type
Description

Headers

Name
Type
Description

Delete Announcement

DELETE /bot/:id/announcements/:announcementId

Path Parameters

Name
Type
Description

id

String

It specifies which bot data you will withdraw.

id

String

It specifies which bot data you will withdraw.

Authorization*

String

id

String

It specifies which bot data you will withdraw.

announcementId

String

{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}