Skip to main content

Xarcade Microservice API (1.0.0)

This microservice aims to help you seamlessly integrate blockchain services into your games.

Introduction

Use our flexible, easy-to-setup, scalable wallet autosigner to quickly and securely sign in-game transactions for you. The Xarcade Wallet Autosigner is a tiny service dedicated for signing transactions.

Paired with the Xarcade Web API, the autosigner helps you seamlessly integrate the ProximaX blockchain services and the Xarcade Appstore into your games.

Authentication

bearer

Security Scheme Type API Key
Header parameter name: Bearer

Users

A ProximaX blockchain wallet identifies an owner of assets and namespaces.

Get list of tokens

Retrieves a list of tokens owned by a Xarcade user.

Authorizations:
path Parameters
userKey
required
string

Temporary UserKey to identify a Xarcade user.

Responses

Response samples

Content type
application/json
{
  • "tokenId": "C7432613B709C99C",
  • "names": [
    ],
  • "description": "Super legendary sword token",
  • "logo": "abc.png",
  • "owner": "VAQE7L-ZUOA2S-EJXVQP-ZRBMTY-AQPVR7-YT6O43-BTOP",
  • "amount": 100,
  • "supply": 10000000
}

Get token

Retrieves the amount of specified in-game tokens owned by a user.

Authorizations:
path Parameters
userKey
required
string

Temporary UserKey to identify a Xarcade user.

tokenId
required
string

Token ID or name token namespace

Responses

Response samples

Content type
application/json
{
  • "tokenId": "C7432613B709C99C",
  • "names": [
    ],
  • "description": "Super legendary sword token",
  • "logo": "abc.png",
  • "owner": "VAQE7L-ZUOA2S-EJXVQP-ZRBMTY-AQPVR7-YT6O43-BTOP",
  • "amount": 100,
  • "supply": 10000000
}

Tokens

A token is an entity attached to an Asset that represents a commodity, currency, or NFT on the blockchain network.

Get Token By ID

Retrieves the token's information.

Authorizations:
path Parameters
tokenId
required
string

The id of the token to fetch

Responses

Response samples

Content type
application/json
{
  • "tokenId": "C7432613B709C99C",
  • "names": [
    ],
  • "description": "Super legendary sword token",
  • "logo": "abc.png",
  • "owner": "VAQE7L-ZUOA2S-EJXVQP-ZRBMTY-AQPVR7-YT6O43-BTOP",
  • "amount": 100,
  • "supply": 10000000
}

Transactions

Allows you to exchange, receive, and airdrop tokens.

Airdrop Tokens

Initiates a transaction to airdrop tokens to a gamer.

Authorizations:
query Parameters
DeveloperToken
string
Example: DeveloperToken=watertoken

namespace name of token the developer will send.

DeveloperTokenAmount
number
Example: DeveloperTokenAmount=36

number of DeveloperTokens to send.

GamerId
string
Example: GamerId=b6bd0766-da9a-4eed-8382-5c478dafd793

Id of gamer to send tokens to.

Responses

Response samples

Content type
application/json
{
  • "Message": "Success! Transaction initiated!",
  • "Success": true
}

Exchange Tokens (Coming Soon)

Initiates a transaction to exchange or trade two tokens.

Authorizations:
query Parameters
DeveloperToken
string
Example: DeveloperToken=watertoken

namespace name of token the developer will exchange

DeveloperTokenAmount
number
Example: DeveloperTokenAmount=36

number of DeveloperTokens to exchange

GamerId
string
Example: GamerId=b6bd0766-da9a-4eed-8382-5c478dafd793

Id of player to exchange tokens with

GamerToken
string
Example: GamerToken=firetoken

namespace name of token the player will exchange

GamerTokenAmount
number
Example: GamerTokenAmount=1

number of GamerTokens the player will exchange

Responses

Receive Tokens (Coming Soon)

Initiates a transaction to receive tokens from a gamer.

Authorizations:
query Parameters
GamerToken
string
Example: GamerToken=watertoken

namespace name of token to request.

GamerTokenAmount
number
Example: GamerTokenAmount=36

number of GamerTokens to request.

GamerId
string
Example: GamerId=b6bd0766-da9a-4eed-8382-5c478dafd793

Id of gamer to request tokens from.

Responses