Wallet balances and lending status

get/wallet/balancesapi_key

Spendable ERG, token balances, and — under collateral — lender keys, queued and live positions, locked block rewards, and the self-collateralization settings in effect.

nanoErgs is the ERG available to spend right now: unreserved wallet boxes plus matured block rewards. Reading balances and lending status in one call means both describe the same instant.

Responses

200Current wallet balances and lending statusWalletBalances▶

This client's wallet, for both LithosDex and the collateral market. One call so a page does not have to stitch two together, and so both halves describe the same instant.

primaryAddressstringrequired
The wallet's main P2PK address, where change and swept rewards land
nanoErgsstringrequired
Unreserved ERG available to spend right now, unclaimed coinbases excluded — the figure a join quote's affordNow is decided against. Decimal string.
▶
tokensWalletToken[]required
Every token the wallet holds, including LIT.
- tokenIdstringrequired
- namestring
- decimalsinteger · int32
- amountstringrequired
  Raw token units held. Decimal string.
▶
collateralWalletCollateralStatusrequired
The collateral-market half of the wallet. Lender keys are the expensive part to compute, so the client serves them from a short-lived cache rather than rescanning per request.
- autoCollateralizebooleanrequired
  Whether the client joins the queue on its own timer. While this is true the client refuses manual joins — the automated pass owns lender-key selection, and a manual join can take a key it is already using. Turn it off in the client config to join by hand.
- maxOwnCollateralinteger · int32required
  Configured ceiling on live positions owned by this wallet
- maxJoinsPerRuninteger · int32required
  Most positions one automated pass creates. Does not bound a manual join, which is limited by free lender keys, the exposure budget and the wallet balance.
- maxLenderKeysinteger · int32required
  Wallet addresses dedicated to lending
- maxPermitPerJoinLitstringrequired
  The permit price above which automated joins stop. Decimal string.
- ownPositionsQueuedinteger · int32required
- ownPositionsLiveinteger · int32required
- ownBudgetRemaininginteger · int32required
  How many more positions the configured exposure budget allows
- freeLenderKeysinteger · int32required
  Keys with status FREE — positions that can be opened without deriving a new key. A join needs one key per position.
- keysDerivableinteger · int32required
  Further keys the client may derive before reaching maxLenderKeys. A join of N positions is possible when freeLenderKeys + keysDerivable >= N.
- ▶
  lenderKeysCollateralLenderKeyStatus[]required
  addressstringrequired
  statusstringrequired
  FREE has no position and can join. QUEUED is waiting in the queue. ACTIVE holds a live collateral box. RETIRING held one until recently and cannot be reused yet. Only FREE keys are available to a join. One key holds at most one position; a second position under a key already in the active set is forfeited.
  one ofFREEQUEUEDACTIVERETIRING
  positioninteger · int64
  Queue position, when QUEUED
- ▶
  positionsCollateralPositionSummary[]required
  kindstringrequired
  one ofQUEUEDLIVE
  boxIdstringrequired
  positioninteger · int64
  Queue position, when QUEUED
  principalNanoErgsstringrequired
  Decimal string.
  permitLitstringrequired
  Permit paid at join. Present for QUEUED positions only.
  carriedLitstring
  LIT carried on the box — emission plus permit together. Present for LIVE positions only. Decimal string.
  creationHeightinteger · int32required
- ▶
  rewardsCollateralRewardSummaryrequired
  This wallet's locked coinbase rewards
  boxesinteger · int32required
  Reward boxes held, including ones still behind the timelock
  unlockedBoxesinteger · int32required
  How many are spendable now
  totalNanoErgsstringrequired
  Every reward box together. Decimal string.
  unlockedNanoErgsstringrequired
  The part past its timelock. Decimal string.
  blocksUntilFirstUnlockinteger · int32
  Blocks until the earliest still-locked box matures. Absent when none are locked.

403Missing or wrong api_keyApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

503Node or wallet unavailable — it may be locked. Retry.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

defaultErrorApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

← PreviousFee history for one provision Next →Get Stratum information

{ "primaryAddress": "3WwbzR34YmLRy3Z6WLON5hBBkX8Zm1gUHmC7tEXDNRJfHBqhsZr", "nanoErgs": "182400000000", "tokens": [ { "tokenId": "86e272f770aa4ef48ad7e6d6dbe98b5069edd8383a403a8edb3ceed8a3d5cea3", "name": "LIT", "decimals": 4, "amount": "5420000000" } ], "collateral": { "autoCollateralize": false, "maxOwnCollateral": 10, "maxJoinsPerRun": 5, "maxLenderKeys": 32, "maxPermitPerJoinLit": "30000000000000", "ownPositionsQueued": 3, "ownPositionsLive": 7, "ownBudgetRemaining": 0, "freeLenderKeys": 4, "keysDerivable": 12, "lenderKeys": [ { "address": "3WwbQFz3vgi8ChY9dM1haQLGDeQYe5U9z98bwWW4TqxxEAvyYu5y", "status": "ACTIVE", "position": 411 } ], "positions": [ { "kind": "QUEUED", "boxId": "ce00d6e0f4fd3390c0519bb0d24824e1e6b06978163f4845a7cf2c1c7d8f1b65", "position": 411, "principalNanoErgs": "2915000000", "permitLit": "19380000000", "carriedLit": "19380000000", "creationHeight": 484102 } ], "rewards": { "boxes": 4, "unlockedBoxes": 2, "totalNanoErgs": "12000000000", "unlockedNanoErgs": "6000000000", "blocksUntilFirstUnlock": 0 } } }