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
curl -X GET "https://api.username.dev/check?input=berlin" \
-H "Authorization: Bearer un_live_your_api_key_here"
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?
