🍑APIs

APIs for query products, options, and positions.

List Products

Get all whitelist products.

POSThttps://fuji.api.volare.lol/eth/volare/whitelists/{contract}/products

Path parameters

contract*string

The whitelist contract.

Query parameters

Body

The Filter condition.

whereobject

An object containing a JavaScript expression or a full JavaScript function passed to the query system.

skipnumber

The number of items to skip before starting to collect the result set.

limitnumber

The number of items to return.

sortobject

Sorts all input documents and returns them to the pipeline in sorted order.

Response

The whitelist products array.

Body

productHash*string

The product hash.

symbol*string

The product symbol.

underlyingall of

The underlying detail.

strikeall of

The strike detail.

collateralall of

The collateral detail.

isPut*boolean

The product is put when true, or the product is call when false.

underlyingPriceall of

The underlying price.

Request

const response = await fetch('https://fuji.api.volare.lol/eth/volare/whitelists/{contract}/products', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "productHash": "0x570077717657ea87b5d2c15ccbab1a112777e8f99664e036fd561c246c80fad4",
    "symbol": "WETH/DAI",
    "underlying": {
      "address": "0x95478c4f7d22d1048f46100001c2c69d2ba57380",
      "name": "MyToken",
      "symbol": "HIX",
      "logo": "https://www.mtpelerin.com/images/rate-calculator/flag-btc.svg",
      "decimals": 18,
      "totalSupply": "1000000000000000000000000000"
    },
    "strike": {
      "address": "0x95478c4f7d22d1048f46100001c2c69d2ba57380",
      "name": "MyToken",
      "symbol": "HIX",
      "logo": "https://www.mtpelerin.com/images/rate-calculator/flag-btc.svg",
      "decimals": 18,
      "totalSupply": "1000000000000000000000000000"
    },
    "collateral": {
      "address": "0x95478c4f7d22d1048f46100001c2c69d2ba57380",
      "name": "MyToken",
      "symbol": "HIX",
      "logo": "https://www.mtpelerin.com/images/rate-calculator/flag-btc.svg",
      "decimals": 18,
      "totalSupply": "1000000000000000000000000000"
    },
    "isPut": false,
    "underlyingPrice": {
      "timestamp": 1649730130,
      "name": "BTCUSDC",
      "price": "39413.11000000",
      "changed": -6.15,
      "source": "binance"
    }
  }
]

const products = await apis.products();

List VTokens

Get all vTokens by product hash and expiry timestamp.

POSThttps://fuji.api.volare.lol/eth/volare/products/{hash}/vTokens

Path parameters

hash*string

The product hash.

Query parameters

Body

The Filter condition.

whereobject

An object containing a JavaScript expression or a full JavaScript function passed to the query system.

skipnumber

The number of items to skip before starting to collect the result set.

limitnumber

The number of items to return.

sortobject

Sorts all input documents and returns them to the pipeline in sorted order.

Response

The vTokens array.

Body

name*string

The vToken name.

symbol*string

The vToken symbol.

tokenAddress*string

The vToken address.

creator*string

The vToken creator address.

underlying*string

The underlying address.

strike*string

The strike address.

collateral*string

The collateral address.

strikePrice*string

The vToken strike price.

expiry*number

The timestamp at which this vToken will expiry.

decimals*number

The vToken decimals.

isPut*boolean

The vToken is put when true, or the vToken is call when false.

greekall of

The vToken's greek index.

marketall of

The vToken's market data.

positionall of

The vToken's position.

statall of

The vToken's stat.

Request

const response = await fetch('https://fuji.api.volare.lol/eth/volare/products/{hash}/vTokens', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "name": "WETHDAI 17-April-2022 3300 Call WETH Collateral",
    "symbol": "vWETHDAI/WETH-17APR22-3300C",
    "tokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
    "creator": "0xa8241fdfac07beaa5cc7e8f32f8e9b7f0525017e",
    "underlying": "0xc778417e063141139fce010982780140aa0cd5ab",
    "strike": "0xad6d458402f60fd3bd25163575031acdce07538d",
    "collateral": "0xc778417e063141139fce010982780140aa0cd5ab",
    "strikePrice": "3300000000000000000000",
    "expiry": 1650182400,
    "decimals": 8,
    "isPut": false,
    "greek": {
      "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
      "timestamp": 1649508130,
      "delta": 0.6,
      "gamma": 0.05,
      "theta": 0.1,
      "vega": 0.2,
      "rho": 0.1
    },
    "market": {
      "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
      "timestamp": 1649508130,
      "changed": 13.1,
      "volume": "1400000000",
      "bid1": "102000000000000000000",
      "bid1IV": 1.7552,
      "ask1": "98000000000000000000",
      "ask1IV": 0.9932
    },
    "position": {
      "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
      "timestamp": 1649508130,
      "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
      "amount": "3600000000"
    },
    "stat": {
      "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
      "timestamp": 1649508130,
      "totalSupply": "1000000000000000000000000000",
      "holder": 100
    }
  }
]

