L
@lookups/usernames

API Reference

Complete API documentation for @lookups/usernames

Client

The main class for interacting with the username checker API.

import { Client } from "@lookups/usernames";

const client = new Client();

Methods

client.discord(username)
async

Check if a username is available on Discord.

Parameters:
  • username (string) - The username to check
Returns:

Promise<UsernameCheckResult>

const result = await client.discord("coolgamer");
console.log(result);
Output
{
  platform: "discord",
  username: "coolgamer",
  available: true,
  message: "Username is available on Discord"
}
client.github(username)
async

Check if a username is available on GitHub. Includes suggestions for unavailable usernames.

Parameters:
  • username (string) - The username to check
Returns:

Promise<UsernameCheckResult>

const result = await client.github("torvalds");
console.log(result);
Output
{
  platform: "github",
  username: "torvalds",
  available: false,
  message: "Username is not available on GitHub",
  suggestions: "torvalds1, torvalds-dev, torvalds2024"
}
client.instagram(username)
async

Check if a username is available on Instagram.

Parameters:
  • username (string) - The username to check
Returns:

Promise<UsernameCheckResult>

const result = await client.instagram("photographer");
console.log(result);
Output
{
  platform: "instagram",
  username: "photographer",
  available: false,
  message: "Username is not available on Instagram"
}
client.roblox(username)
async

Check if a username is available on Roblox.

Parameters:
  • username (string) - The username to check
Returns:

Promise<UsernameCheckResult>

const result = await client.roblox("builderman");
console.log(result);
Output
{
  platform: "roblox",
  username: "builderman",
  available: false,
  message: "Username is not available on Roblox"
}
client.minecraft(username)
async

Check if a username is available on Minecraft.

Parameters:
  • username (string) - The username to check
Returns:

Promise<UsernameCheckResult>

const result = await client.minecraft("Notch");
console.log(result);
Output
{
  platform: "minecraft",
  username: "Notch",
  available: false,
  message: "Username is not available on Minecraft"
}

Error Handling

Handle errors gracefully when checking usernames:

try {
  const result = await client.discord("username");
  
  if (result.available) {
    console.log("Username is available!");
  } else {
    console.log("Username is taken");
  }
} catch (error) {
  console.error("Error checking username:", error);
}

Batch Checking

Check username availability across multiple platforms:

const username = "myusername";

const results = await Promise.all([
  client.discord(username),
  client.github(username),
  client.instagram(username),
  client.roblox(username),
  client.minecraft(username)
]);

results.forEach(result => {
  console.log(`${result.platform}: ${result.available ? "✓" : "✗"}`);
});
Output
discord: ✓
github: ✗
instagram: ✓
roblox: ✗
minecraft: ✓