OFFCHAIN-GEX

Get quote for adding liquidity to a pool

post/v2/offchain-gex/liquidity/quote/add

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/add
  • Auth: HTTP bearer

Request body

itemIdstring required

The unique identifier of the item to check liquidity quote for

itemAmountstring required

Amount of items you want to add (in wei, must be whole number). Quote will calculate required VEE

Example request

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

Response

Add liquidity quote

itemAmountstring required

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

requiredVeeAmountstring required

Amount of VEE required to maintain pool ratio (in wei). This is calculated based on current pool reserves

lpTokensToReceivestring required

Amount of LP tokens you will receive (in wei). Represents your share of the pool

shareOfPoolnumber required

Your percentage of total pool ownership after adding liquidity (0-100)

canAffordboolean required

Whether you have sufficient VEE and items in your balance to complete this transaction

Example response

{
  "itemAmount": "10000000000000000000",
  "requiredVeeAmount": "200000000000000000000",
  "lpTokensToReceive": "44721359549995793928",
  "shareOfPool": 33.33,
  "canAfford": true
}

Changes

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