API Reference

Integrate blosm's powerful Discord username checking and sniping into your own applications.

On this page

AuthenticationCheck UsernameBulk Check UsernamesRate LimitingError HandlingWebhooks

Authentication

All API requests require an API key. Include it in the Authorization header. You can find your API key in your blosm dashboard.

GETHTTP
Authorization: Bearer YOUR_API_KEY

Security Note

Always use HTTPS. Never expose your API key in client-side code. Rotate keys if you suspect a leak.

Check Username

Check if a single username is available on Discord.

POSThttps://api.blosm.lol/v1/check

Check availability of a single username

Request Body

ParameterTypeRequiredDescription
usernamestringRequiredThe username to check
platformstringRequiredPlatform to check on (e.g. discord)
POSTJSON
{
  "username": "example",
  "platform": "discord"
}

Response

JSON
{
  "username": "example",
  "available": true,
  "platform": "discord",
  "status": "available"
}

Bulk Check Usernames

Check multiple usernames in a single request. Max 100 usernames per request.

POSThttps://api.blosm.lol/v1/check/bulk

Check multiple usernames at once

Request Body

ParameterTypeRequiredDescription
usernamesarrayRequiredArray of usernames (max 100)
platformstringRequiredPlatform to check on
POSTJSON
{
  "usernames": ["user1", "user2", "user3"],
  "platform": "discord"
}

Response

JSON
{
  "results": [
    { "username": "user1", "available": true, "status": "available" },
    { "username": "user2", "available": false, "status": "taken" },
    { "username": "user3", "available": true, "status": "available" }
  ],
  "total": 3,
  "available": 2
}

Rate Limiting

Rate limits vary by plan tier. Check your dashboard for your specific limits.

Standard Plan1,000 requests / month
Elite PlanUnlimited requests

Rate Limit Headers

Each response includes X-RateLimit-Remaining and X-RateLimit-Reset headers.

Error Handling

The API uses standard HTTP response codes. Errors return a JSON object with an error field.

200SuccessRequest succeeded
400Bad RequestInvalid parameters in the request body
401UnauthorizedMissing or invalid API key
429Rate LimitedToo many requests — check Retry-After header
500Server ErrorInternal server issue — try again later

Webhooks

Receive real-time notifications when a checked username becomes available. Configure webhook URLs in your dashboard.

JSON
{
  "username": "og_handle",
  "platform": "discord",
  "event": "username_available",
  "timestamp": "2026-07-15T12:00:00Z"
}

Webhook Configuration

Webhooks send POST requests to your endpoint. Respond with 200 OK to acknowledge receipt.

Ready to integrate?

Get your API key from the dashboard and start building.

Go to DashboardGetting Started ›