Introduction

Fast username availability checker for multiple platforms

@lookups/usernames is a fast and reliable npm package that allows you to check username availability across multiple platforms including Discord, GitHub, Instagram, Roblox, and Minecraft.

Easy Installation

Install via npm, pnpm, or yarn and start using immediately

Install Now

Quick Start

Simple API with TypeScript support and comprehensive examples

View Examples

Features

  • ✅ Support for Discord, GitHub, Instagram, Roblox, and Minecraft
  • ✅ Full TypeScript support with type definitions
  • ✅ Fast and reliable API responses
  • ✅ Parallel username checking capabilities
  • ✅ Username suggestions for unavailable names (GitHub)
  • ✅ ESM and CommonJS support

Quick Example

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

const client = new Client();

async function main() {
  const discord = await client.discord("alwayswealthy");
  const github = await client.github("pqpcara");
  
  console.log(discord);
  console.log(github);
}

main();
Output
{
  "platform": "discord",
  "username": "alwayswealthy",
  "available": false,
  "message": "Username alwayswealthy is not available."
}
{
  "platform": "github",
  "username": "pqpcara",
  "available": false,
  "suggestions": "pqpcara-dev, pqpcara2, or pqpcara232 are available.",
  "message": "Username pqpcara is not available."
}