Get User

Retrieve public profile information about a specific user by their username.

Endpoint

GET /api/users/{username}

Path Parameters

usernamerequiredstring

The username of the user.

Request Headers

Header	Value	Description
Authorization	`Bearer YOUR_API_KEY`	Your API key. Required for all requests.

Example Request

curl https://miwa.lol/api/users/username \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Returns a JSON object with the user's profile data.

Example Response

{
  "uid": 12345,
  "username": "username",
  "alias": "abc",
  "assets": {
    "audios": [
      {
        "id": "0f18b939-1d63-402e-8b7c-f022abf3a18a",
        "name": "My cool audio",
        "duration": 253,
        "cover_id": null
      }
    ],
    "avatar_url": "https://cdn.miwa.lol/avatars/ea199cc3-77c3-4f41-9215-d3689da55d63.webp",
    "background_url": "https://cdn.miwa.lol/backgrounds/f9457e67-e89a-4645-85d7-cb1beba04f5e.webp",
    "cursor_url": null
  },
  "colors": {
    "accent": "#000000",
    "background": "#000000",
    "badges": "#FFFFFF",
    "links": "#000000",
    "text": "#ffffff"
  },
  "config": {
    "avatar_shape": "circle",
    "bio": null,
    "font": "Roboto",
    "join_date": "2025-07-11",
    "layout": "default",
    "likes": 2,
    "location": "Earth",
    "page_enter_text": null,
    "page_views": 56,
    "profile_blur": 25,
    "profile_opacity": 30,
    "shuffle_audios": true,
    "use_discord_avatar": false,
    "volume_control": false
  },
  "effects": {
    "background": "snowflakes",
    "badges_glow": true,
    "cursor": null,
    "links_glow": true,
    "username": "rainbow",
    "username_glow": false
  },
  "tab": {
    "animated_title": "typewriter",
    "use_avatar": false
  },
  "typewriter": {
    "enabled": false,
    "texts": []
  }
}

Response Fields

Top-level

uidnumber

Unique numeric identifier for the user.

usernamestring

The user's username.

aliasstring

A short display alias for the user.

`assets`

audiosarray

List of audio tracks on the profile.

audios[].idstring

UUID of the audio track.

audios[].namestring

Display name of the audio track.

audios[].durationnumber

Duration of the audio track in seconds.

audios[].cover_idstringnull

UUID of the cover image, or null if none.

avatar_urlstringnull

CDN URL of the user's avatar image.

background_urlstringnull

CDN URL of the profile background image.

cursor_urlstringnull

CDN URL of the custom cursor, or null if none.

`colors`

accentstring

Accent color as a hex value.

backgroundstring

Background color as a hex value.

badgesstring

Badge color as a hex value.

linksstring

Link button color as a hex value.

textstring

Primary text color as a hex value.

`config`

avatar_shapestring

Shape of the avatar (circle, square, etc.).

biostringnull

Profile bio text, or null if not set.

fontstring

Font family used on the profile.

join_datestring

Date the user joined, in YYYY-MM-DD format.

layoutstring

Profile layout style (e.g. default).

likesnumbernull

Total number of likes received, or null if hidden by the user.

locationstringnull

User's location, or null if not set.

page_enter_textstringnull

Custom text shown on the page enter screen, or null if none.

page_viewsnumbernull

Total profile page view count, or null if hidden by the user.

profile_blurnumber

Background blur level (0–100).

profile_opacitynumber

Background opacity level (0–100).

shuffle_audiosboolean

Whether audio tracks are shuffled.

use_discord_avatarboolean

Whether the Discord avatar is used instead of the custom one.

volume_controlboolean

Whether the volume control is visible on the profile.

`effects`

backgroundstringnull

Background particle effect (e.g. snowflakes), or null.

badges_glowboolean

Whether badges have a glow effect.

cursorstringnull

Custom cursor effect name, or null if none.

links_glowboolean

Whether link buttons have a glow effect.

usernamestringnull

Username text effect (e.g. rainbow), or null.

username_glowboolean

Whether the username has a glow effect.

`tab`

animated_titlestringnull

Browser tab title animation style, or null.

use_avatarboolean

Whether the avatar is shown as the browser tab icon.

`typewriter`

enabledboolean

Whether the typewriter effect is enabled.

textsarray

List of strings cycled through by the effect.

Error Responses

Status	Description
`401`	Missing or invalid API key.
`404`	No user found with the given username.
`429`	Rate limit exceeded. Wait before retrying.