# Username

Schemas

Whether a username is free to register on a platform, why not if it's taken, and the free alternatives its sign-up form suggests.

## Endpoints

1 endpoint returns usernames on Instagram.

- [GETInstagram Username Availability API`/v1/instagram/username`](https://socialtap.dev/docs/reference/instagram/username/index.md)

## Schema

Every endpoint above returns this object as `data`. The standard [`meta`](https://socialtap.dev/docs/reference/index.md#meta) comes with every response.

| Field | Type | Description |
| --- | --- | --- |
| `platform` | `string` | Platform whose sign-up checked the username. |
| `id` | `string` | The username checked, as its identifier: the same value as username (a name, free or taken, has no other ID in a sign-up check). |
| `username` | `string` | The username checked, without @, in the platform's canonical form (lowercase where usernames are case-insensitive). |
| `url` | `string` (uri) or `null` | The profile page at this username: the account's page when it is taken, the page it would have once registered (until then the platform answers it as not found); null when that address is one of the platform's own pages (instagram.com/explore/), not an account's. |
| `is_available` | `boolean` or `null` | True when the platform would let someone register the username now; false when it is taken, reserved or breaks the platform's username rules (reason and message say which); null when the platform did not say. |
| `reason` | `string` or `null` | Why the username is not available: taken = registered to an account or reserved by the platform (platforms don't tell the two apart); invalid = breaks the platform's username rules (length, characters). Null when it is available or the platform gave no reason. New values may be added.<br>One of `taken`, `invalid` |
| `message` | `string` or `null` | The platform's own explanation when the username is not available, as its sign-up form shows it (English); null when it is available. |
| `suggestions` | `string[]` | Free usernames the platform's sign-up form proposes for this one, in its order; \[\] when it proposes none (platforms suggest nothing for short, protected or brand names). Free when proposed: someone can take one at any time. |
| `platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |

---

[HTML version](https://socialtap.dev/resources/username/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)