Skip to main content
Use your account profile to check available platform balances and an earnings report to understand recorded income. Both are free account reads. Complete account access first; the CLI quickstart and Node.js SDK setup explain how to retain your account reference.

Choose the right amount

Keep financial amounts as decimal strings. Do not convert them through JavaScript Number, add different assets together or assume USDC on separate networks is one available balance. Earnings reports do not include fiat valuations or future reward estimates.

Check your platform balance

With @wurk/cli 0.7.1, use the initialized $WURK_STATE directory and $WURK_ACCOUNT reference saved from account access:
Read data.balances in the CLI’s JSON output: The HTTP equivalent is authenticated GET /profile. Profile reads have their own ten-second account cooldown. Refresh the profile after a completed financial operation; an earnings report is not a substitute for that balance check.

Read an earnings report

The published SDK and CLI 0.7.1 overview includes jobs, tips and vault payouts. Its includedCategories is ["jobs", "tips", "vault"], and it calculates every summary, rolling total and daily total from those categories. The direct HTTP earnings API also includes referrals in its totals and offers referral history. Version 0.7.1 has no referral method or CLI command, so its combined total can differ from the HTTP total. Choose the report you need. Wait at least ten seconds between earnings reads for the same account, including when switching reports:
Each command requires --state-dir; there is no default state directory. To authenticate an existing account with a fresh wallet proof, replace --account "$WURK_ACCOUNT" with --network solana --wallet "$WURK_WALLET", or use --network base for your registered Base wallet. Overview and vault accept 7d (default), 30d or 90d. These are UTC calendar days including today. The overview’s kpis["24h"] and kpis["7d"] use rolling windows, so a calendar total and a rolling total can differ. Jobs and tips include history beyond that window and accept no range.

Use the Node.js SDK

These helpers work with @wurk/sdk 0.7.1 and an already configured client. Pass account.access returned by client.account.access for saved account authentication. Earnings methods also accept {kind: 'wallet', network: 'solana', wallet: walletRef} or the corresponding Base wallet form.
Use client.account.tipEarnings({access, page, perPage}) for tips and client.account.vaultEarnings({access, range, page, perPage}) for vault history. Each call fetches one report or page. Schedule earnings calls at least ten seconds apart and honor an error’s retryAfterSeconds; the clients do not retry or paginate automatically.

Interpret completed and unknown amounts

In SDK/CLI job and vault history, inspect items[].reward.status. Direct HTTP uses rows[].rewardEarning.status: Tips use earningsStatus and amountWurk. Overview categories use earningsStatus, byAsset and count. When an included category is unavailable, its amounts and the corresponding combined totalByAsset are null. Show these as unknown, not zero. Other available categories can still be displayed separately. Vault history’s reportStatus is complete, partial or unavailable; unavailableBatchCount describes missing evidence across the whole selected period, including when the current page is empty. History may include pending entries, but only confirmed completed distributions enter earned totals. These payouts go directly to wallets and are already included in the overview’s combined total. Do not add the vault subtotal again or treat it as spendable platform balance. History defaults to page 1 with 20 items, allows perPage up to 50 and stops at page 1,000. Request the returned nextPage after the cooldown and stop at null. paginationLimited: true means the page ceiling prevents access to some older entries. Keep the returned pagination values; do not infer that an empty out-of-range page means there was no income.

Find other financial activity

Earnings history explains income. Use the operation histories to understand swaps, payouts and credited refunds: These free account reads each have their own ten-second cooldown. They use limit and offset with a returned nextOffset, rather than earnings’ page numbers. Follow their response contracts and deduplicate records when new activity shifts pages. A transaction hash alone does not establish a finalized withdrawal; refund history describes credited job refunds. None of these history reads moves money.