Skip to navigation
API ReferencePlatform Wallet

Check a balance

View as MarkdownOpen in Claude

The balance of your platform’s own wallet for that asset — the twin of /balance, minus the userId. The wallet is resolved server-side from your credentials; you never carry an id for it.

Do not send an X-USER-ID header here — a platform endpoint always acts as the platform wallet, and sending one is a 400.

Authentication

AuthorizationBearer

A 15-minute token from /auth. Required on every endpoint except /auth.

Headers

X-Request-IdstringOptional

Correlation id. Generated if omitted, echoed on every response, and written to the audit log. /send is the exception — there it is required, and it doubles as the idempotency key.

Request

This endpoint expects an object.
assetIdenumRequired

Primary asset selector. An all-digit string ("21") is accepted and normalised to an integer.

  • 1 — BITCOIN BTC (native, 8 decimals)
  • 2 — ETHEREUM ETH (native, 18 decimals)
  • 21 — ETHEREUM USDT (ERC20, 6 decimals)
  • 22 — ETHEREUM USDC (ERC20, 6 decimals)
  • 3 — BSC BNB (native, 18 decimals)
  • 31 — BSC USDT (BEP20, 18 decimals)
  • 32 — BSC USDC (BEP20, 18 decimals)
  • 4 — TRON TRX (native, 6 decimals)
  • 41 — TRON USDT (TRC20, 6 decimals)
  • 42 — TRON USDC (TRC20, 6 decimals) — not on every endpoint
  • 5 — POLYGON POL (native, 18 decimals)
  • 51 — POLYGON USDT (ERC20, 6 decimals) — not on every endpoint
  • 52 — POLYGON USDC (ERC20, 6 decimals)
  • 6 — SOLANA SOL (native, 9 decimals)
  • 61 — SOLANA USDT (SPL, 6 decimals) — not on every endpoint
  • 62 — SOLANA USDC (SPL, 6 decimals)

Response

OK
resultstringformat: "^\d+(\.\d+)?$"

Balance in the asset, as a human-decimal string.

requestIdstring

Echo of the inbound X-Request-Id, or a generated one.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error