Welcome to the documentation for Universe List's API!
Please note that certain endpoints may require an API key, you can obtain yours by navigating to your bots edit page.
Returns all information on a bot.
GET /api/bots/:id| Name | Type | Description | id | String | ID of the bot to get information of. |
|---|
| Name | Type | Description | id | String | The ID of the targeted bot. |
|---|
| username | String | The username of the targeted bot. |
| avatar | String | The avatar URL of the targeted bot. |
| prefix | String | The prefix of the targeted bot. |
| owner | String | The ID of the targeted bot's owner. |
| ownerTag | String | The tag of the targeted bot's owner. |
| tags | Array | An array of the targeted bot's tags. |
| views | Integer | The amount of views the targeted bot's page has gotten. |
| submittedOn | String | The date the targeted bot was submitted to Universe List. |
| approvedOn | String | The date the targeted bot was approved on Universe List. |
| shortDescription | String | The short description of the targeted bot on Universe List. |
| description | String | The description of the targeted bot on Universe List. |
| shards | String | The number of shards the targeted bot has. |
| servers | Integer | The number of servers the targeted bot has. |
| votes | Integer | The number of vots the targeted bot has on Universe List. |
| invite | String | The invite of the targeted bot. |
| website | String | The website of the targeted bot. |
| github | String | The github of the targeted bot. |
| support | String | The support server of the targeted bot. |
Posts your bot's server and shard count.
POST /api/bots/:id| Name | Type | Description | authorization | String | The API Key for the targeted bot. |
|---|
| Name | Type | Description | id | String | ID of the bot to post stats for. |
|---|
| Name | Type | Description | server_count | Integer | The server count for the targeted bot. |
|---|
| shard_count | Integer | The shard count for the targeted bot. |
| Name | Type | Description | message | String | Error or success message. |
|---|
Get all votes of a bot on Universe List.
GET /api/bots/:id/votes| Name | Type | Description | id | String | ID of the bot to get the votes of. |
|---|
| Name | Type | Description | user | String | The user ID who voted for the bot. |
|---|
| current | Integer | The date the user voted. |
| next | Integer | The time unitl they can vote again. |
Check if a user voted for your bot.
GET /api/bots/:id/voted/?user=userid| Name | Type | Description | id | String | The ID of the bot to check the vote on. |
|---|
| Name | Type | Description | user | String | The ID of the user to check. |
|---|
| Name | Type | Description | vote | Boolean | If the user voted or not. |
|---|
| current | Integer | The date the user voted. |
| next | Integer | The time unitl they can vote again. |
Returns all information on a server.
GET /api/servers/:id| Name | Type | Description | name | String | The name of the targeted server. |
|---|
| id | String | The ID of the targeted server. |
| members | Integer | The member count of the targeted server. |
| icon | String | The icon URL of the targeted server. |
| invite | String | The invite URL of the targeted server. |
| submittedOn | String | The submitted date of the targeted server. |
| website | String | The website URL of the targeted server. |
| owner | String | The owner ID of the targeted server. |
| ownerTag | String | The owner tag of the targeted server. |
| tags | Array | All of the tags of the targeted server. |
| bump | Date | The latest bump date of the targeted server. |
| bumps | Integer | The number of bumps of the targeted server. |
| views | Integer | The number of views of the targeted server. |
| votes | Integer | The number of votes of the targeted server. |
| shortDesc | String | The short description of the targeted server. |
| description | String | The description of the targeted server. |
To learn how to interact with our API using JavaScript, check out our NPM package available here.