API
If for some reason in the universe, you want to access the data on this site, you can!
Overview
Overview of how the API works
All api routes follow the following path: https://nemtudo.me/api/{route}
Docs help
Field | Description |
---|---|
required | Fields like this will always be sent in responses. |
optional? | Fields like this may or may not be sent in responses. |
All requests returned the following json format:
Field | Type | Description |
---|---|---|
status | number | request status code |
message | string | request message |
data | json | the response content. The fields are documented in the api routes below |
errors | array | if there are one or more errors, it will return an array with Error Object |
Error Object:
If an error occurs, the error will have these fields
Field | Type | Description |
---|---|---|
code | number | error code |
message | string | error message |
Description Object:
Very used in various API paths
Field | Type | Description |
---|---|---|
title | string | description title |
content | string | description content |
Website
Routes related to website
Checks if the site is working normally
Get a message and current site status
GET/status
Field | Type | Description |
---|---|---|
status | number | website status code |
message | string | website status message |
Embed Generator
Routes related to the embed generator in links (https://nemtudo.me/embeds)
Create an embed
Create an embed so that a link can be generated.
POST/tools/embeds
You must send a request with the following fields in its body
Field | Type | Description |
---|---|---|
title? | string | embed title |
author? | string | embed author |
description? | string | embed description |
image? | string | embed image url |
thumbImage? | boolean | appear as thumbnail in embed |
color? | string | embed color hex |
video? | string | embed video url |
Will an objects with the following fields
Field | Type | Description |
---|---|---|
id | string | embed ID |
removed | boolean | embed removed for breaking terms of service |
content | object | object Embed Content Object |
Get an embed
Get the data of an embed.
GET/tools/embeds?id={embed.id}
Will an objects with the following fields
Field | Type | Description |
---|---|---|
id | string | embed ID |
removed | boolean | embed removed for breaking terms of service |
content | object | object Embed Content Object |
Embed Content Object:
Field | Type | Description |
---|---|---|
title? | string | embed title |
author? | string | embed author |
description? | string | embed description |
image? | string | embed image url |
thumbImage? | boolean | appear as thumbnail in embed |
color? | string | embed color hex |
video? | string | embed video url |
Projects
Routes related to projects
Get all projects
Get the list of all my projects, with some basic data.
GET/projects
Will return an array with objects with the following fields
Field | Type | Description |
---|---|---|
id | string | project id |
name | string | project name |
icon | string | project icon url |
description | string | short project description |
Get one project
Get the complete data of a project
GET/projects?id={project.id}
Field | Type | Description |
---|---|---|
id | string | project id |
name | string | project name |
icon | string | project icon url |
description | string | short project description |
backgroundColor | string | project background color |
descriptions | array | array with Description Object |
buttons | array | array with Button Object |
images | array | array with Image Object |
videoViews? | number | if you have a video showing the project, it will be a number telling you how many views it has |
Button Object:
Field | Type | Description |
---|---|---|
href | string | link that will open when clicking the button |
style | string | button importance |
text | string | text that will be written on the button |
Image Object:
Field | Type | Description |
---|---|---|
url | string | image url |
description | string | image description |
Staff Guilds
Routes related to the servers I am on staff
Get all guilds
Get the list of all guilds I am on staff, with some basic data.
GET/staffguilds
Will return an array with objects with the following fields
Field | Type | Description |
---|---|---|
id | string | guild id |
name | string | guild name |
icon | string | guild icon url |
gificon? | string | guild gif icon url |
banner | string | guild banner url |
role | string | my guild role |
members | string | approximate number of members. (Exact value cannot be obtained by API, because of Discord Rate Limit) |
Get one guild
Get the complete data of a guild
GET/staffguilds?id={guild.id}
Field | Type | Description |
---|---|---|
id | string | guild id |
name | string | guild name |
icon | string | guild icon url |
gificon? | string | guild gif icon url |
banner | string | guild banner url |
role | string | my guild role |
members | string | approximate number of members. (Exact value cannot be obtained by API, because of Discord Rate Limit) |
invite | string | guild invite url |
descriptions | array | array with Description Object |