v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB
Settings

Check Username Availability

Check if a username is taken. Returns false if the username is available, true if it is already taken.

post/api/{account}/settings/username-exists

Request body

usernamestring required

The username to check.

Example request

{
  "username": "MyNewUsername"
}

Response

Success

Example response

{
  "data": {
    "success": false
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 999999972,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 10000000,
      "limit_day": 50000,
      "remaining_minute": 9999994,
      "remaining_day": 49973
    }
  }
}