OFFCHAIN-GEX

Remove liquidity from an off-chain pool by burning LP tokens

post/v2/offchain-gex/liquidity/remove

Request

  • Base URL: https://api.zee-verse.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.zee-verse.com/v2/offchain-gex/liquidity/remove
  • Auth: HTTP bearer

Request body

itemIdstring required

The unique identifier of the item pool to remove liquidity from

lpTokensstring required

Amount of LP tokens to burn (in wei). You will receive proportional VEE and items

minVeeAmountstring required

Minimum VEE amount to receive (in wei). Transaction fails if actual amount is less. Slippage protection

minItemAmountstring required

Minimum item amount to receive (in wei, whole number). Transaction fails if actual amount is less. Slippage protection

Example request

{
  "itemId": "100",
  "lpTokens": "44721359549995793928",
  "minVeeAmount": "90000000000000000000",
  "minItemAmount": "9000000000000000000"
}

Response

Liquidity removal outcome

veeAmountstring required

Amount of VEE returned to you (in wei)

itemAmountstring required

Amount of items returned to you (in wei, whole number)

lpTokensBurnedstring required

Amount of LP tokens burned from your balance (in wei)

newVeeReservestring required

New total VEE reserve in the pool after liquidity removal (in wei)

newItemReservestring required

New total item reserve in the pool after liquidity removal (in wei, whole number)

totalLpSupplystring required

Total supply of LP tokens remaining in the pool (in wei)

Example response

{
  "veeAmount": "100000000000000000000",
  "itemAmount": "5000000000000000000",
  "lpTokensBurned": "22360679774997896964",
  "newVeeReserve": "200000000000000000000",
  "newItemReserve": "10000000000000000000",
  "totalLpSupply": "44721359549995793928"
}

Changes

No recorded changes to this operation across all 1 revision of this API.