TESTNET
Connect

Funding services

All services on this page use the authenticated transport and accept the account scope field. Methods marked stream return () => void and take onEvent (+ optional onOpen / onClose / onError).

client.deposit

Method Input → Result Notes
createAddress(input, options?) chain + account? → DepositAddress | null Creates or returns the existing address.
listAddresses(input?, options?) chain?, account? → DepositAddress[]

client.transfers

Ledger transfer history: every balance movement, regardless of cause.

Method Input → Result Notes
list(input, options?) limit?, direction, time range, transfer-code and ledger filters, pageToken? → { transfers, nextPageToken }
subscribe(input) accountId → stream of transfers One event per transfer leg; a repeated leg replaces the earlier copy.

client.internalTransfers

Method Input → Result Notes
create(input, options?) destination (root / subaccount / smart account), asset, decimal amount → CreateInternalTransferResult Idempotent: repeat requests return the existing transfer.

Resolve destinations with client.accounts.resolve(...) or the address book's listTransferDestinations().

client.tradingWithdraws

Durable, signed withdrawal intents out of the Trading venue.

Method Input → Result Notes
createToFunding(input, options?) asset, decimal amount, destination + signature → CreateTradingWithdrawResult Stays on Polyester.
createToExternalChain(input, options?) asset, gross decimal amount, destination network + address + signature → CreateTradingWithdrawResult Leaves via the Zipper.

Each intent embeds a deadline (5 minutes by default, or the optional deadline input), a nonce, and an idempotency key. Signing options:

  • walletSigner: the SDK builds its canonical EIP-191 text message and has the user's EOA sign it with personal_sign.
  • payloadSignature: you precomputed the signature (API-key / custody infrastructure).

prepareToFunding / prepareToExternalChain sign once and return a PreparedTradingWithdraw with deadline, isExpired(), and submit(options?). Within a minute of the deadline, a wallet-signed withdrawal signs again on submit; a payload-signed one throws WithdrawDeadlineExpiredError once the deadline passes. See Withdrawals.

client.autoWithdraw

The account's scheduled auto-withdraw rule and its runs. See Auto-withdraw.

Method Input → Result Notes
getRule(input?, options?) account? → AutoWithdrawRule | null null when the account never had a rule.
setRule(input, options?) expectedVersion, schedule, destinations (1-32), minUsdValue?, account? → AutoWithdrawRule Needs a fresh stepUpToken. Stale version: RevisionConflictError.
disableRule(input, options?) expectedVersion, account? → AutoWithdrawRule Needs a fresh stepUpToken. Stale version: RevisionConflictError.
listRuns(input?, options?) limit? (0-100, default 20), pageToken?, account? → { runs, nextPageToken } Newest first.
Accounts Resolve usernames, account IDs, and smart-account addresses into transfer destinations. Address book Manage saved transfer destinations, tags, whitelists, and recent counterparties per account book. API keys Generate Ed25519 keypairs, create and manage API keys, and attach reusable permission policies. Auth Introspect the caller, request SIWE wallet challenges, and run the managed browser login, session, and account-switching flow. Auto-withdraw Manage an account's scheduled auto-withdraw rule and read the runs that paid it out. Balances Read current ledger balances, plus balance and equity history, and stream live balance updates. Candles Read and stream public spot OHLCV candles in row and columnar formats. Catalog The reference-data store behind every symbol lookup and decimal conversion, with typed readers for markets, ledger assets, order constraints, and zipper routes. Chain analytics Public chain chart series (zToken supply and unified balances) as columnar time windows. Changelog Read the environment's public product changelog as posts, or filter individual changes by category, audience, surface, and time. Checkpoints List the signed-in account's frozen testnet season checkpoints, with trading, funding, and portfolio recaps. Client configuration Constructors, config options, auth providers, request options, and package entry points. Deposit Create and list per-account chain deposit addresses for funding your Polyester account. Errors The complete error hierarchy: classes, codes, retryability, and helper functions. Fees Look up the effective spot maker and taker rates that apply to fills for a given account. Guard signer Manage backend guard wallets that co-sign protected account actions like whitelist changes. Heatmap Order book liquidity heatmaps as delta chains, plus a live per-interval bucket stream. Internal transfers Move funds between Polyester accounts instantly, without touching a chain. Lifecycle Read and stream cross-chain flow state for deposits and withdrawals, with history, per-flow detail, and live progress. Market overview Ticker-style per-market stats with last and index prices, 24h stats, top-of-book, and optional sparklines. MFA Enroll TOTP and passkey factors, run challenges, manage recovery codes, and mint step-up proofs. Order book Depth snapshots and a stateful live order book that reconstructs the book for you. Orders Place, modify, cancel, and read spot orders, with attached take-profit, stop-loss, and trailing-stop risk. Profile Read and update the caller's public profile, review username history, and stream public identity updates. Public trades Read and stream public spot trade prints, plus the raw spot config that feeds the catalog. Trading rate limits Fetch the public trading quota catalog, or the placement and cancellation limits that apply to an account. Realtime client The shared realtime connection every subscribe method rides, plus its handler contract, refcounting, and public versus private channels. Rewards List published reward campaign awards for the root account and record their payout destinations. Social verification Prove ownership of a Twitter account or Discord identity with provider-specific verification. Subaccounts Create, share, audit, and stream subaccounts, and manage the reusable policy templates that govern them. Trades List and stream your fills, with prices, quantities, fees, and liquidity as parsed decimal strings. Transfers Read and stream the ledger transfer history behind every balance movement on your account. Triggers Create, manage, and stream standalone automations that place a child order when a market condition fires. VIP Fetch the public VIP tier catalog, or the authenticated root account's current qualification. Withdrawals Create durable, signed withdrawal intents out of the Trading venue, to Funding or to an external chain. Zipper Read the deposit and withdraw configuration (chains, unified assets, routes, fees, minimums, contracts) and stream live route supply. Market data services Reference for the public services: market data, overview, candles, order book, heatmap, chain analytics, zipper, and lifecycle. Trading services Reference for orders, triggers, user trades, spot fee rates, and trading rate limits. Account services Reference for auth, subaccounts, API keys, balances, MFA, address book, profile, VIP, and related account services.
Previous

Account services