GET /v1/images/rank-card
Bearer auth

Creates a customizable rank card showing user level, XP, and rank position. Uses Amina's design system with support for custom themes and colors.

Query parameters

  • username string Required

    Display name

  • level integer Required

    Current level

    Minimum value is 0.

  • xp integer Required

    Current XP

    Minimum value is 0.

  • requiredXp integer Required

    XP needed for next level

    Minimum value is 1.

  • rank integer Required

    Leaderboard position

    Minimum value is 1.

  • avatar string(uri)

    Avatar image URL

  • status string

    Discord status indicator

    Values are online, idle, dnd, or offline.

  • theme string

    Card theme

    Values are dark, light, or amina. Default value is amina.

  • progressColor string

    Progress bar color (hex)

    Format should match the following pattern: ^#[0-9A-Fa-f]{6}$.

Responses

  • 200 image/svg+xml

    SVG image
  • 400 application/json

    Bad request - missing or invalid parameters

    Hide response attributes Show response attributes object
    • success boolean
    • error object
      Hide error attributes Show error attributes object
      • message string
      • code string
    • meta object
      Hide meta attribute Show meta attribute object
      • generatedAt string(date-time)
  • 401 application/json

    Unauthorized - invalid or missing API key

    Hide response attributes Show response attributes object
    • success boolean
    • error object
      Hide error attributes Show error attributes object
      • message string
      • code string
    • meta object
      Hide meta attribute Show meta attribute object
      • generatedAt string(date-time)
  • 429 application/json

    Rate limit exceeded

    Hide headers attributes Show headers attributes
    • X-RateLimit-Limit integer
    • X-RateLimit-Remaining integer
    • X-RateLimit-Reset integer
    • Retry-After integer
    Hide response attributes Show response attributes object
    • success boolean
    • error object
      Hide error attributes Show error attributes object
      • message string
      • code string
    • meta object
      Hide meta attribute Show meta attribute object
      • generatedAt string(date-time)
GET /v1/images/rank-card 
curl \
 --request GET 'https://api.4mina.app/v1/images/rank-card?username=string&level=42&xp=42&requiredXp=42&rank=42' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
string
Response examples (400) 
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string"
  },
  "meta": {
    "generatedAt": "2025-05-04T09:42:00Z"
  }
}
Response examples (401) 
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string"
  },
  "meta": {
    "generatedAt": "2025-05-04T09:42:00Z"
  }
}
Response examples (429) 
# Headers
X-RateLimit-Limit: 42
X-RateLimit-Remaining: 42
X-RateLimit-Reset: 42
Retry-After: 42

# Payload
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string"
  },
  "meta": {
    "generatedAt": "2025-05-04T09:42:00Z"
  }
}