First, you will need to fetch the expiry list for a particular product. The only parameter is the product hash. The product differentiates call and put using an isPut attribute.

const expiries = await apis.expiry("0x...");

Then you can fetch vTokens for specific expiry under certain products.

const vTokens = await apis.vTokens(
  "0x....", // Product Hash
  1655105845, // Expiry
  address, // Addresses Object
  false, // With Statistics
  true, // With Market
  true, // With Greek Figures
);

List Ask/Bid Orders

Get all orders book by vToken address.

POSThttps://fuji.api.volare.lol/eth/volare/vTokens/{contract}/orders/book

Path parameters

contract*string

The vToken address.

Query parameters

Body

The Filter condition.

whereobject

An object containing a JavaScript expression or a full JavaScript function passed to the query system.

skipnumber

The number of items to skip before starting to collect the result set.

limitnumber

The number of items to return.

sortobject

Sorts all input documents and returns them to the pipeline in sorted order.

Response

The orders book array.

Body

orderHash*string

The order hash.

price*string

The price of an option.

size*string

The number of unfilled options.

Request

const response = await fetch('https://fuji.api.volare.lol/eth/volare/vTokens/{contract}/orders/book', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "orderHash": "0xd3a7c1045fecfba34ba51c47d7eb0c555ec24aba5a3cba7746e178f8cbeca32a",
    "price": "10000000000000000000",
    "size": "200000000"
  }
]

Queries the ask or bid orders in the order book.

const orders = await apis.orderBook(
  "0x....", // VToken Address
  Side.Ask // Enum imported from the library, Ask or Bid
);

List Long Positions

Get all long positions.

POSThttps://fuji.api.volare.lol/eth/volare/vTokens/longs

Query parameters

Body

The Filter condition.

whereobject

An object containing a JavaScript expression or a full JavaScript function passed to the query system.

skipnumber

The number of items to skip before starting to collect the result set.

limitnumber

The number of items to return.

sortobject

Sorts all input documents and returns them to the pipeline in sorted order.

Response

The long positions array.

Body

timestamp*number

The timestamp at which the event is emitted.

address*string

The owner address.

vTokenAddress*string

The vToken address.

vTokenall of

The vToken detail.

vaultId*string

The vault ID.

balance*string

The number of options held by the owner.

burnedSize*string

The number of options delivered.

expiry*number

The timestamp when this vToken expiried.

strikePrice*string

The vToken strike price.

fixingPricestring

The fixing price at which this option exercised.

exerciseProfitstring

The profit at which this option exercised.

exerciseFeestring

The exercise fee at which the profit is withdrawn.

roenumber

Return on equity (n per thousand).

cashAmount*string

The cash's amount.

state*number

The long position state.

redeemedTimestamp*number

The redeemed timestamp.

Request

const response = await fetch('https://fuji.api.volare.lol/eth/volare/vTokens/longs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "timestamp": 1649680926,
    "address": "0x5322d18080c18ed152c03c13f09817bb0b51a486",
    "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
    "vToken": {
      "timestamp": 1649507130,
      "blockNumber": 12178407,
      "productHash": "0x570077717657ea87b5d2c15ccbab1a112777e8f99664e036fd561c246c80fad4",
      "name": "WETHDAI 17-April-2022 3300 Call WETH Collateral",
      "symbol": "vWETHDAI/WETH-17APR22-3300C",
      "tokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
      "creator": "0xa8241fdfac07beaa5cc7e8f32f8e9b7f0525017e",
      "underlying": "0xc778417e063141139fce010982780140aa0cd5ab",
      "strike": "0xad6d458402f60fd3bd25163575031acdce07538d",
      "collateral": "0xc778417e063141139fce010982780140aa0cd5ab",
      "strikePrice": "3300000000000000000000",
      "expiry": 1650182400,
      "decimals": 8,
      "isPut": false,
      "isWhitelisted": true,
      "greek": {
        "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
        "timestamp": 1649508130,
        "delta": 0.6,
        "gamma": 0.05,
        "theta": 0.1,
        "vega": 0.2,
        "rho": 0.1
      },
      "market": {
        "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
        "timestamp": 1649508130,
        "changed": 13.1,
        "volume": "1400000000",
        "bid1": "102000000000000000000",
        "bid1IV": 1.7552,
        "ask1": "98000000000000000000",
        "ask1IV": 0.9932
      },
      "position": {
        "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
        "timestamp": 1649508130,
        "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
        "amount": "3600000000"
      },
      "stat": {
        "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
        "timestamp": 1649508130,
        "totalSupply": "1000000000000000000000000000",
        "holder": 100
      }
    },
    "vaultId": "1",
    "balance": "200000000",
    "burnedSize": "100000000",
    "expiry": 1650182400,
    "strikePrice": "330000000000",
    "fixingPrice": "350000000000",
    "exerciseProfit": "11428571",
    "exerciseFee": "114285",
    "roe": 57.1,
    "cashAmount": "20000000000000000000",
    "state": 1,
    "redeemedTimestamp": 1650268800
  }
]

