Skip to content
parchmentdocs
Open app

House pool (LP)

LP equity and the FIFO claim queue

House pool (LP)

get/lp

Responses

  • LP cash, equity, fees, the retained-fee staker share curve (stakerShareBps, stakerShareMinBps/MaxBps, stakerCovLowBps/HighBps), and FIFO claims. There is no distPaused: Claims are never blocked by pool coverage; only an admin/guardian emergency pause can halt them.

    application/json

    • dataLprequired

      The LP pool and the head of the payout queue.

      • claimsClaim[]required

        The first queued claims in FIFO order, at most 200.

      • closesPausedboolean | null
      • equitystring | null

        lp_cash - total_owed, floored at 0.

        Pattern^-?(0|[1-9][0-9]*)n$
        Example1850000000000n
      • feeDevstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example800000n
      • feeGrowthstring | null

        Growth bucket from surplus sweeps (there is no insurance fund).

        Pattern^-?(0|[1-9][0-9]*)n$
        Example800000n
      • feeLpstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example800000n
      • feeStakerstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example800000n
      • headnull | Claim
      • lastSurplusMsstring | null

        Milliseconds.

        Pattern^-?(0|[1-9][0-9]*)n$
        Example1796677200000n
      • lockedMarginstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example100000000n
      • lpCashstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example1850000000000n
      • notestringrequired
      • oiMarketsstring | null

        Markets in the exchange's oi_set.

        Pattern^-?(0|[1-9][0-9]*)n$
        Example24n
      • pausedboolean | null
      • queueLengthstringrequired
        Pattern^-?(0|[1-9][0-9]*)n$
        Example24n
      • reservestring | null

        totalOwed + reserveUpnl + reserveStress.

        Pattern^-?(0|[1-9][0-9]*)n$
        Example1850000000000n
      • reserveEpochstring | null

        Bumped by out-of-band snapshot rewrites; an older ReserveCheck aborts ECheckStale.

        Pattern^-?(0|[1-9][0-9]*)n$
        Example912n
      • reserveStressstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example1850000000000n
      • reserveUpnlstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example1850000000000n
      • stakerCovHighBpsstring | null

        Basis points (1/10000).

        Pattern^-?(0|[1-9][0-9]*)n$
        Example12500n
      • stakerCovLowBpsstring | null

        Basis points (1/10000).

        Pattern^-?(0|[1-9][0-9]*)n$
        Example8000n
      • stakerShareBpsstring | null

        Stakers' share (bps) of the next retained fee at the current coverage.

        Pattern^-?(0|[1-9][0-9]*)n$
        Example2000n
      • stakerShareMaxBpsstring | null

        Basis points (1/10000).

        Pattern^-?(0|[1-9][0-9]*)n$
        Example2000n
      • stakerShareMinBpsstring | null

        The retained-fee curve: min at coverage <= low, linear to max at >= high.

        Pattern^-?(0|[1-9][0-9]*)n$
        Example2000n
      • sweepnull | SweepParams
      • tailProgressstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example1850000000000n
      • totalOwedstringrequired
        Pattern^-?(0|[1-9][0-9]*)n$
        Example1850000000000n
      • totalOwedSourcestringrequired

        Where total_owed comes from.

        One ofobjectenqueued_nets
      • trackedLpstring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example1850000000000n
      • userFreestring | null
        Pattern^-?(0|[1-9][0-9]*)n$
        Example100000000n

Example request

curl 'https://api.parchment.trade/lp'
const res = await fetch("https://api.parchment.trade/lp");
const { data } = await res.json();

Example response (200)

application/json
{
  "data": {
    "claims": [
      {
        "accountId": "0xad23e722f3542ae36c276c1b303e30ae77c840a84db89c7215fa87bf92006691",
        "claimId": "5531n",
        "enqueuedTx": "string",
        "feeRemaining": "800000n",
        "harvestedTx": "string",
        "net": "100000000n",
        "onTopRemaining": "800000n",
        "owner": "0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d",
        "positionId": "1042n",
        "remaining": "100000000n",
        "status": "queued",
        "timestampMs": "1796677200000n"
      }
    ],
    "closesPaused": true,
    "equity": "1850000000000n",
    "feeDev": "800000n",
    "feeGrowth": "800000n",
    "feeLp": "800000n",
    "feeStaker": "800000n",
    "head": {
      "accountId": "0xad23e722f3542ae36c276c1b303e30ae77c840a84db89c7215fa87bf92006691",
      "claimId": "5531n",
      "enqueuedTx": "string",
      "feeRemaining": "800000n",
      "harvestedTx": "string",
      "net": "100000000n",
      "onTopRemaining": "800000n",
      "owner": "0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d",
      "positionId": "1042n",
      "remaining": "100000000n",
      "status": "queued",
      "timestampMs": "1796677200000n"
    },
    "lastSurplusMs": "1796677200000n",
    "lockedMargin": "100000000n",
    "lpCash": "1850000000000n",
    "note": "string",
    "oiMarkets": "24n",
    "paused": true,
    "queueLength": "24n",
    "reserve": "1850000000000n",
    "reserveEpoch": "912n",
    "reserveStress": "1850000000000n",
    "reserveUpnl": "1850000000000n",
    "stakerCovHighBps": "12500n",
    "stakerCovLowBps": "8000n",
    "stakerShareBps": "2000n",
    "stakerShareMaxBps": "2000n",
    "stakerShareMinBps": "2000n",
    "sweep": {
      "capBps": "2000n",
      "cashFloor": "100000000n",
      "floorBps": "2000n",
      "growthBps": "2000n",
      "intervalMs": "3600000n",
      "maxBps": "2000n",
      "stakerBps": "2000n",
      "treasuryBps": "2000n"
    },
    "tailProgress": "1850000000000n",
    "totalOwed": "1850000000000n",
    "totalOwedSource": "object",
    "trackedLp": "1850000000000n",
    "userFree": "100000000n"
  }
}