Unicat API Reference

Up - API Reference - Home


/api/username

Check if a username is available.

Usernames are case-sensitive and Unicode is allowed.

Request

POST /api/username

{
    "username": "<username-to-check>",
}

Success response

{
    "success": true,
    "result": {
        "status": "available",
    },
    "data": {},
}

result

status is either unavailable or available.

Error response

400 Bad request - missing parameters (only the first is reported)

HTTP/1.1 400 Bad request

{
    "success": false,
    "result": {
        "code": 400,
        "message": "Bad request",
        "info": {
            "Missing parameter": {"name": "username"},
        }
    },
    "data": {}
}