XBorg SDK
  • Introduction
  • Community
    • Details
    • Resources
    • Inventory
    • Prizes
    • Store
    • Achievements
  • User
    • Profile
    • Authentication
    • Socials
    • Wallets
  • Quests
    • User
    • Community
  • Quest Events
    • Details
    • Participation
    • Leaderboard
  • Blockchain
  • Configuration
  • Shared Library SDK
    • Authentication & Setup
    • Quest Management
    • Event Management
      • Working with Events
      • Events Lifecycle
      • Events Requirements
      • Events Quests
      • Events Rewards
    • Quest Rewards
    • 3D Avatar
Powered by GitBook
On this page
  1. Community

Prizes

The Prizes API provides a comprehensive set of endpoints to create prizes and achievements to be earned by users

PreviousInventoryNextStore

Last updated 4 months ago

List prizes (paginated)

get
Query parameters
ownedOnlystringRequired

Only return items owned by the user

pagenumberOptional
limitnumberOptional
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/inventory/prizes?ownedOnly=text HTTP/1.1
Host: 
Accept: */*

No content

List all possible prize requirements

get
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/inventory/prizes/requirements HTTP/1.1
Host: 
Accept: */*

No content

Find a prize

get
Path parameters
prizeIdstringRequired
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/inventory/prizes/{prizeId} HTTP/1.1
Host: 
Accept: */*

No content

Available supply for a prize

get
Path parameters
prizeIdstringRequired
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/inventory/prizes/{prizeId}/supply HTTP/1.1
Host: 
Accept: */*

No content
  • GETList prizes (paginated)
  • GETList all possible prize requirements
  • GETFind a prize
  • GETAvailable supply for a prize