Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.username.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Quick start

Get up and running in minutes with your first API call.

​
Step 1: Get your API key

Sign up at app.username.dev/signup to get your API key. Your API key format is: un_live_<32-char-random>

​
Step 2: Make your first request

import { UsernameClient } from 'username-dev';

const client = new UsernameClient('un_live_your_api_key_here');
const result = await client.check('berlin');
console.log(result);

​
Step 3: Understand the response

The API returns whether a username is reserved, its deletion status, and associated categories: 
{
  "username": "berlin",
  "isReserved": true,
  "isDeleted": false,
  "categories": [
    {
      "category": "city",
      "metadata": {
        "country": "DE"
      }
    }
  ]
}
Both reserved and non-reserved usernames return a 200 status code. Check the isReserved field to determine if a username is available.

​
What’s next?

  • SDK Documentation - Use the official JavaScript/TypeScript SDK
  • CLI Documentation - Use the command-line interface tool
  • API Reference - Learn all the details about the /check endpoint in the API Reference section
  • Error codes - Understand error responses and how to handle them
  • Troubleshooting - Common troubleshooting tips and solutions
  • Get your API key - Sign up and start using the API