Skip to content

Tokens

Call the public token gateway for account-model wallet ops (fungible-token v2.0, multi-token). Authenticate with a dashboard-minted X-Api-Key. Do not dial node hosts.

Copy the exact gateway URL from Dashboard → API Keys. Machine-readable contract: API reference → Tokens. NFT configuration is not yet public.

Contract

MethodPathScope
GET/token-gateway/whoamiResolve networkId + URLs from the API key alone
GET/token-gateway/{networkId}/tokenstoken:read
POST/token-gateway/{networkId}/tokenstoken:create
POST/token-gateway/{networkId}/tokens/{tokenId}/issuetoken:issue
POST/token-gateway/{networkId}/tokens/{tokenId}/transfertoken:transfer
POST/token-gateway/{networkId}/tokens/{tokenId}/redeemtoken:redeem
GET/token-gateway/{networkId}/tokens/{tokenId}/redeem/quotetoken:read
GET/token-gateway/{networkId}/tokens/{tokenId}/wallets/{walletId}/balancetoken:read
GET/token-gateway/{networkId}/tokens/{tokenId}/wallets/{walletId}/historytoken:read
GET/token-gateway/{networkId}/wallets/{walletId}/portfoliotoken:read

Treat these routes as the stable partner wallet contract. See Upgrade & compatibility. Mint keys with token:* scopes in Dashboard → Developer → API Keys.

Create and list tokens

A single network can host many independent coins. The primary / deploy-time token uses tokenId=default. Create additional tokens with token:create:

MethodPathPurpose
GET/token-gateway/{networkId}/tokensList tokens on the network
POST/token-gateway/{networkId}/tokensCreate a token (token:create)
POST/token-gateway/{networkId}/tokens/{tokenId}/issueIssue for a specific token
POST/token-gateway/{networkId}/tokens/{tokenId}/transferTransfer for a specific token
GET/token-gateway/{networkId}/tokens/{tokenId}/wallets/{walletId}/balanceBalance for a specific token
GET/token-gateway/{networkId}/wallets/{walletId}/portfolioHoldings across all tokens

Wallet operations

Replace {networkId} and {tokenId} from your key card (whoami or Dashboard → API Keys). Examples use the public gateway path.

Issue

POST /token-gateway/{networkId}/tokens/{tokenId}/issue
X-Api-Key: <key>
Content-Type: application/json

{
  "walletId": "wallet-a",
  "usdAmount": 10,
  "coinUnits": 100
}

Transfer

POST /token-gateway/{networkId}/tokens/{tokenId}/transfer
X-Api-Key: <key>
Content-Type: application/json

{
  "fromWalletId": "wallet-a",
  "toWalletId": "wallet-b",
  "amount": 25
}

Redeem quote

GET /token-gateway/{networkId}/tokens/{tokenId}/redeem/quote?amount=10
X-Api-Key: <key>

Redeem

POST /token-gateway/{networkId}/tokens/{tokenId}/redeem
X-Api-Key: <key>
Content-Type: application/json

{
  "walletId": "wallet-a",
  "amount": 10
}

Admin routes (out of scope)

Operator-only token tooling (init, distribute, top-up-reserve, reverse, audit-export) is not part of the public partner contract. It is omitted from the published OpenAPI. Use the gateway routes above for integration.

Success shape

Successful submits typically return:

{
  "success": true,
  "transactionId": "…"
}

Evaluates (quote, balance, history) return { "success": true, "result": … }. Failures use the error envelope.

Was this page clear?