List liquidity provisions

get/dex/provisions

Every provision held by this wallet, including those whose ownerNFT sits in one of its redeem orders. accrued* is what it has earned, claimable* is what can be paid now, and unflushed* is the difference a flush would release.

Responses

200Provisions held by this walletLDProvisionList▶

▶
provisionsLDProvision[]required
- boxIdstringrequired
  Provision box id. Changes on every claim and resize.
- ownerNFTstringrequired
  Token that owns this provision. Unchanged by claims and resizes.
- sharesstringrequired
  LP shares this provision represents. Decimal string.
- entryXstringrequired
  Accumulator this provision last settled at. Decimal string.
- entryYstringrequired
  Token side of the same. Decimal string.
- valuestringrequired
  nanoERG held by the provision box. Decimal string.
- createdHeightinteger · int32required
- shareOfSupplynumber · doublerequired
- accruedXstringrequired
  ERG earned according to the pool, including fees not yet flushed. This is the figure to show a provider as "earned". Decimal string.
- accruedYstringrequired
  Token side of the same. Decimal string.
- claimableXstringrequired
  ERG that can be paid out now. Never negative. Decimal string.
- claimableYstringrequired
  Token side of the same. Decimal string.
- unflushedXstringrequired
  accruedX less claimableX — what a flush would release. Decimal string.
- unflushedYstringrequired
  Token side of the same. Decimal string.
- canClaimbooleanrequired
  Whether a claim would be accepted right now.
- awaitingFlushbooleanrequired
  True when nothing can be claimed until the next flush. Normal after a deposit or resize; not an error.
- redeemOrderBoxIdstring
  Present when an outstanding redeem order holds this provision's ownerNFT. The provision cannot be claimed, resized or redeemed directly until that order fills or is cancelled.

503Node or wallet unavailable. Never returns a partial list.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

← PreviousRedeem liquidity Next →Claim settled fees for a provision

{ "provisions": [ { "boxId": "ce00d6e0f4fd3390c0519bb0d24824e1e6b06978163f4845a7cf2c1c7d8f1b65", "ownerNFT": "a1f4c2e8b7d93052416fbc8e07d21935a8c4f60b2e91d7385c06a4b1f2e83d97", "shares": "12500000000", "entryX": "18400000000000000000000000", "entryY": "552000000000000000000000", "value": "600000000", "createdHeight": 1284400, "shareOfSupply": 0.0125, "accruedX": "292750000", "accruedY": "8900000", "claimableX": "253000000", "claimableY": "7690000", "unflushedX": "39750000", "unflushedY": "1210000", "canClaim": true, "awaitingFlush": false, "redeemOrderBoxId": "9b41d2f07ce83a5164e2d09fb7a3c1586e04d9b2f71ac8356e0b4d1c7f29a3e5" } ] }