OFFCHAIN-GEX

Get quote for removing liquidity from a pool

post/v2/offchain-gex/liquidity/quote/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/quote/remove
  • Auth: HTTP bearer

Request body

itemIdstring required

The unique identifier of the item pool

lpTokensstring required

Amount of LP tokens you want to burn (in wei). Quote will show how much VEE and items you will receive

Example request

{
  "itemId": "100",
  "lpTokens": "44721359549995793928"
}

Response

Remove liquidity quote

lpTokensstring required

Amount of LP tokens you specified to burn (in wei)

veeToReceivestring required

Amount of VEE you will receive (in wei). Calculated from your LP token share

itemsToReceivestring required

Amount of items you will receive (in wei, whole number). Calculated from your LP token share

shareOfPoolnumber required

Percentage of the pool these LP tokens represent (0-100)

canAffordboolean required

Whether you have sufficient LP tokens to complete this removal

Example response

{
  "lpTokens": "22360679774997896964",
  "veeToReceive": "100000000000000000000",
  "itemsToReceive": "5000000000000000000",
  "shareOfPool": 50,
  "canAfford": true
}

Changes

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