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

Blockchain

The Blockchain API provides a set of endpoints to query blockchain contracts and contract metadata. Blockchain contracts are configured via the admin console and are managed internally.

PreviousLeaderboardNextConfiguration

Last updated 4 months ago

Contract

Launchpad

NFT

SUI

Return basic contract data

get
Path parameters
contractIdstringRequired
Responses
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
default
application/json
get
GET /v1/blockchain/contract/{contractId} HTTP/1.1
Host: 
Accept: */*
{
  "code": 10002,
  "message": "generic_client_error"
}

Return vault contract fundraises

get
Query parameters
containerIdstringRequired
Responses
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
default
application/json
get
GET /v1/blockchain/launchpad/fundraises?containerId=text HTTP/1.1
Host: 
Accept: */*
{
  "code": 10002,
  "message": "generic_client_error"
}

Generate whitelist signature for whitelisted fundraise deposits

get
Path parameters
fundraiseIdstringRequired
addressstringRequired
Query parameters
chainIdstringRequired
Responses
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
default
application/json
get
GET /v1/blockchain/launchpad/fundraise/{fundraiseId}/signature/{address}?chainId=text HTTP/1.1
Host: 
Accept: */*
{
  "code": 10002,
  "message": "generic_client_error"
}

Return an addresses contribution to a fundraise

get
Path parameters
fundraiseIdstringRequired
addressstringRequired
Responses
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
default
application/json
get
GET /v1/blockchain/launchpad/fundraise/{fundraiseId}/contribution/{address} HTTP/1.1
Host: 
Accept: */*
{
  "code": 10002,
  "message": "generic_client_error"
}

Return an addresses allocation tier for a fundraise

get
Path parameters
contractIdstringRequired
fundraiseIdstringRequired
addressstringRequired
Responses
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
default
application/json
get
GET /v1/blockchain/launchpad/tier-manager/{contractId}/fundraise/{fundraiseId}/allocation/{address} HTTP/1.1
Host: 
Accept: */*
{
  "code": 10002,
  "message": "generic_client_error"
}

List the token distribution vesting schedules for an address

get
Path parameters
contractIdstringRequired
addressstringRequired
Responses
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
default
application/json
get
GET /v1/blockchain/launchpad/distribution/{contractId}/schedules/{address} HTTP/1.1
Host: 
Accept: */*
{
  "code": 10002,
  "message": "generic_client_error"
}

Get metadata for EVM NFT

get
Path parameters
inventoryIdstringRequired
contractIdstringRequired
tokenIdstringRequired
Responses
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
default
application/json
get
GET /v1/blockchain/nft/metadata/{inventoryId}/{contractId}/{tokenId} HTTP/1.1
Host: 
Accept: */*
{
  "code": 10002,
  "message": "generic_client_error"
}

Generate nonce for ZKLogin OAuth

get
Responses
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
default
application/json
get
GET /v1/blockchain/sui/nonce HTTP/1.1
Host: 
Accept: */*
{
  "code": 10002,
  "message": "generic_client_error"
}
  • Contract
  • GETReturn basic contract data
  • Launchpad
  • GETReturn vault contract fundraises
  • GETGenerate whitelist signature for whitelisted fundraise deposits
  • GETReturn an addresses contribution to a fundraise
  • GETReturn an addresses allocation tier for a fundraise
  • GETList the token distribution vesting schedules for an address
  • NFT
  • GETGet metadata for EVM NFT
  • SUI
  • GETGenerate nonce for ZKLogin OAuth