Position API

Get longs

Request

• method: POST

• url: /volare/longs

• query:

Name	Type	Description	Example
vToken	string	The vToken address.	0x801a33e856f44236ac44ed2dada8c0ada9738d67
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
isExpired	boolean	The option is expired when true, or is not expried when false.	true
isRedeemed	boolean	The option is redeemed or loss when true, or is profit when false.	true

Response

Data Type

Array<Long>

Example

[
  {
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "vTokenAddress": "0xc4129a3d3f495442f3e58e914352eebb84df68c2",
    "isPut": false,
    "expiry": 1656057600,
    "amount": "200000000",
    "strikePrice": "150000000000",
    "expiryPrice": "160000000000",
    "payout": "12500000",
    "roe": 62.5,
    "fee": "12500",
    "state": 1,
    "ctime": 1655289127,
    "mtime": 1655289127,
    "underlyingSymbol": "WETH"
  }
]

Get candidate longs

Request

• method: POST

• url: /volare/longs/candidate

• query:

Name	Type	Description	Example
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
productHash	string	The product hash.	0xd04e465a8843cd793e5374984bb70e1c05ca41bed2333c4c39f8dbaa62fe53b2
expiry	number	The expiry timestamp.	1648440000

Response

Data Type

Array<Long>

Example

[
  {
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "vTokenAddress": "0xc4129a3d3f495442f3e58e914352eebb84df68c2",
    "isPut": false,
    "expiry": 1656057600,
    "amount": "200000000",
    "strikePrice": "150000000000",
    "expiryPrice": "160000000000",
    "payout": "12500000",
    "roe": 62.5,
    "fee": "12500",
    "state": 1,
    "ctime": 1655289127,
    "mtime": 1655289127,
    "underlyingSymbol": "WETH"
  }
]

Get long filter

Request

• method: POST

• url: /volare/longs/filter

• query:

Name	Type	Description	Example
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
isExpired	boolean	The option is expired when true, or is not expried when false.	true

Response

Data Type

Name	Type	Description
products	Array<Product>	The products list.
expiry	Array<number>	The expiry list.
strikePrices	Array<string>	The strike prices list.

Example

{
  "products": [
    {
      "productSymbol": "WETH/USDC",
      "underlyingSymbol": "WETH"
    }
  ],
  "expiry": [
    1656057600
  ],
  "strikePrices": [
    "150000000000"
  ]
}

Get long PnLs

Request

• method: POST

• url: /volare/longs/findPnLByAddressAndVToken

• query:

Name	Type	Description	Example
vToken	string	The vToken address.	0x801a33e856f44236ac44ed2dada8c0ada9738d67
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
start	number	The start timestamp.	1658476800
end	number	The end timestamp.	1659081600

Response

Data Type

Array<LongPnL>

Example

[
  {
    "timestamp": 1655289127,
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "vTokenAddress": "0xc4129a3d3f495442f3e58e914352eebb84df68c2",
    "amount": "200000000",
    "expiryPrice": "160000000000",
    "payout": "12500000",
    "roe": 62.5
  }
]

Get shorts

Request

• method: POST

• url: /volare/shorts

• query:

Name	Type	Description	Example
vToken	string	The vToken address.	0x801a33e856f44236ac44ed2dada8c0ada9738d67
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
isExpired	boolean	The option is expired when true, or is not expried when false.	true
isSettled	boolean	The option is settled when true, or is not settled when false.	true

Response

Data Type

Array<Short>

Example

[
  {
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "vaultId": 1,
    "index": 0,
    "vTokenAddress": "0xc4129a3d3f495442f3e58e914352eebb84df68c2",
    "isPut": false,
    "expiry": 1656057600,
    "amount": "300000000",
    "strikePrice": "150000000000",
    "expiryPrice": "160000000000",
    "payout": "293750000",
    "roe": -62.5,
    "fee": "293750",
    "state": 1,
    "ctime": 1655289127,
    "mtime": 1655289127
  }
]

Get collaterals

Request

• method: POST

• url: /volare/collaterals

• query:

Name	Type	Description	Example
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
vaultId	number	The vault ID.	1

Response

Data Type

Array<Collateral>

Example

[
  {
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "vaultId": 1,
    "index": 0,
    "collateral": "0xf11c7e4ce4846c7cc0669105f8358612d0e1f593",
    "amount": "300000000",
    "ctime": 1655289127,
    "mtime": 1655289127
  }
]

Get vaults

Request

• method: POST

• url: /volare/vaults

• query:

Name	Type	Description	Example
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
isDetailed	boolean	Whether to include details.	false

Response

Data Type

Array<Vault>

Example

