Auth

Public username check. Returns availability and up to 5 free suggestions. 30 requests per minute per IP. Responses include RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset (seconds until the window ends). HTTP 429 rate_limited includes Retry-After, retry_after_seconds, and resets_at, and RateLimit-Reset matches Retry-After. A lookup that cannot be completed returns HTTP 503 username_check_unavailable. If the limit cannot be checked, the response is HTTP 503 rate_limit_unavailable. Both 503 responses include Retry-After, retry_after_seconds, and resets_at.

get/api/v1/usernames/check

Request

  • Base URL: https://cooperemail.com
  • URL: https://cooperemail.com/api/v1/usernames/check
  • Auth: none required

Query parameters

namestring

Requested local part. Trimmed and lowercased as normalized.

Response

Availability. No account id and no holder.

namestring required
normalizedstring required
availableboolean required
reason'invalid_username' | 'reserved_username' | 'taken'
suggestionsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.