Queries all long positions in a specific wallet address. Filtered with expired, redeemed.

const params = new URLSearchParams({
  address: wallet.address,
  isExpired: expired.toString(),
  withVToken: withVToken.toString(),
  isRedeemed: "false",
});
const data = await fetch(
  `${API_ENDPOINT}/eth/volare/vTokens/longs?${params}`,
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
    },
  }
);

List Short Positions

Get all short positions.

POSThttps://fuji.api.volare.lol/eth/volare/vTokens/shorts

Query parameters

Body

The Filter condition.

whereobject

An object containing a JavaScript expression or a full JavaScript function passed to the query system.

skipnumber

The number of items to skip before starting to collect the result set.

limitnumber

The number of items to return.

sortobject

Sorts all input documents and returns them to the pipeline in sorted order.

Response

The short positions array.

Body

timestamp*number

The timestamp at which the event is emitted.

address*string

The owner address.

vTokenAddress*string

The vToken address.

vTokenall of

The vToken detail.

vaultId*string

The vault ID.

amount*string

The amount of options minted by the owner.

balance*string

The number of options held by the owner.

sold*string

The number of options sold.

expiry*number

The timestamp when this vToken expiried.

strikePrice*string

The vToken strike price.

fixingPricestring

The fixing price at which this option exercised.

exerciseProfitstring

The profit at which this option exercised.

exerciseFeestring

The exercise fee at which the remaining collateral is withdrawn.

roenumber

Return on equity (n per thousand).

collateralAddress*string

The collateral's address.

collateralAmount*string

The collateral's amount.

collateralRate*number

The collateral's rate (n per thousand).

state*number

The short position state.

settledTimestamp*number

The settled timestamp.

Request

const response = await fetch('https://fuji.api.volare.lol/eth/volare/vTokens/shorts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "timestamp": 1649680926,
    "address": "0x5322d18080c18ed152c03c13f09817bb0b51a486",
    "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
    "vToken": {
      "timestamp": 1649507130,
      "blockNumber": 12178407,
      "productHash": "0x570077717657ea87b5d2c15ccbab1a112777e8f99664e036fd561c246c80fad4",
      "name": "WETHDAI 17-April-2022 3300 Call WETH Collateral",
      "symbol": "vWETHDAI/WETH-17APR22-3300C",
      "tokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
      "creator": "0xa8241fdfac07beaa5cc7e8f32f8e9b7f0525017e",
      "underlying": "0xc778417e063141139fce010982780140aa0cd5ab",
      "strike": "0xad6d458402f60fd3bd25163575031acdce07538d",
      "collateral": "0xc778417e063141139fce010982780140aa0cd5ab",
      "strikePrice": "3300000000000000000000",
      "expiry": 1650182400,
      "decimals": 8,
      "isPut": false,
      "isWhitelisted": true,
      "greek": {
        "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
        "timestamp": 1649508130,
        "delta": 0.6,
        "gamma": 0.05,
        "theta": 0.1,
        "vega": 0.2,
        "rho": 0.1
      },
      "market": {
        "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
        "timestamp": 1649508130,
        "changed": 13.1,
        "volume": "1400000000",
        "bid1": "102000000000000000000",
        "bid1IV": 1.7552,
        "ask1": "98000000000000000000",
        "ask1IV": 0.9932
      },
      "position": {
        "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
        "timestamp": 1649508130,
        "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
        "amount": "3600000000"
      },
      "stat": {
        "vTokenAddress": "0x801a33e856f44236ac44ed2dada8c0ada9738d67",
        "timestamp": 1649508130,
        "totalSupply": "1000000000000000000000000000",
        "holder": 100
      }
    },
    "vaultId": "1",
    "amount": "300000000",
    "balance": "200000000",
    "sold": "100000000",
    "expiry": 1650182400,
    "strikePrice": "330000000000",
    "fixingPrice": "350000000000",
    "exerciseProfit": "-5714285",
    "exerciseFee": "2942857",
    "roe": -57.1,
    "collateralAddress": "0xc778417e063141139fce010982780140aa0cd5ab",
    "collateralAmount": "3000000000000000000",
    "collateralRate": 1000,
    "state": 1,
    "settledTimestamp": 1650268800
  }
]

Queries all short positions in a specific wallet address. Filtered with expired, settled.

const params = new URLSearchParams({
  address: wallet.address,
  isExpired: expired.toString(),
  withVToken: withVToken.toString(),
  isSettled: "false",
});
const data = await fetch(
  `${API_ENDPOINT}/eth/volare/vTokens/shorts?${params}`,
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
    },
  }
)

PreviousQuick Start NextOption

Last updated 1 year ago