Your lending status

get/collateral/walletapi_key

This wallet's side of the collateral market: lender keys and their state, queued and live positions, and the self-collateralization settings in effect. Balances are under GET /wallet/balances.

Responses

200Lender keys, positions and settingsWalletCollateralStatus▶

This wallet's side of the collateral market. 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

403Missing or wrong api_keyApiError▶

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

404No emission state on this network yet, or the node is not indexed.ApiError▶

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

503Node or wallet unavailable. 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

← PreviousPermit price history Next →Quote joining the queue

{ "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 } ] }