---
title: "GET /v2/me/username-availability"
method: GET
path: "/v2/me/username-availability"
tags: ["Identity"]
---

# GET /v2/me/username-availability

`GET /v2/me/username-availability`

## Request

- Base URL: `https://api.arbital.xyz` (the document declares no server; this is the origin it was published from)
- URL: `https://api.arbital.xyz/v2/me/username-availability`
- Auth: HTTP bearer

Checks a normalized CALLD username and returns up to three available alternatives. This response is advisory: PATCH /v2/me is the only atomic claim authority.

## Query parameters

- `username` string, required

## Response `200`

Advisory availability result

- UsernameAvailability: Advisory username check. Only a successful PATCH /v2/me atomically claims a username.
  - `available` boolean, required
  - `is_current` boolean, required: True when this case-insensitive username is already owned by the authenticated user.
  - `suggestions` string[], required
  - `username` string, required

## Other responses

- `400`: Stable machine-readable problem. HTTP 429 and 503 responses include retry and cache-validity fields plus Retry-After and X-Request-ID headers.
- `401`: Stable machine-readable problem. HTTP 429 and 503 responses include retry and cache-validity fields plus Retry-After and X-Request-ID headers.
- `409`: Stable machine-readable problem. HTTP 429 and 503 responses include retry and cache-validity fields plus Retry-After and X-Request-ID headers.
- `429`: Stable machine-readable problem. HTTP 429 and 503 responses include retry and cache-validity fields plus Retry-After and X-Request-ID headers.
- `503`: Stable machine-readable problem. HTTP 429 and 503 responses include retry and cache-validity fields plus Retry-After and X-Request-ID headers.

---

[API](https://skmtc.dev/arbital/apis/arbital-api.md) - [All operations](https://skmtc.dev/arbital/apis/arbital-api/llms.txt) - [OpenAPI document](https://skmtc.dev/arbital/apis/arbital-api/revisions/bb0185edf43a?raw)