This wallet's lending earnings
/stats/collateral/earningsapi_keyEvery collateral box of this wallet's that a Lithos block spent in retained history, newest first, with what the lender posted and what came back.
A lender posts the box's whole value: the fixed principal plus any priority fee bid on top. The
block that spends it pays the lender twice, both locked to the lender's key for
rewardLockBlocks blocks: the coinbase, the block reward, and the block's fees, every
transaction fee in it. On mainnet the coinbase is reported less its re-emission tokens, which
a spend of it must pay. netNanoErg is what came back less what was posted. The network fee
each join paid is not in it, and neither is the LIT permit, which comes back in full.
joinedHeight is the block that included the queue box, so height - joinedHeight is how
long the principal waited before it was used, and the reward stays locked
rewardLockBlocks after that.
History is kept for stats.mining.historyDays; positions spent before retainedFromHeight
have been pruned and are in neither the list nor totals.
Query parameters
offsetinteger · int32default 0Positions to skip, counting from the newest.
limitinteger · int32default 50Positions per page.
Responses
200One page of spent positions, with totals over all of retained history.LendingPage▶
statusstringrequiredHow far collection has got.
readymeans it reached the last checked chain tip.catching-upandrecoveringmean replay or reorg work is still running,stalemeans the last successful check is too old, andunavailablemeans collection failed. Ondisabledorloadingthe numbers are not evidence that the period was quiet.one ofdisabledloadingreadystaleunavailablecatching-uprecovering▶
sourceMiningCursorrequiredThe processed chain point a statistics result was read from.
heightintegerrequiredblockIdstringrequiredparentIdstringrequiredtimestampinteger · int64requiredThe block's own timestamp in Unix milliseconds, not the time the client read it.
retainedFromHeightintegerrequiredFirst retained height. Nothing spent before it is listed or totalled.
retainedFromTimestampinteger · int64Timestamp of the first retained block, in milliseconds. Absent while nothing is retained.
offsetintegerrequiredThe offset this page starts at.
totalintegerrequiredEvery spent position in retained history. Pages end at
offset + limit >= total.▶
positionsLendingPosition[]requiredNewest first.
blockIdstringrequiredThe Lithos block that spent the box.
heightintegerrequiredtimestampinteger · int64requiredThe block's timestamp, in milliseconds.
collateralBoxIdstringrequiredlenderAddressstringrequiredThe wallet key the box named as its lender, which the block paid.
postedNanoErgstringrequiredThe box's whole value, principal and priority fee together.
priorityFeeNanoErgstringrequiredThe bid on top of the principal, which went to the miners.
coinbaseNanoErgstringrequiredThe block reward paid to the lender, less its re-emission tokens on mainnet.
feesNanoErgstringrequiredThe block's transaction fees, paid to the lender.
receivedNanoErgstringrequiredcoinbaseNanoErg + feesNanoErg.netNanoErgstringrequiredreceivedNanoErg - postedNanoErg, before the join's network fee.joinedHeightintegerThe block that included the queue box. Absent when the node's index does not show it.
▶
totalsLendingTotalsrequiredpositionsintegerrequiredpostedNanoErgstringrequiredpriorityFeesNanoErgstringrequiredcoinbaseNanoErgstringrequiredfeesNanoErgstringrequirednetNanoErgstringrequiredReceived less posted, over every retained position.
rewardLockBlocksintegerrequiredBlocks a coinbase or fee reward stays locked to the lender's key after its block.
400`limit` is outside 1–500 or `offset` is negative.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
403Missing or wrong `api_key`.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503History is loading, disabled, busy, or unreadable. Check `mining.status` in /stats before retrying.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description