Links

Entities

  • [`Token`](entities.md#token)
  • [`TokenPair`](entities.md#tokenpair)
  • [`TokenData`](entities.md#tokendata)
  • [`Pool`](entities.md#pool)
  • [`UserOwnedPool`](entities.md#userownedpool)
  • [`Option`](entities.md#option)
  • [`UserOwnedOption`](entities.md#userownedoption)
  • [`UserOwnedUnderwrittenOption`](entities.md#userownedunderwrittenoption)
  • [`UserProfitLoss`](entities.md#userprofitloss)
  • [`Transaction`](entities.md#transaction)
  • [`CLevelChartItem`](entities.md#clevelchartitem)
  • [`ProfitLossHistoryItem`](entities.md#profitlosshistoryitem)
  • [`EntityHistory`](entities.md#entityhistory)
  • [`BlockHistory`](entities.md#blockhistory)
  • [`TotalTVL`](entities.md#totaltvl)
  • [`TotalVolume`](entities.md#totalvolume)
  • [`TotalTVLBiHourly`](entities.md#totaltvlbihourly)
  • [`TotalTVLDaily`](entities.md#totaltvldaily)
  • [`TotalVolumeDaily`](entities.md#totalvolumedaily)
  • [`TVLBiHourly`](entities.md#tvlbihourly)
  • [`TVLDaily`](entities.md#tvldaily)
  • [`VolumeDaily`](entities.md#volumedaily)
  • [`OptionPriceBiHourly`](entities.md#optionpricebihourly)
  • [`OptionPriceDaily`](entities.md#optionpricedaily)
  • [`TokenPriceBiHourly`](entities.md#tokenpricebihourly)
  • [`TokenPriceDaily`](entities.md#tokenpricedaily)
  • [`Notification`](entities.md#notification)

Token

Description: get information about tokens
Field
Type
Description
id
ID!
Smart contract address of the token
name
String!
name of token
symbol
String!
symbol of token
decimals
Int!
The number of decimal places this token uses, default to 18
address
String!
address of token
priceOracle
String!
token price generated by oracle
priceInUsd
BigInt!
price of token in USD
chainId
Int!
chain ID of token

TokenPair

Description: get information about token pair
Field
Type
Description
id
ID!
Smart contract address of the LP Pair
name
String!
Name of the token
base
Token!
token user uses to enter
underlying
Token!
underlying token of pool (call in token, puts in dai)

TokenData

Description: get token data
Field
Type
Description
id
ID!
Smart contract address of the token
token
Token!
Reference to the actual token
name
String!
Name of the token
searchableSymbol
String!
Symbol of token
priceInUsd
BigInt!
Price of token in USD
pools
Pool!
relation to pool entity
options
Option!
relation to option entity
totalPremiumEarned
BigInt!
total premium earned
totalPremiumsEarnedInUsd
BigInt!
total premiums earned in USD
totalFeesEarned
BigInt!
total fees earned
totalExerciseLoss
BigInt!
total options exercised with loss
totalExercised
BigInt!
total exercised options
totalSellLoss
BigInt!
total sell loss
totalSold
BigInt!
total sold
totalClosed
BigInt!
total closed
totalCloseLoss
BigInt!
total closed with loss
totalPoolAvailable
BigInt!
total pool available
totalPoolLocked
BigInt!
total pool locked
totalPoolSize
BigInt!
total pool size
totalPoolSizeInUsd
BigInt!
total pool size in USD
totalDeposited
BigInt!
total tokens deposited
totalWithdrawn
BigInt!
total tokens withdrawn
totalOppositePoolLocked
BigInt!
total oppposite put/call pool locked
totalVolume
BigInt!
total volume of options
totalVolumeInUsd
BigInt!
total value in USD of options
openInterest
BigInt!
open option of token
openInterestInUsd
BigInt!
open options in USD of token
totalCallVolume
BigInt!
total call volume of token
totalPutVolume
BigInt!
total put volume of token
volumePutCallRatio
BigInt!
volume put/call ratio of token
activePutCallRatio
BigInt!
active put/call ratio of token

Pool

Description: get information about pools
Field
Type
Description
id
ID!
name
String!
name of the pool
searchableName
String!
search by token name
address
String!
address of tokens
chainId
Int!
chain ID of token
pairName
String!
pool pair name
pair
TokenPair!
tokens in pair
base
Token!
token paid out in
underlying
Token!
underlying token of pool (call in token, puts in dai)
optionType
OptionType!
buy or put option
cLevel64x64
BigInt!
fixed decimal representation of the volatility for a specific option
cLevel
BigInt!
c-level of pool
minTokenAmount
BigInt!
minimum token amount to put in pool
startTimestamp
BigInt!
start time stamp of pool
startBlock
BigInt!
start block of pool
totalDeposited
BigInt!
total deposited into pool
totalWithdrawn
BigInt!
total withdrawn in pool
netDeposited
BigInt!
net deposited into pool
totalLocked
BigInt!
total value locked in pool
totalAvailable
BigInt!
total options available in pool
netSize
BigInt!
net size of pool in token
netSizeInUsd
BigInt!
net size of pool in USD
utilizationRate
BigInt!
amount of pool utilized
averageReturn
BigInt!
average return of pool
profitLossPercentage
BigInt!
profit/loss percentage of pool
annualPercentageReturn
BigInt!
APY return in pool
claimedLiquidityRewards
BigInt!
claimed liquidity rewards of pool
totalVolume
BigInt!
total volume in pool
totalVolumeInUsd
BigInt!
total volume in pool in USD
totalExerciseLoss
BigInt!
total options in pool exercised with loss
totalExercised
BigInt!
total options in pool exercised
totalSellLoss
BigInt!
total options in pool sold with loss
totalSold
BigInt!
total sold options in pool
totalClosed
BigInt!
total options closed in pool
totalCloseLoss
BigInt!
total loss on closed options in pool
totalCharged
BigInt!
total charged in pool
totalPremiumsEarned
BigInt!
total premiums earned in token in pool
totalPremiumsEarnedInUsd
BigInt!
total premiums earned in pool in USD
totalFeesEarned
BigInt!
total fees earned in pool
openInterest
BigInt!
open options in pool
openInterestInUsd
BigInt!
open options in pool in USD
averageStrike
BigInt!
average strike price of options in pool
averageMaturity
BigInt!
average maturity of options in pool

UserOwnedPool

Description: get information about user owned pools
Field
Type
Description
id
ID!
user
String!
wallet address of user
address
String!
address of tokens
poolName
String!
name of pool
pool
Pool!
The pool involving this transaction
pairName
String!
pool pair name
pair
TokenPair!
tokens in pair
base
Token!
token paid out in
underlying
Token!
underlying token of pool (call in token, puts in dai)
optionType
OptionType!
put or call
size
BigInt!
size of pool
startTimestamp
BigInt!
time user entered
startBlock
BigInt!
start block user entered
lastDepositSize
BigInt!
last pool deposit size
lastDepositTimestamp
BigInt!
last pool deposit timestamp
lastWithdrawalSize
BigInt
last pool withdrawal size
lastWithdrawalTimestamp
BigInt
last pool withdrawal timestamp
totalDeposited
BigInt!
total deposited in pool
totalWithdrawn
BigInt!
amount withdrawn from pool
netDeposited
BigInt!
net deposited amount of tokens
totalLocked
BigInt!
total amount unlocked
totalAvailable
BigInt!
total toke available in pool
netSize
BigInt!
net size of pool
utilizationRate
BigInt!
how much of available pool is used
averageReturn
BigInt!
average return for pool
profitLossPercentage
BigInt!
profit/loss percentage
annualPercentageReturn
BigInt!
APY return for pool
claimedLiquidityRewards
BigInt!
claimed liquidity rewards
totalVolume
BigInt!
total option volume
totalAssigned
BigInt!
total options assigned
totalExerciseLoss
BigInt!
total loss on exercised options
totalSellLoss
BigInt!
total loss on sold options
totalCloseLoss
BigInt!
total loss on closed options
totalPremiumsEarned
BigInt!
total premiums earned
totalReassignmentFees
BigInt!
total fees for reassignments
openInterest
BigInt!
total options open

Option

Description: get information about options
Field
Type
Description
id
ID!
poolName
String!
name of pool
searchablePoolName
String!
search by token name
pool
Pool!
The pool involving this transaction
pairName
String!
pool pair name
pair
TokenPair!
tokens in pair
base
Token!
token paid out in
underlying
Token!
underlying token of pool (call in token, puts in dai)
optionType
OptionType!
put or call
optionTypeString
String!
put or call
strike64x64
BigInt!
maximum strike price
strike
BigInt!
exercised prioe in token
strikeInUsd
BigInt!
exercised price in USD
maturity
BigInt!
maturity date of option
longTokenId
BigInt!
unique id of token
lastTradePrice
BigInt!
last trade price
lastTradeFee
BigInt!
last trade fee
lastTradeSize
BigInt!
last option trade size
lastTradeTimestamp
BigInt!
timestamp of last trade
totalVolume
BigInt!
total option volume
totalExerciseReturn
BigInt!
total return on exercised options
totalExercised
BigInt!
total token on exercised options
totalSellReturn
BigInt!
total return on sold options
totalSold
BigInt!
total options sold
totalClosed
BigInt!
total closed options
totalCloseReturn
BigInt!
total closed return
totalCharged
BigInt!
total charged
totalPremiumsEarned
BigInt!
total premiums earned
totalFeesEarned
BigInt!
total fees earned
totalHolders
Int!
total number of option holders
averageReturn
BigInt!
average return of option
profitLossPercentage
BigInt!
profit/loss percentage of option
openInterest
BigInt!
amount of options open in token
openInterestInUsd
BigInt!
amount of options open in USD
price
BigInt!
price of option in token
priceInUsd
BigInt!
price of option in USD
price24HrsAgo
BigInt!
value of option 24 hrs prior
priceInUsd24HrsAgo
BigInt!
USD value of option 24 hrs prior
exerciseValue
BigInt!
exercised option value
exerciseValueInUsd
BigInt!
exercised option value in USD

UserOwnedOption

Description: get information about user owned options
Field
Type
Description
id
ID!
user
String!
wallet address of user
option
Option!
buy or put option
size
BigInt!
option size
maturity
BigInt!
expiration date of option
lastTradePrice
BigInt!
price of last trade
lastTradeFee
BigInt!
fee of last trade
lastTradeSize
BigInt!
size of last trade
lastTradeTimestamp
BigInt!
timestamp of last trade
totalExerciseReturn
BigInt!
total return of exercised options
totalExercised
BigInt!
total amount of options exercised
totalSellReturn
BigInt!
return of options sold
totalSold
BigInt!
toal options sold
totalCloseReturn
BigInt!
total closed option returns
totalClosed
BigInt!
total options closed
totalSpent
BigInt!
total token spent
totalSpentUSD
BigInt!
amount of USD spent
totalFeesPaid
BigInt!
total fees paid by user
averageReturn
BigInt!
average user return
profitLossPercentage
BigInt!
user profit/loss percentage

UserOwnedUnderwrittenOption

Description: get information about user owned underwritten option
Field
Type
Description
id
ID!
user
String!
wallet address of user
option
Option!
buy or put option
size
BigInt!
option size
tokenId
BigInt!
unique id of token
tokenType
Int!
token put or call
burnType
UnderwrittenBurnType!
burn type
lastTradePrice
BigInt!
last option price
lastTradeFee
BigInt!
fee of last option trade
lastTradeSize
BigInt!
last trade size
lastTradeTimestamp
BigInt!
last trade timestamp
totalExerciseLoss
BigInt!
total exercised option loss
totalExercised
BigInt!
total options exercised
totalSellLoss
BigInt!
total sold loss
totalSold
BigInt!
total options sold
totalCloseLoss
BigInt!
total loss on closed options
totalClosed
BigInt!
total options closed
totalPremiums
BigInt!
total premium paid
totalPremiumsUSD
BigInt!
total premium paid in USE
totalFeesPaid
BigInt!
total fees paid
averageReturn
BigInt!
average return of options
profitLossPercentage
BigInt!
profit/loss percentage
purchaseDate
BigInt!
purchase date of option

UserProfitLoss

Description: get user information about profits or loss
Field
Type
Description
id
ID!
user
String!