OFFCHAIN-GEX

Add liquidity to an off-chain pool and receive LP tokens

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

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

maxVeeAmountstring required

Maximum amount of VEE willing to provide (in wei). Acts as slippage protection

Example request

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

Response

Liquidity addition outcome

veeAmountstring required

Actual amount of VEE added to the pool (in wei)

itemAmountstring required

Amount of items added to the pool (in wei, whole number)

lpTokensstring required

Amount of LP tokens minted and given to you (in wei). Represents your share of the pool

newVeeReservestring required

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

newItemReservestring required

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

totalLpSupplystring required

Total supply of LP tokens in the pool after your addition (in wei)

shareOfPoolnumber required

Your percentage ownership of the pool (0-100). Higher means you own more of the pool

Example response

{
  "veeAmount": "200000000000000000000",
  "itemAmount": "10000000000000000000",
  "lpTokens": "44721359549995793928",
  "newVeeReserve": "300000000000000000000",
  "newItemReserve": "15000000000000000000",
  "totalLpSupply": "67082039324993690892",
  "shareOfPool": 66.67
}

Changes

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