Check if a profile alias is available

POST https://api.cryptohopper.com/v1/social/alias

Normalizes the alias you send (lowercase, spaces and dots become hyphens, other characters are removed) and tells you whether that alias is still free for your social profile.

OAuth scope: manage About scopes

The returned alias is the normalized form. Aliases of 2 characters or less, longer than 120 characters or fully numeric are rejected with a 400 error. An alias you already own is reported as available.

Example request

curl -X POST "https://api.cryptohopper.com/v1/social/alias" \
  -H "access-token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"alias":"trader-jane"}'

Parameters

Headers

NameTypeRequiredDescription
access-token string Required The OAuth access token of the user.

Response

Example response (illustrative values)

{
    "data": {
        "available": 1,
        "alias": "trader-jane",
        "message": "Alias is available."
    }
}

Status codes: 200. Errors return JSON with status, error and message. See How the API works for response codes and rate limits.