Developer
  • API Overview
  • Getting Started
    • Authentication
    • Xyxyx API Keys
    • Getting an API Key
    • Rates & Limits
    • Endpoint URLs
    • Networks
    • Tokenization Models
  • Explorer
  • API Endpoints
    • ERC-721F
      • Deploy Contract
      • Mint 1x1
      • Mint A4
    • ERC-721
      • Deploy Contract 1x1
      • Deploy Contract A4
      • Mint Token
    • ERC-404
      • Deploy Contract 1x1
      • Deploy Contract A4
    • Preview Token
      • 1x1
      • A4
  • Utilities
    • Authorization for wallet transactions
    • Function insights
    • Code samples
    • Xyxyx Web Components
      • Tokenizer
Powered by GitBook
On this page
  1. API Endpoints
  2. Preview Token

1x1

Endpoint

POST /api/v1/preview-token-1x1

Download an SVG file to preview a 1x1 token output


Headers

Name
Value

Content-Type

application/json

Authorization


Body

Name
Type
Description

tokenText

string

The text content that is stamped in the token output

walletPrivateKey

string

For authorizing wallet transaction

background

string (optional), defaults to #000000

Hexadecimal color for the token output background

textColor

string (optional), defaults to #FFFFFF

Hexadecimal color for the token output text

fontFamily

string (optional), defaults to sans-serif

Font-family that is used in the token output text

borderRadius

integer (optional), defaults to 0

Border radius that is applied to the token output

showTrademark

boolean (optional), defaults to false

Xyxyx trademark displayed on the token output bottom right corner

showDeployerAddress

boolean (optional), defaults to false

Deployer address displayed on the token output bottom left corner

logo

string (SVG) (optional), defaults to null

1:1 SVG that is displayed on the top left corner of the token output

watermark

string (SVG) (optional), defaults to null

1:1 SVG that is displayed in the background of the token output (with 70% opacity)


Response

Downloads SVG file.

{
  "success": false,
  "status": "Failed to preview token: {error.message}"
}
{
  "success": false,
  "status": "The wallet does not own any valid Xyxyx API Key or XIN"
}
{
  "success": false,
  "status": "This wallet has already consumed its 24-hour request quota"
}
PreviousPreview TokenNextA4

Last updated 2 months ago

or

Xyxyx API Key
XIN