SERVICES

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

post/v2/services/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/services/offchain-gex/liquidity/remove
Auth: API key in header ServiceToken

Request body

itemIdstring required

The unique identifier of the item to provide liquidity for

itemAmountstring required

Amount of items to add to the pool (in wei, must be whole number). Example: "10000000000000000000" for 10 items

veeAmountstring required

Amount of VEE to add to the pool (in wei, must be whole number). Example: "200000000000000000000" for 20 VEE

Example request

{
  "itemId": "100",
  "itemAmount": "10000000000000000000",
  "veeAmount": "200000000000000000000"
}

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.