SERVICES

Create a new pool

post/v2/services/offchain-gex/pools

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/pools
  • Auth: API key in header ServiceToken

Request body

token0string required

First token in the trading pair. Usually the VEE currency

token1string required

Second token in the trading pair. The item being traded (boots, armor, etc.)

reserve0string required

Reserve of token0 in the pool (in wei). Available liquidity for trading

reserve1string required

Reserve of token1 in the pool (in wei, whole number for items). Available liquidity for trading

protocolFeestring required

Protocol fee percentage (0-1). This fee is burned/destroyed on each trade. Example: 0.01 = 1%

liquidityProviderFeestring required

Liquidity provider fee percentage (0-1). This fee stays in the pool as rewards for LPs. Example: 0.01 = 1%

enabledboolean required

Whether or not the pool is enabled

Example request

{
  "token0": "1",
  "token1": "100",
  "reserve0": "100000000000000000000",
  "reserve1": "5000000000000000000",
  "protocolFee": "0.01",
  "liquidityProviderFee": "0.01",
  "enabled": true
}

Response

idstring required

Unique identifier of the pool

token0string required

First token in the trading pair. Usually the VEE currency

token1string required

Second token in the trading pair. The item being traded (boots, armor, etc.)

reserve0string required

Reserve of token0 in the pool (in wei). Available liquidity for trading

reserve1string required

Reserve of token1 in the pool (in wei, whole number for items). Available liquidity for trading

protocolFeenumber required

Protocol fee percentage (0-1). This fee is burned/destroyed on each trade. Example: 0.01 = 1%

liquidityProviderFeenumber required

Liquidity provider fee percentage (0-1). This fee stays in the pool as rewards for LPs. Example: 0.01 = 1%

totalLpSupplystring required

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

enabledboolean required

Whether or not the pool is enabled

Example response

{
  "id": "d42d3bbd-f5aa-4383-87c0-bc8924148722",
  "token0": "1",
  "token1": "100",
  "reserve0": "100000000000000000000",
  "reserve1": "5000000000000000000",
  "protocolFee": 0.01,
  "liquidityProviderFee": 0.01,
  "totalLpSupply": "22360679774997896964",
  "enabled": true,
  "trades": {
    "total": 100,
    "last24h": 10,
    "prev24h": 10,
    "totalProtocolFee": "10",
    "totalLpFee": "10"
  },
  "liquidityPositions": {
    "total": 100,
    "last24h": 10,
    "prev24h": 10
  }
}

Changes

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