latestOpenAPI 3.1.02026-08-1013317298.0 KB

d94e0e0f1821

User Progress

Get user's badge progress

Returns detailed progress information for all badges associated with a specific user address.

This endpoint provides comprehensive tracking data including:

  • Achieved badges: Badges the user has earned (at least one step completed)
  • Progress tracking: Current steps completed vs. target steps for next tier
  • Tier progression: For tiered badges, shows which tiers have been completed and when
  • Completion status: Whether the badge/tier is fully completed
  • Asset information: Current badge/tier images and metadata

The response is divided into two categories:

  • achieved: Badges with at least one step or tier completed
  • notAchieved: Badges not yet started (only included if includeNotAchieved=true)

For tiered badges, the progress tracks movement through tiers (Starter → Bronze → Silver → Gold → Platinum → Diamond). For single-tier badges, it tracks completion of a specific criteria.

get/users/{address}/badges

Path parameters

addressstring required

User's Ethereum address (wallet address)

Query parameters

includeNotAchievedboolean

If true, includes badges that the user hasn't started working toward yet

Response

Successfully retrieved user's badge progress