[
  {
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "vaultId": 1,
    "shortVTokens": ["0xc4129a3d3f495442f3e58e914352eebb84df68c2"],
    "shortAmounts": ["200000000"],
    "shortPayouts": ["100000000"],
    "longVTokens": ["0xb42eab5720f252d7feca51a48724509ff358610f"],
    "longAmounts": ["100000000"],
    "longPayouts": ["100000000"],
    "collateralAssets": ["0xa8241fdfac07beaa5cc7e8f32f8e9b7f0525017e"],
    "collateralAmounts": ["200000000"],
    "marginRequired": ["180000000"],
    "roe": 62.5,
    "fee": "12500",
    "state": 1,
    "underlyingAddress": "0xf11c7e4ce4846c7cc0669105f8358612d0e1f593",
    "isPut": true,
    "liquidatablePrice": 1600,
    "ctime": 1655289127,
    "mtime": 1655289127
  }
]

Get liquidatable vaults

Request

• method: POST

• url: /volare/vaults/findLiquidatable

• query:

Name	Type	Description	Example
underlying	string	The underlying address.	0xf11c7e4ce4846c7cc0669105f8358612d0e1f593
isPut	boolean	The Call or Put	false
isDetailed	boolean	Whether to include details.	false

Response

Data Type

Array<Vault>

Example

[
  {
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "vaultId": 1,
    "vaultType": ["0x01"],
    "shortVTokens": ["0xc4129a3d3f495442f3e58e914352eebb84df68c2"],
    "shortAmounts": ["200000000"],
    "shortPayouts": ["100000000"],
    "longVTokens": ["0xb42eab5720f252d7feca51a48724509ff358610f"],
    "longAmounts": ["100000000"],
    "longPayouts": ["100000000"],
    "collateralAssets": ["0xa8241fdfac07beaa5cc7e8f32f8e9b7f0525017e"],
    "collateralAmounts": ["200000000"],
    "marginRequired": ["180000000"],
    "roe": 62.5,
    "fee": "12500",
    "state": 1,
    "underlyingAddress": "0xf11c7e4ce4846c7cc0669105f8358612d0e1f593",
    "isPut": true,
    "liquidatablePrice": 1600,
    "ctime": 1655289127,
    "mtime": 1655289127
  }
]

Get vault

Request

• method: GET

• url: /volare/vaults/findByAddressAndVaultId

• query:

Name	Type	Description	Example
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
vaultId	number	The vault ID.	1

Response

Data Type

Vault

Example

{
  "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
  "vaultId": 1,
  "shortVTokens": ["0xc4129a3d3f495442f3e58e914352eebb84df68c2"],
  "shortAmounts": ["200000000"],
  "shortPayouts": ["100000000"],
  "longVTokens": ["0xb42eab5720f252d7feca51a48724509ff358610f"],
  "longAmounts": ["100000000"],
  "longPayouts": ["100000000"],
  "collateralAssets": ["0xa8241fdfac07beaa5cc7e8f32f8e9b7f0525017e"],
  "collateralAmounts": ["200000000"],
  "marginRequired": ["180000000"],
  "roe": 62.5,
  "fee": "12500",
  "state": 1,
  "underlyingAddress": "0xf11c7e4ce4846c7cc0669105f8358612d0e1f593",
  "isPut": true,
  "liquidatablePrice": 1600,
  "ctime": 1655289127,
  "mtime": 1655289127
}

Get vault PnLs

Request

• method: POST

• url: /volare/vaults/findPnLByAddressAndVaultId

• query:

Name	Type	Description	Example
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1
vaultId	number	The vault ID.	1
start	number	The start timestamp	1658476800
end	number	The end timestamp	1659081600
isDetailed	boolean	Whether to include details.	false

Response

Data Type

Array<VaultPnL>

Example

[
  {
    "timestamp": 1655289127,
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "vaultId": 1,
    "shortVTokens": ["0xc4129a3d3f495442f3e58e914352eebb84df68c2"],
    "shortAmounts": ["200000000"],
    "shortExpiryPrices": ["160000000000"],
    "longVTokens": ["0xb42eab5720f252d7feca51a48724509ff358610f"],
    "longAmounts": ["100000000"],
    "longExpiryPrices": ["160000000000"],
    "collateralAssets": ["0xa8241fdfac07beaa5cc7e8f32f8e9b7f0525017e"],
    "collateralAmounts": ["200000000"],
    "marginRequired": ["180000000"],
    "roe": 62.5
  }
]

Get volare logs

Request

• method: POST

• url: /volare/logs

• query:

Name	Type	Description	Example
contract	string	The vToken address.	0x801a33e856f44236ac44ed2dada8c0ada9738d67
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1

Response

Data Type

Array<Log>

Example

[
  {
    "timestamp": 1655369683,
    "blockNumber": 10733318,
    "transactionHash": "0x0ddacd1952837b0660c684c5c25022c869ba47f5ba4ae7d5187f99d228fa6a56",
    "logIndex": 6,
    "address": "0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1",
    "action": "LimitOrderFilled",
    "vTokenAddress": "0xc4129a3d3f495442f3e58e914352eebb84df68c2",
    "vTokenChange": "25000000"
  }
]