mesalytic / discord-lookup-api Goto Github PK

View Code? Open in Web Editor NEW

52.0 2.0 21.0 25 KB

An API that lets you fetch user info (banner, username, avatar)

Home Page: https://discordlookup.mesavirep.xyz/

JavaScript 100.00%

api avatar discord lookup user

discord-lookup-api's Introduction

discord-lookup-api

Discord Lookup API is an API that lets you, with a given ID, get basic informations about a user

The API returns :

User ID
User Tag (username#0000)
User Badges
Avatar (ID, Link, animated boolean)
Banner (ID, Link, animated boolean, color)

The API has built-in CORS support, so you won't have to worry

Data is cached for 3 hours (or until the Redis Server restarts)

Planned features

Experiment Lookup
Invite Resolver

Usage

You can freely access the API here

Or you can deploy your own instance of the API through Vercel:

Note This version does not have caching due to Vercel limitations. You must also have a Discord Bot Token to use the API. You can get one here

Right now, you must specify an ID to the link (a proper website is currently in development)

Example

https://discordlookup.mesavirep.xyz/v1/user/604779545018761237

{
    "id": "604779545018761237",
    "tag": "mesa#0101",
    "badges": [
        "HOUSE_BRAVERY",
        "EARLY_VERIFIED_BOT_DEVELOPER",
        "ACTIVE_DEVELOPER"
    ],
    "avatar": {
        "id": "02a161dcd6d590fbce550d6872468cc7",
        "link": "https://cdn.discordapp.com/avatars/604779545018761237/02a161dcd6d590fbce550d6872468cc7",
        "is_animated": false
    },
    "banner": {
        "id": "a_b987e17d75cc964905b04a575636c60e",
        "link": "https://cdn.discordapp.com/banners/604779545018761237/a_b987e17d75cc964905b04a575636c60e",
        "is_animated": true,
        "color": "#385d6d"
    }
}

https://discordlookup.mesavirep.xyz/v1/application/437190817195753472

{
   "id":"437190817195753472",
   "name":"Helixus",
   "icon":"https://cdn.discordapp.com/avatars/437190817195753472/9d7e869d626efd6d0e61ac9e552e6fb6",
   "description":"Helixus aims to do what would normally need multiple bots, and does it all by itself !\nYou can play Music (from some sources), log what happens in your server, send some memes, and much more!\n\nInvite it now to see the full capacity of Helixus!\n**SUPPORT**: https://discord.gg/pBATVfHg",
   "summary":"",
   "type":null,
   "hook":true,
   "guild_id":"418433461817180180",
   "bot_public":true,
   "bot_require_code_grant":false,
   "terms_of_service_url":"https://gist.github.com/mesalytic/c132c786b47c86599021237f0303b952",
   "privacy_policy_url":"https://gist.github.com/mesalytic/598c963ddfa4562ec7c867574ed7cedf",
   "install_params":{
      "scopes":["bot","applications.commands"],
      "permissions":"1926057290966"
   },
   "verify_key":"82449bea917a3e2b4a407254cc548e5d35de9cb8a888d692d65f31471ddc5fa0",
   "flags":{
      "bits":10764288,
      "detailed":["GATEWAY_GUILD_MEMBERS","GATEWAY_MESSAGE_CONTENT","APPLICATION_COMMAND_BADGE"]
   },
   "tags":["image","logging","meme","mini-game","music"]
}

https://discordlookup.mesavirep.xyz/v1/guild/81384788765712384

Note The guild linked to the request ID must have Server Widget and/or Server Discovery enabled. An error will be thrown otherwise.

{
   "id":"81384788765712384",
   "name":"Discord API",
   "instant_invite":null,
   "presence_count":18759
}

Installation

Note You must have a Redis server installed, and ready to be used.

Clone the repo using Git
Install dependencies (npm i)
Open ports (either 3000 or any other port)
Launch the Redis Server
Launch the server (node server.js)

discord-lookup-api's People

Contributors

Stargazers

Watchers

discord-lookup-api's Issues

API currently down

It seems like the API doesnt work anymore?

Invalid User ID data being cached nonetheless

When giving an invalid userID, the first response is from the Discord API, but when trying to reach it again, it accesses the cached data, giving {"created_at":"2015-01-01T00:00:00.000Z","tag":"undefined#undefined","badges":[],"avatar":{"link":null,"is_animated":false},"banner":{"link":null,"is_animated":false}}

API is currently down

I don't have much information as to why, but the server is down.

If you need to access the API, either wait or self-host it yourself

Pronoun support?

Pronouns are a thing now and I can't tell if the Discord Canary endpoint you're getting data from sends it, but if it does then it would be nice to include it :)

Return wrong information

Return wrong result with this id https://discordlookup.mesavirep.xyz/v1/user/547432443125432322

{"created_at":"2015-01-01T00:00:00.000Z","tag":"undefined#undefined","badges":[],"avatar":{"link":null,"is_animated":false},"banner":{"link":null,"is_animated":false}}

Webserver is down

mesavirep.xyz and therefore the API for https://discordlookup.mesavirep.xyz/v is down.
If you are in need of donations, feel free to tell me.

Usernames without discriminators given a #0 at the end

Examples:

https://discordlookup.mesavirep.xyz/v1/user/622004374587179008
https://discordlookup.mesavirep.xyz/v1/user/775475238669516826

can probably implement a simple fix to this because I'm guessing this is mainly a problem on Discord's end.

PORT=3000
TOKEN=PK_123456

// redis config
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=123

OAuth Idea

You say you need OAuth for certain info, you could add message in the JSON output telling apps to ask the user to Auth the api for the extended info
maybe include something like this at the bottom

"extended": [
"message": "The current user needs to authorize the api for extra information, ask the user to grant permission to the app.",
"url": "https://discord.com/...."
]